Léim go dtí an príomhábhar

Forbróirí

Doiciméadú REST API

API JSON-thar-HTTPS d’IS dlí Attorly. Ritheann sé na hoibríochtaí céanna leis an bhfreastalaí MCP, leis na heochracha, na raonta, na teorainneacha agus an bhilleáil chéanna.

Mearthosú

Uaslódáil conradh agus déan anailís air i gceithre chéim.

  1. 1. Cruthaigh eochair

    Cruthaigh eochair in Socruithe › Forbróirí agus roghnaigh REST API. Oibríonn an eochair chéanna don fhreastalaí MCP. Coinnigh í in athróg timpeallachta:

    bash
    export ATTORLY_API_KEY=lbmcp_your_api_key
  2. 2. Uaslódáil doiciméad

    Seol an comhad mar multipart/form-data. Is é data.id an fhreagra aitheantas an doiciméid. Stórálann analyze=false é gan an anailís chúlra a thosú, mar go ritheann an chéad chéim eile ceann.

    bash
    curl -X POST https://attorly.ai/api/v1/documents \
      -H "Authorization: Bearer $ATTORLY_API_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -F "[email protected]" \
      -F "type=NDA" \
      -F "analyze=false"
  3. 3. Déan anailís air

    Fanann Prefer: wait=30 suas le 30 soicind ar an toradh. Tagann anailís chríochnaithe ar ais mar 200 agus an toradh in data. Má thógann sé níos faide, faigheann tú 202 Accepted le ceanntásc Location a dhíríonn ar an oibríocht.

    bash
    curl -i -X POST https://attorly.ai/api/v1/documents/$DOCUMENT_ID/analyses \
      -H "Authorization: Bearer $ATTORLY_API_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Prefer: wait=30" \
      -H "Content-Type: application/json" \
      -d '{ "mode": "full", "options": { "partyRole": "BUYER" } }'
  4. 4. Bailigh an toradh

    Ceistigh an oibríocht arís agus arís eile go dtí go mbeidh a stádas succeeded nó failed. Tá an anailís in result. Insíonn Retry-After cé mhéad soicind le fanacht idir cheistiúcháin.

    bash
    curl https://attorly.ai/api/v1/operations/$OPERATION_ID \
      -H "Authorization: Bearer $ATTORLY_API_KEY"

Fíordheimhniú

Seol dintiúr sa cheanntásc Authorization mar chomhartha Bearer. Tosaíonn eochracha ó Socruithe › Forbróirí le lbmcp_ agus oibríonn siad ar Pro agus ar Fiontar, don REST API agus don fhreastalaí MCP araon. Tosaíonn eochracha eagraíochta Fiontar le atly_ (atly_rk_ d’eochracha srianta, atly_test_ don mhód tástála); leanann seanEochracha lb_ ag obair. Úsáideann aipeanna a ghníomhaíonn thar ceann duine OAuth.

http
Authorization: Bearer atly_live_…   # or lbmcp_…, atly_test_…, an OAuth access token

Raonta

Tá na raonta atá liostaithe in aice le gach críochphointe de dhíth air. Faigheann eochair nach bhfuil siad aici 403 insufficient_scope, agus liostaíonn requiredScopes san earráid gach raon atá de dhíth ar an nglao. Úsáideann eochracha API eagraíochta agus OAuth na hainmneacha raoin seo:

RaonRaon eochrach API eagraíochta
DOCUMENTS_READdocuments:read
DOCUMENTS_WRITEdocuments:write
DOCUMENTS_DELETEdocuments:delete
DOCUMENTS_ANALYZEanalysis:create
CLAUSES_READclauses:read
RESEARCH_READresearch:read
REDLINES_GENERATEredlines:write
NEGOTIATIONS_READnegotiations:read
WORKFLOWS_EXECUTEworkflows:execute
DUE_DILIGENCE_FULLdue-diligence:write
TEMPLATES_READtemplates:read
TEMPLATES_DRAFTdrafts:write
CASES_READcases:read
CASES_WRITEcases:write

Earráidí

Tá an cruth céanna ar gach earráid: cód cobhsaí le brainseáil air, teachtaireacht do dhaoine, agus requestId le lua leis an bhfoireann tacaíochta.

http
HTTP/1.1 403 Forbidden
Content-Type: application/json
Request-Id: req_7Hq2LmN4pX9sT1vB3cD5eF6g
Attorly-Version: 2026-12-01

{
  "error": {
    "type": "permission_error",
    "code": "insufficient_scope",
    "message": "Insufficient permissions. Missing scope: redlines:write.",
    "requiredScopes": ["redlines:write"],
    "docUrl": "https://attorly.ai/docs/api/errors#insufficient_scope",
    "requestId": "req_7Hq2LmN4pX9sT1vB3cD5eF6g"
  }
}

Mínítear gach cód, agus cad is féidir a dhéanamh faoi, ar leathanach na gcód earráide

Leaganú

Leaganaítear an API de réir dáta. Seol Attorly-Version chun leagan a roghnú d’iarratas amháin; gan é, úsáideann iarratas an leagan lenar cruthaíodh a eochair (úsáideann eochracha a cruthaíodh roimh an leaganú 2026-10-01). Insíonn gach freagra cén leagan a d’fhreagair. Ní thagann athruithe briste ach i leagan nua, agus liostaíonn an loga athruithe iad.

http
curl https://attorly.ai/api/v1/documents \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Attorly-Version: 2026-12-01"

HTTP/1.1 200 OK
Attorly-Version: 2026-12-01
Request-Id: req_…

Neamhathraitheacht (idempotency)

Seol ceanntásc Idempotency-Key, mar shampla UUID, ar iarratais POST, PATCH agus DELETE. Faigheann athiarracht leis an eochair chéanna agus an t-iarratas céanna an chéad fhreagra ar ais le Idempotent-Replayed: true, agus ní ritear ná ní bhilleáiltear an obair arís. Faigheann eochair a athúsáidtear d’iarratas eile 422 idempotency_key_reused, agus faigheann ceann atá fós ag rith 409 nó, i gcás glao fadréimsigh, an oibríocht chéanna. Ní stóráiltear earráidí freastalaí, mar sin ritear a n-athiarracht arís. Coinnítear eochracha ar feadh 24 uair an chloig.

bash
curl -X POST https://attorly.ai/api/v1/redlines \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "documentId": "doc_123", "partyRole": "BUYER" }'

# IDEMPOTENCY_KEY=$(uuidgen) once per logical request; a retry with the same key and body:
HTTP/1.1 202 Accepted
Idempotent-Replayed: true

Iarratais fhadréimseacha

Ó leagan 2026-11-01, tugann anailísí iomlána, leasuithe, leabhair imeartha idirbheartaíochta, sreafaí oibre, tuarascálacha dícheall cuí agus dréachtaí IS freagra 202 Accepted le hoibríocht láithreach. Seol Prefer: wait=30 chun fanacht suas le 30 soicind (60 ar a mhéad) ar an toradh ar dtús, nó Prefer: respond-async chun 202 a iarraidh ar aon scríobh. Ceistigh an Location go dtí go mbeidh an stádas succeeded nó failed, nó liostáil le operation.succeeded. Coinnítear torthaí ar feadh 24 uair an chloig. Ní ritheann níos mó ná 5 oibríocht IS fhadréimseacha in aghaidh na heagraíochta ag an am céanna; faigheann tuilleadh 429 concurrency_limit_exceeded.

http
HTTP/1.1 202 Accepted
Location: /api/v1/operations/op_abc123
Retry-After: 2

{ "data": { "id": "op_abc123", "object": "operation", "status": "running", "resultUrl": "/api/v1/operations/op_abc123", … } }

Leathanú

Tugann liostaí { object: "list", data, hasMore, nextCursor } ar ais agus glacann siad limit (1 go 100, 20 de réir réamhshocraithe) agus cursor. Chun an chéad leathanach eile a fháil, seol nextCursor mar cursor. Ar an leathanach deireanach, is null é nextCursor. Fanann cúrsóirí bailí fad a chuirtear míreanna nua leis.

http
GET /api/v1/documents?limit=2

{
  "object": "list",
  "data": [ { "id": "doc_2", … }, { "id": "doc_1", … } ],
  "hasMore": true,
  "nextCursor": "eyJ0IjoiMjAyNi0xMC0xMVQxMDowMDowMC4wMDBaIiwiaWQiOiJkb2NfMSJ9"
}

GET /api/v1/documents?limit=2&cursor=eyJ0IjoiMjAy…

Teorainneacha ráta

Áirítear iarratas in aghaidh roinnt fuinneog: teorainn uaire na heochrach, 300 sa nóiméad in aghaidh an duine, 600 sa nóiméad in aghaidh na heagraíochta, teorainn in aghaidh an nóiméid in aghaidh na heochrach do léamha, do scríbhinní agus do ghlaonna IS, agus teorainn gach oibríochta féin. Roinneann REST agus MCP na háiritheoirí céanna. Taispeánann na ceanntásca RateLimit-Policy agus RateLimit gach fuinneog; taispeánann X-RateLimit-* an ceann is gaire do bheith ídithe. Thar teorainn faigheann tú 429 le Retry-After.

http
RateLimit-Policy: "key-hour";q=1000;w=3600, "user-minute";q=300;w=60, "org-minute";q=600;w=60, "ai-minute";q=30;w=60, "tool";q=10;w=60
RateLimit: "key-hour";r=998;t=3412, "user-minute";r=297;t=41, "org-minute";r=590;t=41, "ai-minute";r=29;t=41, "tool";r=9;t=41
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1791720000

Crúcaí gréasáin

Cruthaigh críochphointe le POST /api/v1/webhook-endpoints chun go gcuirfí in iúl duit nuair a chríochnaíonn obair, in ionad ceistiú arís agus arís eile. Seolann Attorly POST le himeacht JSON agus síníonn sé é de réir Standard Webhooks le rún whsec_ an chríochphointe. Fíoraigh an síniú sula gcuireann tú muinín sa chorp, freagair le 2xx laistigh de 15 soicind agus díbhlúirigh ar webhook-id: déantar athiarracht ar sheachadtaí teipthe ar feadh 72 uair an chloig. Is féidir leat an rún a rothlú, imeacht tástála a sheoladh agus gach seachadadh a fheiceáil.

typescript
import crypto from 'node:crypto';

// Standard Webhooks: verify before you parse. secret is the endpoint's whsec_… value.
export function verifyAttorlyWebhook(rawBody: string, headers: Headers, secret: string): unknown {
  const id = headers.get('webhook-id');
  const timestamp = headers.get('webhook-timestamp');
  const signatures = headers.get('webhook-signature') ?? '';
  if (!id || !timestamp) throw new Error('Missing webhook headers');
  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > 300) throw new Error('Timestamp too old');

  const key = Buffer.from(secret.replace(/^whsec_/, ''), 'base64');
  const expected = crypto.createHmac('sha256', key).update(`${id}.${timestamp}.${rawBody}`).digest();
  const valid = signatures.split(' ').some((entry) => {
    const [version, value] = entry.split(',');
    const given = Buffer.from(value ?? '', 'base64');
    return version === 'v1' && given.length === expected.length && crypto.timingSafeEqual(given, expected);
  });
  if (!valid) throw new Error('Invalid signature');
  return JSON.parse(rawBody); // Deduplicate on webhook-id: a delivery can arrive more than once.
}

Mód tástála

Sroicheann eochracha tástála (atly_test_…) gach críochphointe, ach oibríonn siad ar shonraí tástála ar leith agus tugann siad torthaí samplacha seasta ar ais: ní ritheann aon IS agus ní úsáidtear aon chreidmheasanna. Ní fheiceann eochair tástála sonraí beo riamh. Cuir luach draíochta ar nós __fail_credits__, __fail_consent__ nó __slow__ in aon réimse téacs chun an teip nó an mhoill sin a fháil. Glanann DELETE /api/v1/test-data gach rud a chruthaigh eochair tástála.

bash
curl -X POST https://attorly.ai/api/v1/analyses \
  -H "Authorization: Bearer atly_test_…" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "quick", "content": "__fail_credits__" }'

HTTP/1.1 402 Payment Required
{ "error": { "code": "insufficient_credits", "message": "Test mode: the AI credits are used up …" } }

OAuth

Síníonn aipeanna a ghníomhaíonn thar ceann úsáideora Attorly isteach le OAuth 2.1: fionnachtain ag /.well-known/oauth-authorization-server, clárú dinimiciúil cliant, agus sreabhadh an chóid údaraithe le PKCE (S256). Iarr resource=https://attorly.ai/api/v1 chun comhartha a fháil don REST API; diúltaítear anseo do chomhartha a eisíodh don fhreastalaí MCP. Cuir offline_access leis chun comhartha athnuachana a fháil. Roghnaíonn an duine an eagraíocht agus is féidir leis na raonta a chúngú ar an scáileán toilithe.

http
GET https://attorly.ai/.well-known/oauth-protected-resource/api/v1
GET https://attorly.ai/.well-known/oauth-authorization-server

GET https://attorly.ai/api/oauth/authorize?response_type=code&client_id=…&redirect_uri=…
    &code_challenge=…&code_challenge_method=S256&scope=documents:read%20offline_access
    &resource=https://attorly.ai/api/v1&state=…

POST https://attorly.ai/api/oauth/token
grant_type=authorization_code&code=…&code_verifier=…&redirect_uri=…&client_id=…&resource=https://attorly.ai/api/v1

Billeáil

Úsáideann oibríochtaí a ritheann IS na creidmheasanna IS céanna le haip Attorly, ó sparán úinéir na heochrach nó ó sparán a eagraíochta, cibé acu a ghlaonn tú orthu thar REST nó MCP. Nuair a ídítear na creidmheasanna faigheann tú 402 insufficient_credits. Tá glaonna sa mhód tástála saor in aisce.

Pleananna

Tá an API san áireamh in Pro agus in Fiontar. Mura bhfuil rochtain API i bplean úinéir na heochrach a thuilleadh, nó má d’fhág an t-úinéir an eagraíocht, diúltaítear d’iarratais le 403.

Tagairt

Gach oibríocht, ginte ón doiciméad OpenAPI a fhreastalaíonn an API. Tá conairí coibhneasta le https://attorly.ai. Clúdaíonn freagraí rathúla an toradh in data. Tá cur síos na réimsí i mBéarla.

Doiciméid

GET/api/v1/documentslistDocuments

Liostaigh na doiciméid stóráilte is féidir leis an eochair a léamh, an ceann is nuaí ar dtús.

Raon:DOCUMENTS_READ
Paraiméadair iarratais
RéimseCineálCur síos
type"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …Only documents of this kind
status"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"Only documents in this processing state
querystringOnly documents whose name contains this text
includeArchivedbooleanAlso list archived documents (left out by default)
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/documents?limit=20" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/documentsuploadDocument

Uaslódáil doiciméad mar multipart/form-data, nó mar JSON le hábhar base64 nó gnáth-théacs. Déantar anailís air sa chúlra mura bhfuil analyze socraithe go false.

Raon:DOCUMENTS_WRITEÚsáideann creidmheasanna ISGlacann le huaslódálacha comhad
Corp an iarratais
RéimseCineálCur síos
filenameriachtanachstringThe file name with its extension, e.g. "nda.pdf"; the extension decides the file type when mimeType is absent
contentBase64stringThe file, base64-encoded
textstringPlain text to store as a .txt document, instead of contentBase64
mimeTypestringThe file's MIME type; checked against its content
namestringDisplay name; defaults to the file name
type"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …What the document is
urlstring (uri)An https URL Attorly downloads the file from (public hosts only, up to 10 MB), instead of contentBase64 or text
analyzebooleanAnalyse the document in the background after upload, as the app does (uses AI credits). false stores it only
Sonraí an fhreagra (201)
RéimseCineálCur síos
idriachtanachstring
nameriachtanachstring
originalNameriachtanachstring
typeriachtanach"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …
sizeriachtanachinteger
statusriachtanach"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"PENDING until processing starts; ANALYZED once the analysis is stored
analysisQueuedriachtanachbooleantrue when the background analysis was started
createdAtriachtanachstringISO 8601 date-time
urlriachtanachstringWhere the document opens in Attorly
curl
curl -X POST "https://attorly.ai/api/v1/documents" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "filename": "nda.txt",
  "text": "This Mutual Non-Disclosure Agreement is entered into by…",
  "type": "NDA"
}'
GET/api/v1/documents/searchsearchDocuments

Cuardaigh téacs na ndoiciméad is féidir leis an eochair a léamh, de réir brí agus de réir focal cruinn.

Raon:DOCUMENTS_READ
Paraiméadair iarratais
RéimseCineálCur síos
queryriachtanachstringWhat to look for, in plain language or exact words
type"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …Only documents of this kind
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/documents/search?query=limitation+of+liability&limit=10" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/documents/{documentId}getDocument

Faigh doiciméad, a stádas próiseála agus an anailís is déanaí air.

Raon:DOCUMENTS_READ
Paraiméadair chonaire
RéimseCineálCur síos
documentIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstring
nameriachtanachstring
originalNameriachtanachstring
typeriachtanach"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …
mimeTyperiachtanachstring
sizeriachtanachinteger
statusriachtanach"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"PENDING until processing starts; ANALYZED once the analysis is stored
archivedriachtanachboolean
ownedByYouriachtanachboolean
versionNumberriachtanachinteger | nullThe document's number among its versions you can read ("version 2" — a new version is saved as a new document, never in place); null when it has no other version. documents_list returns the newest version of each document only.
createdAtriachtanachstringISO 8601 date-time
updatedAtriachtanachstringISO 8601 date-time
fileAvailableriachtanachbooleanfalse when the stored file can no longer be read
governingLawRequiredriachtanachbooleantrue when the analysis is held until a governing law is chosen for the document in Attorly
latestAnalysisriachtanachobject | null
urlriachtanachstringWhere the document opens in Attorly
curl
curl "https://attorly.ai/api/v1/documents/doc_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
DELETE/api/v1/documents/{documentId}deleteDocument

Iarr go scriosfaí doiciméad is leat. Ní scriostar an doiciméad ach nuair a cheadaíonn tú é in Attorly.

Raon:DOCUMENTS_DELETE
Paraiméadair chonaire
RéimseCineálCur síos
documentIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstring
deletedriachtanachbooleantrue only when the document is gone
statusriachtanach"deleted" | "declined" | "awaiting_approval"deleted: the owner approved and it is gone; declined: the owner said no in their app, nothing was deleted; awaiting_approval: it is marked and waits for the owner to delete or keep it in Attorly
requestedAtstringWhen the deletion was first asked for (awaiting_approval)
urlstringWhere the owner approves or keeps the document in Attorly (awaiting_approval)
curl
curl -X DELETE "https://attorly.ai/api/v1/documents/doc_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
POST/api/v1/analysescreateAnalysis

Déan anailís ar dhoiciméad nó ar théacs inlíne. Is é mode full (doiciméad stóráilte) nó quick.

Raon:DOCUMENTS_ANALYZEDOCUMENTS_READÚsáideann creidmheasanna IS

Roghnaíonn réimse mode an choirp ceann de: mode: full, mode: quick.

Corp an iarratais
RéimseCineálCur síos
mode"full" | "quick"Runs documents_analyze.
documentIdstring
contentstring
mimeTypestring
optionsobject
curl
curl -X POST "https://attorly.ai/api/v1/analyses" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "quick",
  "content": "This Agreement is entered into by and between…"
}'
GET/api/v1/documents/{documentId}/analyseslistDocumentAnalyses

Liostaigh anailísí stóráilte doiciméid, an ceann is nuaí ar dtús.

Raon:DOCUMENTS_READ
Paraiméadair chonaire
RéimseCineálCur síos
documentIdriachtanachstring
Paraiméadair iarratais
RéimseCineálCur síos
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/documents/doc_abc123/analyses" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/documents/{documentId}/analysescreateDocumentAnalysis

Déan anailís ar dhoiciméad stóráilte.

Raon:DOCUMENTS_ANALYZEDOCUMENTS_READÚsáideann creidmheasanna IS
Paraiméadair chonaire
RéimseCineálCur síos
documentIdriachtanachstring

Roghnaíonn réimse mode an choirp ceann de: mode: full, mode: quick.

Corp an iarratais
RéimseCineálCur síos
mode"full" | "quick"Runs documents_analyze.
contentstring
mimeTypestring
optionsobject
curl
curl -X POST "https://attorly.ai/api/v1/documents/doc_abc123/analyses" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "full",
  "options": {
    "partyRole": "BUYER"
  }
}'
GET/api/v1/documents/{documentId}/textgetDocumentText

Asbhain gnáth-théacs doiciméid PDF nó DOCX stóráilte.

Raon:DOCUMENTS_READ
Paraiméadair chonaire
RéimseCineálCur síos
documentIdriachtanachstring
Paraiméadair iarratais
RéimseCineálCur síos
offsetintegerCharacter offset to start from; pass the nextOffset of the previous call to read on
maxCharactersintegerMost characters to return in this call
Sonraí an fhreagra (200)
RéimseCineálCur síos
textriachtanachstringThe document text from offset (untrusted content)
documentNameriachtanachstring
documentTyperiachtanachstring
mimeTyperiachtanachstring | null
characterCountriachtanachintegerCharacters in the whole document
wordCountriachtanachintegerWords in the whole document
offsetriachtanachinteger
nextOffsetriachtanachinteger | nullPass as offset to read on; null when the text ends here
truncatedriachtanachbooleantrue when the text continues past this slice
curl
curl "https://attorly.ai/api/v1/documents/doc_abc123/text" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/analyses/{analysisId}getAnalysis

Faigh anailís stóráilte: achoimre, riosca, príomhthéarmaí, clásail agus moltaí.

Raon:DOCUMENTS_READ
Paraiméadair chonaire
RéimseCineálCur síos
analysisIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstring
documentIdriachtanachstring
documentNameriachtanachstring
summaryriachtanachstring | null
riskLevelriachtanach"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
riskScoreriachtanachnumber
keyTermsriachtanacharray of any
clausesriachtanacharray of any
recommendationsriachtanacharray of any
moderiachtanachstringSINGLE or CONSENSUS
createdAtriachtanachstringISO 8601 date-time
urlriachtanachstring
curl
curl "https://attorly.ai/api/v1/analyses/your_analysisId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/comparisonscreateComparison

Cuir dhá dhoiciméad nó dhá théacs i gcomparáid líne ar líne.

Raon:DOCUMENTS_READ
Corp an iarratais
RéimseCineálCur síos
sourceDocumentIdstring
sourceContentstring
targetDocumentIdstring
targetContentstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
differencesriachtanacharray of object
summaryriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/comparisons" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "sourceDocumentId": "doc_abc123",
  "targetDocumentId": "doc_def456"
}'

Clásail

GET/api/v1/clausessearchClauses

Cuardaigh leabharlann na gclásal.

Raon:CLAUSES_READ
Paraiméadair iarratais
RéimseCineálCur síos
queryriachtanachstring
category"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …
jurisdictionstring
riskLevel"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
limitinteger
Sonraí an fhreagra (200)
RéimseCineálCur síos
clausesriachtanacharray of object
countriachtanachinteger
curl
curl "https://attorly.ai/api/v1/clauses?query=limitation+of+liability&limit=5" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/clauses/risk-assessmentscreateClauseRiskAssessment

Measúnaigh riosca clásail.

Raon:CLAUSES_READ
Corp an iarratais
RéimseCineálCur síos
clauseTextriachtanachstring
category"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …The kind of clause; its risk rules are applied
jurisdictionstringISO 3166-1 alpha-2 country code; defaults to international
contractTypestring
partyRole"BUYER" | "SELLER" | "LANDLORD" | "TENANT" | "EMPLOYER" | "EMPLOYEE" | …
Sonraí an fhreagra (200)
RéimseCineálCur síos
clauseTextstring
clauseTyperiachtanachstring
jurisdictionriachtanachstring
overallRiskScoreriachtanachnumber
riskLevelriachtanach"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
riskFactorsriachtanacharray of object
recommendationsriachtanacharray of string
alternativesarray of object
complianceIssuesarray of object
negotiationTipsarray of string
curl
curl -X POST "https://attorly.ai/api/v1/clauses/risk-assessments" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "clauseText": "The Supplier’s total liability shall not exceed the fees paid in the preceding month.",
  "category": "LIABILITY",
  "partyRole": "BUYER"
}'
POST/api/v1/clauses/market-comparisonscreateClauseMarketComparison

Cuir clásal i gcomparáid le friotal caighdeánach an mhargaidh.

Raon:CLAUSES_READ
Corp an iarratais
RéimseCineálCur síos
clauseTextriachtanachstring
categoryriachtanach"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …
contractTypestring
jurisdictionstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
inputClauseriachtanachstring
categoryriachtanachstring
marketStandardsriachtanacharray of object
comparisonriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/clauses/market-comparisons" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "clauseText": "Either party may terminate this Agreement on 10 days’ written notice.",
  "category": "TERMINATION"
}'
POST/api/v1/clauses/playbook-checkscreateClausePlaybookCheck

Seiceáil clásal i gcoinne leabhair imeartha.

Raon:CLAUSES_READ
Corp an iarratais
RéimseCineálCur síos
clauseTextriachtanachstring
playbookIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
playbookNameriachtanachstring
compliantriachtanachboolean
violationsriachtanacharray of string
warningsriachtanacharray of string
rulesCheckedriachtanachinteger
curl
curl -X POST "https://attorly.ai/api/v1/clauses/playbook-checks" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "clauseText": "This Agreement is governed by the laws of England.",
  "playbookId": "pb_abc123"
}'

Taighde

POST/api/v1/research/searchessearchResearch

Cuardaigh foinsí dlí ar nós Lovdata, EUR-Lex agus CourtListener.

Raon:RESEARCH_READÚsáideann creidmheasanna IS
Corp an iarratais
RéimseCineálCur síos
queryriachtanachstring
jurisdictionsarray of stringISO 3166-1 alpha-2 country code to search under, or "EU"; the first entry is used. Defaults to the key owner's country.
sourcesarray of "lovdata" | "eurlex" | "legislation_uk" | "congress_gov" | "courtlistener" | "finlex"Keep only results from these publishers
dateFromstringKeep only dated results on or after this day
dateTostringKeep only dated results on or before this day
limitinteger
Sonraí an fhreagra (200)
RéimseCineálCur síos
queryriachtanachstring
jurisdictionriachtanachstring
resultsriachtanacharray of object
totalCountriachtanachintegerResults matching the filters, before limit
sourcesstring
curl
curl -X POST "https://attorly.ai/api/v1/research/searches" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "notice period for terminating a commercial lease",
  "jurisdictions": [
    "NO"
  ],
  "limit": 5
}'
GET/api/v1/research/statutesgetStatute

Aimsigh reacht de réir lua.

Raon:RESEARCH_READÚsáideann creidmheasanna IS
Paraiméadair iarratais
RéimseCineálCur síos
citationriachtanachstring
jurisdictionriachtanachstringISO 3166-1 alpha-2 country code, or "EU"
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstring
titleriachtanachstring
sourceriachtanachstring
jurisdictionstring
citationstring
urlstring
datestring
excerptstring
relevanceScorenumber
attributionstring
asOfstring
consolidatedAsOfstringISO date the stored text is "as amended through", as its publisher states
inForceTostringISO date the act stops/stopped being in force, when the publisher states one
repealedAtstringISO date the act was repealed, when it was
lawDatesReadbooleanTrue when the publisher's dates were read for the act; a missing consolidatedAsOf then means an unamended text
curl
curl "https://attorly.ai/api/v1/research/statutes?citation=LOV-1999-03-26-17&jurisdiction=NO" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

Leasuithe

POST/api/v1/redlinescreateRedlines

Gin moltaí leasuithe do dhoiciméad nó do théacs.

Raon:REDLINES_GENERATEÚsáideann creidmheasanna IS
Corp an iarratais
RéimseCineálCur síos
documentIdstring
contentstring
partyRoleriachtanach"BUYER" | "SELLER" | "LANDLORD" | "TENANT" | "EMPLOYER" | "EMPLOYEE"
riskTolerance"CONSERVATIVE" | "MODERATE" | "AGGRESSIVE"
focusAreasarray of string
playbookIdstringRedline against this playbook's position ladders (own, organisation, system or shared playbooks)
side"OUR_PAPER" | "THEIR_PAPER" | "EITHER"Whose paper the document is, to pick the playbook positions that apply
Sonraí an fhreagra (200)
RéimseCineálCur síos
changesriachtanacharray of object
summaryobject
negotiationNotesarray of string
statisticsriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/redlines" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "documentId": "doc_abc123",
  "partyRole": "BUYER",
  "riskTolerance": "CONSERVATIVE"
}'
POST/api/v1/documents/{documentId}/redlines/resolutionsresolveRedlines

Glac le hathruithe leasuithe ar dhoiciméad nó diúltaigh dóibh.

Raon:REDLINES_GENERATE
Paraiméadair chonaire
RéimseCineálCur síos
documentIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
changesriachtanacharray of object
Sonraí an fhreagra (200)
RéimseCineálCur síos
acceptedriachtanachinteger
rejectedriachtanachinteger
messageriachtanachstring
curl
curl -X POST "https://attorly.ai/api/v1/documents/doc_abc123/redlines/resolutions" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "changes": [
    {
      "id": "chg_1",
      "action": "accept"
    },
    {
      "id": "chg_2",
      "action": "reject"
    }
  ]
}'

Idirbheartaíocht

POST/api/v1/negotiations/position-analysescreateNegotiationPositionAnalysis

Déan anailís ar sheasamh idirbheartaíochta.

Raon:NEGOTIATIONS_READÚsáideann creidmheasanna IS
Corp an iarratais
RéimseCineálCur síos
documentIdstring
contentstring
partyRoleriachtanach"BUYER" | "SELLER" | "LANDLORD" | "TENANT" | "EMPLOYER" | "EMPLOYEE"
contextobject
Sonraí an fhreagra (200)
RéimseCineálCur síos
overallPositionriachtanachstringFAVORABLE, BALANCED or UNFAVORABLE
positionsriachtanacharray of object
prioritizedConcessionsarray of string
dealBreakersarray of string
suggestedApproachstring
estimatedOutcomeobject
curl
curl -X POST "https://attorly.ai/api/v1/negotiations/position-analyses" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "documentId": "doc_abc123",
  "partyRole": "BUYER"
}'
POST/api/v1/negotiations/playbookscreateNegotiationPlaybook

Tóg leabhar imeartha idirbheartaíochta ó straitéis.

Raon:NEGOTIATIONS_READÚsáideann creidmheasanna IS
Corp an iarratais
RéimseCineálCur síos
strategyriachtanachobject
contextobject
Sonraí an fhreagra (200)
RéimseCineálCur síos
playbookriachtanacharray of object
anticipatedObjectionsriachtanacharray of object
recommendationsriachtanacharray of string
summaryriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/negotiations/playbooks" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "strategy": {
    "overallPosition": "collaborative",
    "priorities": [
      "Cap liability at 12 months of fees",
      "Keep Norwegian law"
    ]
  }
}'

Sreafaí oibre

GET/api/v1/workflows/templateslistWorkflowTemplates

Liostaigh teimpléid sreafa oibre.

Raon:WORKFLOWS_EXECUTE
Paraiméadair iarratais
RéimseCineálCur síos
category"MA_ACQUISITION" | "MA_MERGER" | "INVESTMENT" | "IPO" | "REAL_ESTATE" | "REGULATORY" | …Due diligence project type the template is built for
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/workflows/templates?limit=20" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/workflows/executionslistWorkflowExecutions

Liostaigh rití sreafa oibre, an ceann is nuaí ar dtús, do thionscadal nó do stádas amháin más mian leat.

Raon:WORKFLOWS_EXECUTE
Paraiméadair iarratais
RéimseCineálCur síos
projectIdstringOnly executions on this due diligence project
status"PENDING" | "RUNNING" | "WAITING_FOR_INPUT" | "WAITING_FOR_APPROVAL" | "PAUSED" | "COMPLETED" | …
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/workflows/executions?status=COMPLETED&limit=20" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/workflows/executionscreateWorkflowExecution

Tosaigh sreabhadh oibre ar thionscadal dícheall cuí.

Raon:WORKFLOWS_EXECUTEÚsáideann creidmheasanna IS
Corp an iarratais
RéimseCineálCur síos
templateIdriachtanachstring
projectIdriachtanachstring
inputsriachtanachobject
optionsobject
Sonraí an fhreagra (202)
RéimseCineálCur síos
executionIdriachtanachstring
templateIdriachtanachstring
templateNameriachtanachstring
statusriachtanachstring
startedAtriachtanachstringISO 8601 date-time
messageriachtanachstring
curl
curl -X POST "https://attorly.ai/api/v1/workflows/executions" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "wft_abc123",
  "projectId": "ddp_abc123",
  "inputs": {}
}'
GET/api/v1/workflows/executions/{executionId}getWorkflowExecution

Faigh stádas rith sreafa oibre.

Raon:WORKFLOWS_EXECUTE
Paraiméadair chonaire
RéimseCineálCur síos
executionIdriachtanachstring
Paraiméadair iarratais
RéimseCineálCur síos
includeStepsboolean
Sonraí an fhreagra (200)
RéimseCineálCur síos
executionIdriachtanachstring
templateNameriachtanachstring
statusriachtanachstring
startedAtstringISO 8601 date-time
completedAtstringISO 8601 date-time
variablesobject
errorstring | null
stepsarray of object
curl
curl "https://attorly.ai/api/v1/workflows/executions/wfx_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

Dícheall cuí

GET/api/v1/due-diligence/projectslistDueDiligenceProjects

Liostaigh tionscadail dícheall cuí, an ceann is nuaí ar dtús.

Raon:DUE_DILIGENCE_FULL
Paraiméadair iarratais
RéimseCineálCur síos
status"NOT_STARTED" | "IN_PROGRESS" | "UNDER_REVIEW" | "COMPLETED" | "ON_HOLD" | "CANCELLED"Only projects in this state
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/due-diligence/projects?limit=20" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/due-diligence/projectscreateDueDiligenceProject

Cruthaigh tionscadal dícheall cuí.

Raon:DUE_DILIGENCE_FULL
Corp an iarratais
RéimseCineálCur síos
nameriachtanachstring
dealTyperiachtanach"MA_ACQUISITION" | "MA_MERGER" | "INVESTMENT" | "IPO" | "REAL_ESTATE" | "REGULATORY" | …
targetCompanystring
descriptionstring
settingsobject
Sonraí an fhreagra (201)
RéimseCineálCur síos
projectIdriachtanachstring
nameriachtanachstring
projectTyperiachtanachstring
statusriachtanachstring
createdAtriachtanachstringISO 8601 date-time
messageriachtanachstring
curl
curl -X POST "https://attorly.ai/api/v1/due-diligence/projects" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Project Falcon",
  "dealType": "MA_ACQUISITION",
  "targetCompany": "Target AS"
}'
GET/api/v1/due-diligence/projects/{projectId}getDueDiligenceProject

Faigh tionscadal dícheall cuí lena líon doiciméad agus torthaí.

Raon:DUE_DILIGENCE_FULL
Paraiméadair chonaire
RéimseCineálCur síos
projectIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstring
nameriachtanachstring
descriptionriachtanachstring | null
projectTyperiachtanachstring
statusriachtanachstring
priorityriachtanachstring
targetCompanyriachtanachstring | null
dueDateriachtanachstring | null
documentCountriachtanachinteger
findingCountriachtanachinteger
createdAtriachtanachstringISO 8601 date-time
updatedAtriachtanachstringISO 8601 date-time
completedAtriachtanachstring | null
curl
curl "https://attorly.ai/api/v1/due-diligence/projects/ddp_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/due-diligence/projects/{projectId}/documentsaddDueDiligenceDocuments

Cuir doiciméid le tionscadal dícheall cuí.

Raon:DUE_DILIGENCE_FULL
Paraiméadair chonaire
RéimseCineálCur síos
projectIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
documentIdsriachtanacharray of string
categorystring
Sonraí an fhreagra (200)
RéimseCineálCur síos
projectIdriachtanachstring
documentsAddedriachtanachinteger
totalDocumentsriachtanachinteger
categoryriachtanachstring
messageriachtanachstring
curl
curl -X POST "https://attorly.ai/api/v1/due-diligence/projects/ddp_abc123/documents" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "documentIds": [
    "doc_abc123",
    "doc_def456"
  ]
}'
GET/api/v1/due-diligence/projects/{projectId}/findingslistDueDiligenceFindings

Liostaigh torthaí tionscadail dícheall cuí.

Raon:DUE_DILIGENCE_FULL
Paraiméadair chonaire
RéimseCineálCur síos
projectIdriachtanachstring
Paraiméadair iarratais
RéimseCineálCur síos
riskLevel"INFO" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
categorystring
limitinteger
Sonraí an fhreagra (200)
RéimseCineálCur síos
projectIdriachtanachstring
projectNameriachtanachstring
findingsriachtanacharray of object
riskSummaryriachtanachobjectNumber of findings per severity
totalFindingsriachtanachinteger
curl
curl "https://attorly.ai/api/v1/due-diligence/projects/ddp_abc123/findings?riskLevel=HIGH" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/due-diligence/projects/{projectId}/reportscreateDueDiligenceReport

Gin tuarascáil dícheall cuí.

Raon:DUE_DILIGENCE_FULL
Paraiméadair chonaire
RéimseCineálCur síos
projectIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
formatriachtanach"pdf" | "markdown""markdown" returns the report text; "pdf" also returns the formatted PDF (base64)
sectionsarray of "executive_summary" | "risk_overview" | "findings_detail" | "document_analysis" | "recommendations"
includeRecommendationsboolean
Sonraí an fhreagra (201)
RéimseCineálCur síos
reportIdriachtanachstring
projectIdriachtanachstring
projectNamestring
formatriachtanach"pdf" | "markdown"
statusriachtanachstring
sectionsarray of string
documentCountinteger
findingCountinteger
markdownriachtanachstring
attachmentobject
messagestring
curl
curl -X POST "https://attorly.ai/api/v1/due-diligence/projects/ddp_abc123/reports" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "format": "markdown"
}'

Teimpléid agus dréachtaí

GET/api/v1/templateslistTemplates

Liostaigh teimpléid doiciméad.

Raon:TEMPLATES_READ
Paraiméadair iarratais
RéimseCineálCur síos
category"NDA" | "EMPLOYMENT" | "SERVICE_AGREEMENT" | "LEASE" | "REAL_ESTATE" | "CORPORATE" | …
jurisdictionstringISO 3166-1 alpha-2 country code (e.g. "NO", "GB"); jurisdiction-neutral templates are always included
languagestringISO 639-1 language code of the template text (e.g. "en", "nb")
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/templates?limit=20" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/draftscreateDraft

Cruthaigh dréacht ó theimpléad (mode template) nó le IS (mode ai).

Raon:TEMPLATES_DRAFTÚsáideann creidmheasanna IS

Roghnaíonn réimse mode an choirp ceann de: mode: template, mode: ai.

Corp an iarratais
RéimseCineálCur síos
mode"template" | "ai"Runs templates_draft.
templateIdstring
variablesobject
optionsobject
documentTypestring
requirementsstring
contextobject
curl
curl -X POST "https://attorly.ai/api/v1/drafts" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "template",
  "templateId": "tpl_abc123",
  "variables": {
    "partyA": "Acme AS",
    "partyB": "Beta AB"
  }
}'

Cásanna

GET/api/v1/caseslistCases

Liostaigh do chásanna, an ceann is déanaí a athraíodh ar dtús.

Raon:CASES_READ
Paraiméadair iarratais
RéimseCineálCur síos
status"ACTIVE" | "CLOSED" | "ARCHIVED"Only cases in this state; all states when absent
limitinteger
cursorstringPass the nextCursor of the previous page to get the next one
curl
curl "https://attorly.ai/api/v1/cases?status=ACTIVE&limit=20" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/cases/{caseId}/timelinegetCaseTimeline

Faigh amlíne cáis: gach imeacht lena dháta, an fhianaise agus seasamh an pháirtí eile.

Raon:CASES_READ
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseriachtanachobject
eventsriachtanacharray of objectIn date order
countriachtanachinteger
needsReviewCountriachtanachintegerEvents an AI added that no person has confirmed
deletionRequestedCountriachtanachintegerEvents waiting for the owner to approve their deletion
curl
curl "https://attorly.ai/api/v1/cases/case_abc123/timeline" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/cases/{caseId}/timeline/eventscreateTimelineEvent

Cuir imeacht le hamlíne cáis.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
titleriachtanachstringWhat happened, in one line (at most 300 characters)
descriptionstring | nullMore detail, or null to clear it
whenriachtanachobjectWhen it happened, as precisely as it is known. precision TIME: start "YYYY-MM-DD" and time "HH:MM" (24-hour, in the case's time zone). DAY: start "YYYY-MM-DD". MONTH: start "YYYY-MM". YEAR: start "YYYY". PERIOD: start and end "YYYY-MM-DD", end after start. approximate: true when the date is an estimate; it is then written "c. …".
category"CONTRACT" | "DEADLINE" | "INCIDENT" | "FILING" | "CORRESPONDENCE" | "COURT_DATE" | …What kind of event it is; OTHER when absent
importantbooleanMarks a key event; exports can be limited to key events
agreement"UNMARKED" | "AGREED" | "DISPUTED"Whether the other side agrees that it happened this way: AGREED, DISPUTED, or UNMARKED (not assessed)
opposingVersionstring | nullThe other side's account of a DISPUTED event. Kept only while agreement is DISPUTED
commentstring | nullThe owner's private note. Exports print it only when asked to
confidentialbooleanLeave this event out whenever the timeline is shared or exported
sourcesarray of objectThe case documents that evidence the event, with an optional page or section ("p. 3"). Each documentId must be a document of this case. On update, the list replaces the event's sources
Sonraí an fhreagra (201)
RéimseCineálCur síos
caseIdriachtanachstring
eventriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/cases/case_abc123/timeline/events" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Landlord gave written notice of termination",
  "when": {
    "precision": "DAY",
    "start": "2026-03-02"
  },
  "category": "CORRESPONDENCE",
  "important": true,
  "agreement": "DISPUTED",
  "opposingVersion": "The landlord says the notice was handed over on 27 February.",
  "sources": [
    {
      "documentId": "doc_abc123",
      "locator": "p. 1"
    }
  ]
}'
PATCH/api/v1/cases/{caseId}/timeline/events/{eventId}updateTimelineEvent

Athraigh imeacht ar amlíne cáis, nó deimhnigh imeacht a chuir IS leis.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
eventIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
titlestringWhat happened, in one line (at most 300 characters)
descriptionstring | nullMore detail, or null to clear it
whenobjectWhen it happened, as precisely as it is known. precision TIME: start "YYYY-MM-DD" and time "HH:MM" (24-hour, in the case's time zone). DAY: start "YYYY-MM-DD". MONTH: start "YYYY-MM". YEAR: start "YYYY". PERIOD: start and end "YYYY-MM-DD", end after start. approximate: true when the date is an estimate; it is then written "c. …".
category"CONTRACT" | "DEADLINE" | "INCIDENT" | "FILING" | "CORRESPONDENCE" | "COURT_DATE" | …What kind of event it is; OTHER when absent
importantbooleanMarks a key event; exports can be limited to key events
agreement"UNMARKED" | "AGREED" | "DISPUTED"Whether the other side agrees that it happened this way: AGREED, DISPUTED, or UNMARKED (not assessed)
opposingVersionstring | nullThe other side's account of a DISPUTED event. Kept only while agreement is DISPUTED
commentstring | nullThe owner's private note. Exports print it only when asked to
confidentialbooleanLeave this event out whenever the timeline is shared or exported
sourcesarray of objectThe case documents that evidence the event, with an optional page or section ("p. 3"). Each documentId must be a document of this case. On update, the list replaces the event's sources
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseIdriachtanachstring
eventriachtanachobject
curl
curl -X PATCH "https://attorly.ai/api/v1/cases/case_abc123/timeline/events/your_eventId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
DELETE/api/v1/cases/{caseId}/timeline/events/{eventId}deleteTimelineEvent

Iarr go scriosfaí imeacht ó amlíne cáis. Ní scriostar an t-imeacht ach nuair a cheadaíonn an t-úinéir é in Attorly.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
eventIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseIdriachtanachstring
idriachtanachstring
deletedriachtanachbooleantrue only when the event is gone
statusriachtanach"deleted" | "declined" | "awaiting_approval"deleted: the owner approved and it is gone; declined: the owner said no in their app, nothing was deleted; awaiting_approval: it is marked and waits for the owner to delete or keep it in Attorly
requestedAtstringWhen the deletion was first asked for (awaiting_approval)
urlstringWhere the owner approves or keeps the event in Attorly (awaiting_approval)
curl
curl -X DELETE "https://attorly.ai/api/v1/cases/case_abc123/timeline/events/your_eventId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
POST/api/v1/cases/{caseId}/timeline/exportexportCaseTimeline

Easpórtáil amlíne cáis mar chomhad PDF, Word, ODT, Excel nó PowerPoint.

Raon:CASES_READ
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
layoutriachtanach"overview" | "chronology" | "numbered" | "visual"overview: date and what happened, for the other party, a complaints board or a lawyer. chronology: numbered table with sources and an exhibit list, for a court. numbered: one numbered paragraph per event with exhibit references, for the facts section of a filing. visual: the time axis on one landscape page
formatriachtanach"pdf" | "docx" | "odt" | "xlsx" | "pptx"The file type. overview and chronology: pdf, docx, odt, xlsx or pptx. numbered: pdf, docx or odt. visual: pdf or pptx
optionsobject
localestringLanguage of the file's headings, dates and file name, as a locale Attorly ships (e.g. "en", "nb", "de"); the account's language when absent or not offered
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseIdriachtanachstring
layoutriachtanach"overview" | "chronology" | "numbered" | "visual"
formatriachtanach"pdf" | "docx" | "odt" | "xlsx" | "pptx"
localeriachtanachstringThe language the file is written in
eventCountriachtanachintegerEvents in the file
exhibitCountriachtanachintegerDocuments in the exhibit list (chronology and numbered layouts)
leftOutConfidentialriachtanachintegerEvents left out because they are marked confidential
attachmentriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/cases/case_abc123/timeline/export" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "layout": "chronology",
  "format": "docx",
  "options": {
    "markAgreement": true
  },
  "locale": "en"
}'
GET/api/v1/cases/{caseId}/deadlineslistCaseDeadlines

Liostaigh spriocdhátaí cáis, an ceann is gaire ar dtús, le cé leis gach spriocdháta agus cé acu atá sé déanta nó thar téarma.

Raon:CASES_READ
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Paraiméadair iarratais
RéimseCineálCur síos
status"open" | "completed"open: not yet marked done; completed: marked done; both when absent
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseriachtanachobject
deadlinesriachtanacharray of objectSoonest first
countriachtanachinteger
overdueCountriachtanachinteger
curl
curl "https://attorly.ai/api/v1/cases/case_abc123/deadlines?status=open" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/cases/{caseId}/deadlinescreateCaseDeadline

Cuir spriocdháta le cás, ar dháta áirithe nó áirithe ó fhíoras taifeadta.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
titleriachtanachstringWhat must be done by then, in one line (at most 200 characters)
dueAtstring (date) | string (date-time)The due date. A day "YYYY-MM-DD" is due at the end of that day where the case applies (its country, else the owner's); a moment ("2026-03-02T09:00:00+01:00", a hearing) is kept as given
derivedFromobjectCount the date from a recorded date fact instead of giving dueAt: due = the fact's date + offsetDays. The deadline moves with the fact when the fact is corrected. Record the fact first with facts_record
kind"HEARING" | "FILING" | "DISCOVERY" | "STATUTE_OF_LIMITATIONS" | "CUSTOM"What kind of deadline it is; CUSTOM when absent
party"SELF" | "COUNTERPARTY"SELF: the owner must act by then. COUNTERPARTY: a window the other side set; SELF when absent
notesstring | nullA short note shown with the deadline and in its reminders (at most 500 characters), or null to clear it
Sonraí an fhreagra (201)
RéimseCineálCur síos
caseIdriachtanachstring
deadlineriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/cases/case_abc123/deadlines" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Reply to the landlord’s notice",
  "derivedFrom": {
    "factKey": "receivedAt",
    "offsetDays": 30
  },
  "kind": "FILING",
  "party": "SELF",
  "notes": "Object in writing"
}'
PATCH/api/v1/cases/{caseId}/deadlines/{deadlineId}updateCaseDeadline

Athraigh spriocdháta ar chás, nó marcáil é déanta nó oscailte arís.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
deadlineIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
titlestringWhat must be done by then, in one line (at most 200 characters)
dueAtstring (date) | string (date-time)The due date. A day "YYYY-MM-DD" is due at the end of that day where the case applies (its country, else the owner's); a moment ("2026-03-02T09:00:00+01:00", a hearing) is kept as given
derivedFromobjectCount the date from a recorded date fact instead of giving dueAt: due = the fact's date + offsetDays. The deadline moves with the fact when the fact is corrected. Record the fact first with facts_record
kind"HEARING" | "FILING" | "DISCOVERY" | "STATUTE_OF_LIMITATIONS" | "CUSTOM"What kind of deadline it is; CUSTOM when absent
party"SELF" | "COUNTERPARTY"SELF: the owner must act by then. COUNTERPARTY: a window the other side set; SELF when absent
notesstring | nullA short note shown with the deadline and in its reminders (at most 500 characters), or null to clear it
completedbooleantrue marks the deadline done; false reopens it
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseIdriachtanachstring
deadlineriachtanachobject
curl
curl -X PATCH "https://attorly.ai/api/v1/cases/case_abc123/deadlines/dl_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
GET/api/v1/cases/{caseId}/factslistCaseFacts

Liostaigh na fíorais atá taifeadta ar chás, lena bhfoinse, agus na fíorais atá fós de dhíth ar an gcás.

Raon:CASES_READ
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseriachtanachobject
factsriachtanacharray of object
countriachtanachinteger
caseReadsriachtanachobject | nullThe facts the case's rule reads, under exactly these keys; null when it reads none
curl
curl "https://attorly.ai/api/v1/cases/case_abc123/facts" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/cases/{caseId}/factsrecordCaseFact

Taifead fíoras ar chás, nó ceartaigh é. Bogann spriocdhátaí a áirítear uaidh in éineacht leis.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
keyriachtanachstringThe fact, as a camelCase key. facts_list names the facts this case reads, with their format; use one of those, or another camelCase key only for a fact none of them covers
valueriachtanachstringThe value, in the format its key takes (a date fact: YYYY-MM-DD). It is stored in canonical form, so the result can differ from what was sent ("Lissabon" becomes LIS)
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseIdriachtanachstring
outcomeriachtanach"recorded" | "corrected" | "unchanged"recorded: a new fact; corrected: a new value replaced the old one; unchanged: it already held this value
factriachtanachobject
movedDeadlinesriachtanacharray of objectOpen deadlines counted from the fact that moved with the correction, due days before and after
urlriachtanachstringWhere the case opens in Attorly
curl
curl -X POST "https://attorly.ai/api/v1/cases/case_abc123/facts" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "receivedAt",
  "value": "2026-03-04"
}'
GET/api/v1/cases/{caseId}/partieslistCaseParties

Liostaigh páirtithe cáis agus na róil a thairgeann an cás.

Raon:CASES_READ
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseriachtanachobject
partiesriachtanacharray of object
countriachtanachinteger
rolesriachtanacharray of objectThe roles the case offers; empty when it has no case type with roles
curl
curl "https://attorly.ai/api/v1/cases/case_abc123/parties" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/cases/{caseId}/partiescreateCaseParty

Cuir páirtí le cás, i gceann dá róil.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
roleKeyriachtanachstringThe role the party has in the case, as one of the roles parties_list returns (e.g. "landlord")
partyTyperiachtanach"PERSON" | "ENTITY"PERSON for a person, ENTITY for a company or public body
nameriachtanachstringThe party's name (at most 200 characters)
isSelfbooleantrue when this party is the person the connection acts for; false removes that link
orgNumberstringOrganisation number of an ENTITY
personalIdNumberstringNational identity number of a PERSON. Add it only when the owner gave it for this case
emailstring (email)E-mail address
phonestringPhone number
addressstringPostal address
representedBystringThe lawyer or representative acting for the party
notesstringThe owner's note about the party (at most 1000 characters)
positionintegerOrder within its role, 0 first
Sonraí an fhreagra (201)
RéimseCineálCur síos
caseIdriachtanachstring
partyriachtanachobject
curl
curl -X POST "https://attorly.ai/api/v1/cases/case_abc123/parties" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "roleKey": "landlord",
  "partyType": "ENTITY",
  "name": "Fjord Eiendom AS",
  "orgNumber": "999999999",
  "email": "[email protected]"
}'
PATCH/api/v1/cases/{caseId}/parties/{partyId}updateCaseParty

Athraigh sonraí páirtí ar chás.

Raon:CASES_WRITE
Paraiméadair chonaire
RéimseCineálCur síos
caseIdriachtanachstring
partyIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
partyType"PERSON" | "ENTITY"PERSON for a person, ENTITY for a company or public body
namestringThe party's name (at most 200 characters)
isSelfbooleantrue when this party is the person the connection acts for; false removes that link
orgNumberstring | null
personalIdNumberstring | null
emailstring (email) | null
phonestring | null
addressstring | null
representedBystring | null
notesstring | null
positionintegerOrder within its role, 0 first
Sonraí an fhreagra (200)
RéimseCineálCur síos
caseIdriachtanachstring
partyriachtanachobject
curl
curl -X PATCH "https://attorly.ai/api/v1/cases/case_abc123/parties/party_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Oibríochtaí

GET/api/v1/operations/{operationId}getOperation

Faigh stádas agus toradh iarratais a seoladh le Prefer nó Idempotency-Key.

Paraiméadair chonaire
RéimseCineálCur síos
operationIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstringop_…
objectriachtanach"operation"
operationIdriachtanachstringThe REST operation that was called, e.g. createRedlines
statusriachtanach"running" | "awaiting_approval" | "succeeded" | "failed"
livemoderiachtanachboolean
idempotencyKeystring | null
resultUrlriachtanachstringWhere to poll: /api/v1/operations/{id}
createdAtriachtanachstring (date-time)
completedAtriachtanachstring (date-time) | null
expiresAtriachtanachstring (date-time)
httpStatusriachtanachinteger | null
resultriachtanachanyThe data of the successful call
metaobject
errorriachtanachobject | null
curl
curl "https://attorly.ai/api/v1/operations/op_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

Crúcaí gréasáin

GET/api/v1/webhook-endpointslistWebhookEndpoints

Liostaigh críochphointí crúcaí gréasáin eagraíocht agus mhód na heochrach.

curl
curl "https://attorly.ai/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/webhook-endpointscreateWebhookEndpoint

Cruthaigh críochphointe crúca gréasáin. Tá a rún sínithe sa fhreagra, agus ní thaispeántar é ach uair amháin.

Corp an iarratais
RéimseCineálCur síos
urlriachtanachstring (uri)HTTPS URL that receives the events
descriptionstring
enabledEventsriachtanacharray of stringEvent types to receive, or ["*"] for all
includeSnapshotsbooleanSend object snapshots instead of thin { id, object } payloads, for operations made with organization API keys (calls made with personal keys and connected apps always send thin payloads). Organization owners and admins only.
Sonraí an fhreagra (201)
RéimseCineálCur síos
idriachtanachstringwe_…
objectriachtanach"webhook_endpoint"
urlriachtanachstring
descriptionstring | null
enabledEventsriachtanacharray of string
statusriachtanach"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemoderiachtanachboolean
includeSnapshotsriachtanachboolean
apiVersionriachtanachstring
failingSincestring (date-time) | null
createdAtriachtanachstring (date-time)
updatedAtriachtanachstring (date-time)
secretstringwhsec_… — only when the endpoint is created or its secret rolled
curl
curl -X POST "https://attorly.ai/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/attorly/webhooks",
  "description": "Production receiver",
  "enabledEvents": [
    "analysis.completed",
    "operation.succeeded",
    "operation.failed"
  ]
}'
GET/api/v1/webhook-endpoints/{endpointId}getWebhookEndpoint

Faigh críochphointe crúca gréasáin.

Paraiméadair chonaire
RéimseCineálCur síos
endpointIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstringwe_…
objectriachtanach"webhook_endpoint"
urlriachtanachstring
descriptionstring | null
enabledEventsriachtanacharray of string
statusriachtanach"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemoderiachtanachboolean
includeSnapshotsriachtanachboolean
apiVersionriachtanachstring
failingSincestring (date-time) | null
createdAtriachtanachstring (date-time)
updatedAtriachtanachstring (date-time)
secretstringwhsec_… — only when the endpoint is created or its secret rolled
curl
curl "https://attorly.ai/api/v1/webhook-endpoints/your_endpointId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
PATCH/api/v1/webhook-endpoints/{endpointId}updateWebhookEndpoint

Athraigh URL, imeachtaí nó grianghraif chríochphointe, nó díchumasaigh agus cumasaigh é.

Paraiméadair chonaire
RéimseCineálCur síos
endpointIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
urlstring (uri)
descriptionstring | null
enabledEventsarray of string
includeSnapshotsboolean
status"enabled" | "disabled"Disable to pause deliveries; enable to resume
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstringwe_…
objectriachtanach"webhook_endpoint"
urlriachtanachstring
descriptionstring | null
enabledEventsriachtanacharray of string
statusriachtanach"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemoderiachtanachboolean
includeSnapshotsriachtanachboolean
apiVersionriachtanachstring
failingSincestring (date-time) | null
createdAtriachtanachstring (date-time)
updatedAtriachtanachstring (date-time)
secretstringwhsec_… — only when the endpoint is created or its secret rolled
curl
curl -X PATCH "https://attorly.ai/api/v1/webhook-endpoints/your_endpointId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
DELETE/api/v1/webhook-endpoints/{endpointId}deleteWebhookEndpoint

Scrios críochphointe crúca gréasáin agus a stair seachadta.

Paraiméadair chonaire
RéimseCineálCur síos
endpointIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstring
objectriachtanach"webhook_endpoint"
deletedriachtanachtrue
curl
curl -X DELETE "https://attorly.ai/api/v1/webhook-endpoints/your_endpointId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
POST/api/v1/webhook-endpoints/{endpointId}/secret-rollsrollWebhookEndpointSecret

Cuir rún sínithe nua in ionad an tseanchinn. Leanann an seancheann ag síniú ar feadh 24 uair an chloig.

Paraiméadair chonaire
RéimseCineálCur síos
endpointIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstringwe_…
objectriachtanach"webhook_endpoint"
urlriachtanachstring
descriptionstring | null
enabledEventsriachtanacharray of string
statusriachtanach"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemoderiachtanachboolean
includeSnapshotsriachtanachboolean
apiVersionriachtanachstring
failingSincestring (date-time) | null
createdAtriachtanachstring (date-time)
updatedAtriachtanachstring (date-time)
secretstringwhsec_… — only when the endpoint is created or its secret rolled
curl
curl -X POST "https://attorly.ai/api/v1/webhook-endpoints/your_endpointId/secret-rolls" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
POST/api/v1/webhook-endpoints/{endpointId}/test-eventssendWebhookTestEvent

Seol imeacht webhook_endpoint.test chuig an gcríochphointe seo amháin.

Paraiméadair chonaire
RéimseCineálCur síos
endpointIdriachtanachstring
Sonraí an fhreagra (202)
RéimseCineálCur síos
eventIdriachtanachstring
curl
curl -X POST "https://attorly.ai/api/v1/webhook-endpoints/your_endpointId/test-events" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
GET/api/v1/webhook-endpoints/{endpointId}/deliverieslistWebhookDeliveries

Liostaigh seachadtaí críochphointe, an ceann is nuaí ar dtús, lena n-iarrachtaí agus a dtoradh.

Paraiméadair chonaire
RéimseCineálCur síos
endpointIdriachtanachstring
Paraiméadair iarratais
RéimseCineálCur síos
limitintegerItems per page, 1–100 (default 20)
cursorstringThe nextCursor of the previous page
status"pending" | "succeeded" | "failed"Only deliveries in this state
curl
curl "https://attorly.ai/api/v1/webhook-endpoints/your_endpointId/deliveries" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

Imeachtaí

GET/api/v1/eventslistEvents

Liostaigh imeachtaí na 30 lá deireanach, an ceann is nuaí ar dtús.

Paraiméadair iarratais
RéimseCineálCur síos
limitintegerItems per page, 1–100 (default 20)
cursorstringThe nextCursor of the previous page
typestringOnly events of this type, e.g. analysis.completed
curl
curl "https://attorly.ai/api/v1/events" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/events/{eventId}getEvent

Faigh imeacht mar a fhaigheann críochphointí crúcaí gréasáin é.

Paraiméadair chonaire
RéimseCineálCur síos
eventIdriachtanachstring
Sonraí an fhreagra (200)
RéimseCineálCur síos
idriachtanachstringevt_… — also sent as the webhook-id header; deduplicate on it
objectriachtanach"event"
typeriachtanach"analysis.completed" | "analysis.failed" | "redlines.generated" | "due_diligence.report.completed" | "operation.succeeded" | "operation.failed" | …
apiVersionriachtanachstring
createdAtriachtanachstring (date-time)
livemoderiachtanachboolean
datariachtanachobject
curl
curl "https://attorly.ai/api/v1/events/your_eventId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/events/{eventId}/redeliveriesredeliverEvent

Seol imeacht arís, chuig críochphointe amháin nó chuig gach críochphointe atá liostáilte leis.

Paraiméadair chonaire
RéimseCineálCur síos
eventIdriachtanachstring
Corp an iarratais
RéimseCineálCur síos
endpointIdstringOnly this endpoint; default every endpoint subscribed to the event
Sonraí an fhreagra (202)
RéimseCineálCur síos
eventIdriachtanachstring
deliveriesScheduledriachtanachinteger
curl
curl -X POST "https://attorly.ai/api/v1/events/your_eventId/redeliveries" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "endpointId": "we_abc123"
}'

Cuntas, úsáid agus logaí

GET/api/v1/organizationgetOrganization

Eagraíocht na heochrach: plean, creidmheasanna IS, dlínse réamhshocraithe agus a bhfuil cead ag an eochair a dhéanamh.

Sonraí an fhreagra (200)
RéimseCineálCur síos
organizationriachtanachobject
userriachtanachobject
planriachtanachstringSTANDARD, PRO or ENTERPRISE
billingriachtanachobject
defaultJurisdictionriachtanachstring | nullISO 3166-1 alpha-2 country used when a document names no governing law
credentialriachtanachobject
appUrlriachtanachstring
curl
curl "https://attorly.ai/api/v1/organization" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/usagegetUsage

Iarratais in aghaidh an lae, na heochrach agus na hoibríochta, le líon earráidí, thar REST agus MCP.

Paraiméadair iarratais
RéimseCineálCur síos
fromanyISO 8601 date; default 30 days ago (requests are kept 30 days)
toanyISO 8601 date, exclusive; default now
curl
curl "https://attorly.ai/api/v1/usage" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/request-logslistRequestLogs

Liostaigh iarratais API na heagraíochta ó na 30 lá deireanach, an ceann is nuaí ar dtús.

Paraiméadair iarratais
RéimseCineálCur síos
limitintegerItems per page, 1–100 (default 20)
cursorstringThe nextCursor of the previous page
statusstring2xx, 4xx, 5xx, or an exact status
credentialIdstringOnly requests made with this key (apikey:<id>, or an MCP connection id)
operationIdstringOnly calls of this operation, e.g. createRedlines
requestIdstringOne request, by its Request-Id
sinceanyISO 8601; only requests at or after this time
untilanyISO 8601; only requests before this time
curl
curl "https://attorly.ai/api/v1/request-logs" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/audit-eventslistAuditEvents

Cé a ghlaoigh ar cad, cathain agus le cén eochair. D’úinéirí agus do riarthóirí eagraíochta.

Paraiméadair iarratais
RéimseCineálCur síos
limitintegerItems per page, 1–100 (default 20)
cursorstringThe nextCursor of the previous page
statusstring2xx, 4xx, 5xx, or an exact status
credentialIdstringOnly requests made with this key (apikey:<id>, or an MCP connection id)
operationIdstringOnly calls of this operation, e.g. createRedlines
requestIdstringOne request, by its Request-Id
sinceanyISO 8601; only requests at or after this time
untilanyISO 8601; only requests before this time
curl
curl "https://attorly.ai/api/v1/audit-events" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
DELETE/api/v1/test-datadeleteTestData

Scrios gach réad, imeacht agus oibríocht mhód tástála de chuid na heagraíochta. Eochracha tástála amháin.

Sonraí an fhreagra (200)
RéimseCineálCur síos
objectriachtanach"test_data_purge"
deletedriachtanachobject
curl
curl -X DELETE "https://attorly.ai/api/v1/test-data" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"