Gean nei de haadynhâld

Ûntwikkelers

Dokumintaasje fan de REST API

In JSON-oer-HTTPS-API foar de juridyske AI fan Attorly. Hy fiert deselde hannelings út as de MCP-server, mei deselde kaaien, scopes, limiten en fakturearring.

Fluchstart

Laad in kontrakt op en analysearje it yn fjouwer stappen.

  1. 1. In kaai oanmeitsje

    Meitsje in kaai oan yn Ynstellings › Ûntwikkelers en kies REST API. Deselde kaai wurket foar de MCP-server. Bewarje him yn in omjouwingsfariabele:

    bash
    export ATTORLY_API_KEY=lbmcp_your_api_key
  2. 2. In dokumint oplade

    Stjoer it bestân as multipart/form-data. De data.id fan it antwurd is de id fan it dokumint. Mei analyze=false wurdt it bewarre sûnder de analyze op de eftergrûn te begjinnen, om’t de folgjende stap der ien útfiert.

    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. It analysearje

    Mei Prefer: wait=30 wurdt oant 30 sekonden op it resultaat wachte. In foltôge analyze komt werom as 200 mei it resultaat yn data. As it langer duorret, krije jo 202 Accepted mei in Location-header dy’t nei de operaasje ferwiist.

    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. It resultaat ophelje

    Freegje de operaasje geregeld op oant de status succeeded of failed is. De analyze stiet yn result. Retry-After jout oan hoefolle sekonden jo tusken de opfragen wachtsje moatte.

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

Autentikaasje

Stjoer in referinsje yn de Authorization-header as Bearer-token. Kaaien út Ynstellings › Ûntwikkelers begjinne mei lbmcp_ en wurkje mei Pro en Enterprise, foar de REST API en de MCP-server gelyk. Organisaasjekaaien fan Enterprise begjinne mei atly_ (atly_rk_ foar beheinde kaaien, atly_test_ foar testmodus); âldere lb_-kaaien bliuwe wurkjen. Apps dy’t foar in persoan optrede, brûke OAuth.

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

Scopes

Elk einpunt hat de scopes nedich dy’t derneist neamd steane. In kaai sûnder dy scopes krijt 403 insufficient_scope, en requiredScopes yn de flater toant elke scope dy’t de oprop nedich hat. Organisaasje-API-kaaien en OAuth brûke dizze scopenammen:

ScopeScope fan de organisaasje-API-kaai
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

Flaters

Elke flater hat deselde foarm: in fêste code om op te fertakjen, in berjocht foar minsken en in requestId om oan de stipe troch te jaan.

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"
  }
}

Elke code wurdt útlein, mei wat jo deroan dwaan kinne, op de side mei flaterkoades

Ferzjebehear

De API hat ferzjes op datum. Stjoer Attorly-Version om foar ien fersyk in ferzje te kiezen; sûnder dat brûkt in fersyk de ferzje dêr’t syn kaai mei oanmakke is (kaaien dy’t foar it ferzjebehear oanmakke binne, brûke 2026-10-01). Elk antwurd seit hokker ferzje antwurde hat. Brekkende wizigingen komme allinnich yn in nije ferzje, en it wizigingslochboek neamt se.

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_…

Idempotinsje

Stjoer in Idempotency-Key-header, bygelyks in UUID, mei by POST-, PATCH- en DELETE-fersiken. In nij besykjen mei deselde kaai en itselde fersyk krijt it earste antwurd werom mei Idempotent-Replayed: true, en it wurk wurdt net nochris útfierd of yn rekken brocht. In kaai dy’t opnij brûkt wurdt foar in oar fersyk krijt 422 idempotency_key_reused, en ien dy’t noch rint krijt 409 of, by in oprop dy’t lang duorret, deselde operaasje. Serverflaters wurde net bewarre, dus in nij besykjen dêrfan wurdt opnij útfierd. Kaaien wurde 24 oeren bewarre.

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

Fersiken dy’t lang duorje

Fan ferzje 2026-11-01 ôf antwurdzje folsleine analyzes, wizigingsfoarstellen, ûnderhannelingsplaybooks, workflows, due-diligencerapporten en AI-konsepten daliks mei 202 Accepted en in operaasje. Stjoer Prefer: wait=30 om earst oant 30 sekonden (maksimaal 60) op it resultaat te wachtsjen, of Prefer: respond-async om by elke skriuwhanneling om 202 te freegjen. Freegje de Location geregeld op oant de status succeeded of failed is, of abonnearje jo op operation.succeeded. Resultaten wurde 24 oeren bewarre. Der rinne maksimaal 5 AI-operaasjes dy’t lang duorje tagelyk per organisaasje; mear krije 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", … } }

Paginearring

Listen jouwe { object: "list", data, hasMore, nextCursor } werom en nimme limit (1 oant 100, standert 20) en cursor oan. Om de folgjende side te krijen, stjoere jo nextCursor mei as cursor. Op de lêste side is nextCursor null. Cursors bliuwe jildich wylst der nije items tafoege wurde.

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…

Snelheidslimiten

In fersyk telt mei yn ferskate finsters: de limyt per oere fan de kaai, 300 per minút per persoan, 600 per minút per organisaasje, in limyt per minút per kaai foar lêzen, skriuwen en AI-oproppen, en de eigen limyt fan elke operaasje. REST en MCP diele deselde tellers. De headers RateLimit-Policy en RateLimit toane elk finster; X-RateLimit-* toant it finster dat it tichtst by syn limyt is. Boppe in limyt krije jo 429 mei 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

Webhooks

Meitsje in einpunt oan mei POST /api/v1/webhook-endpoints om te hearren wannear’t wurk klear is, ynstee fan geregeld op te freegjen. Attorly stjoert in POST mei in JSON-barren en ûndertekenet dy neffens Standard Webhooks mei it whsec_-geheim fan it einpunt. Ferifiearje de hantekening foardat jo de ynhâld fertrouwe, antwurdzje binnen 15 sekonden mei 2xx en ûntdûbelje op webhook-id: mislearre leveringen wurde 72 oeren lang opnij besocht. Jo kinne it geheim ferfange, in testbarren stjoere en elke levering besjen.

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.
}

Testmodus

Testkaaien (atly_test_…) berikke elk einpunt, mar wurkje op aparte testgegevens en jouwe fêste foarbyldresultaten werom: der draait gjin AI en der wurdt gjin tegoed brûkt. In testkaai sjocht nea live gegevens. Set in magyske wearde lykas __fail_credits__, __fail_consent__ of __slow__ yn in tekstfjild om dy flater of fertraging te krijen. DELETE /api/v1/test-data wisket alles wat in testkaai oanmakke hat.

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

Apps dy’t foar in Attorly-brûker optrede, logge yn mei OAuth 2.1: discovery op /.well-known/oauth-authorization-server, dynamyske kliïntregistraasje en de authorization code flow mei PKCE (S256). Freegje om resource=https://attorly.ai/api/v1 om in token foar de REST API te krijen; in token dat foar de MCP-server útjûn is, wurdt hjir wegere. Foegje offline_access ta om in refresh token te krijen. De persoan kiest de organisaasje en kin de scopes op it tastimmingsskerm beheine.

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

Fakturearring

Operaasjes dy’t AI brûke, geane ôf fan itselde AI-tegoed as de Attorly-app, út de beurs fan de eigner fan de kaai of fan syn organisaasje, oft jo se no fia REST of MCP oanroppe. As it tegoed op is, krije jo 402 insufficient_credits. Oproppen yn testmodus binne fergees.

Abonneminten

De API sit yn Pro en Enterprise. As it abonnemint fan de eigner fan de kaai gjin API-tagong mear befettet, of de eigner de organisaasje ferlitten hat, wurde fersiken wegere mei 403.

Referinsje

Elke operaasje, generearre út it OpenAPI-dokumint dat de API leveret. Paden binne relatyf oan https://attorly.ai. Slagge antwurden ferpakke it resultaat yn data. De beskriuwings fan de fjilden binne yn it Ingelsk.

Dokuminten

GET/api/v1/documentslistDocuments

Toan de bewarre dokuminten dy’t de kaai lêze kin, nijste earst.

Scope:DOCUMENTS_READ
Queryparameters
FjildTypeBeskriuwing
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

Laad in dokumint op as multipart/form-data, of as JSON mei base64-ynhâld of platte tekst. It wurdt op de eftergrûn analysearre, útsein as analyze false is.

Scope:DOCUMENTS_WRITEBrûkt AI-tegoedAkseptearret opladen bestannen
Ynhâld fan it fersyk
FjildTypeBeskriuwing
filenameferplichtstringThe 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
Antwurdgegevens (201)
FjildTypeBeskriuwing
idferplichtstring
nameferplichtstring
originalNameferplichtstring
typeferplicht"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …
sizeferplichtinteger
statusferplicht"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"PENDING until processing starts; ANALYZED once the analysis is stored
analysisQueuedferplichtbooleantrue when the background analysis was started
createdAtferplichtstringISO 8601 date-time
urlferplichtstringWhere 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

Sykje yn de tekst fan de dokuminten dy’t de kaai lêze kin, op betsjutting en op krekte wurden.

Scope:DOCUMENTS_READ
Queryparameters
FjildTypeBeskriuwing
queryferplichtstringWhat 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

Helje in dokumint op, mei de ferwurkingsstatus en de meast resinte analyze.

Scope:DOCUMENTS_READ
Paadparameters
FjildTypeBeskriuwing
documentIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstring
nameferplichtstring
originalNameferplichtstring
typeferplicht"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …
mimeTypeferplichtstring
sizeferplichtinteger
statusferplicht"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"PENDING until processing starts; ANALYZED once the analysis is stored
archivedferplichtboolean
ownedByYouferplichtboolean
versionNumberferplichtinteger | 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.
createdAtferplichtstringISO 8601 date-time
updatedAtferplichtstringISO 8601 date-time
fileAvailableferplichtbooleanfalse when the stored file can no longer be read
governingLawRequiredferplichtbooleantrue when the analysis is held until a governing law is chosen for the document in Attorly
latestAnalysisferplichtobject | null
urlferplichtstringWhere 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

Freegje om in dokumint fan jo te wiskjen. It dokumint wurdt pas wiske as jo it yn Attorly goedkarre.

Scope:DOCUMENTS_DELETE
Paadparameters
FjildTypeBeskriuwing
documentIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstring
deletedferplichtbooleantrue only when the document is gone
statusferplicht"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

Analysearje in dokumint of tekst yn it fersyk. mode is full (bewarre dokumint) of quick.

Scope:DOCUMENTS_ANALYZEDOCUMENTS_READBrûkt AI-tegoed

It fjild mode yn de ynhâld kiest ien fan: mode: full, mode: quick.

Ynhâld fan it fersyk
FjildTypeBeskriuwing
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

Toan de bewarre analyzes fan in dokumint, nijste earst.

Scope:DOCUMENTS_READ
Paadparameters
FjildTypeBeskriuwing
documentIdferplichtstring
Queryparameters
FjildTypeBeskriuwing
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

Analysearje in bewarre dokumint.

Scope:DOCUMENTS_ANALYZEDOCUMENTS_READBrûkt AI-tegoed
Paadparameters
FjildTypeBeskriuwing
documentIdferplichtstring

It fjild mode yn de ynhâld kiest ien fan: mode: full, mode: quick.

Ynhâld fan it fersyk
FjildTypeBeskriuwing
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

Helje de platte tekst út in bewarre PDF- of DOCX-dokumint.

Scope:DOCUMENTS_READ
Paadparameters
FjildTypeBeskriuwing
documentIdferplichtstring
Queryparameters
FjildTypeBeskriuwing
offsetintegerCharacter offset to start from; pass the nextOffset of the previous call to read on
maxCharactersintegerMost characters to return in this call
Antwurdgegevens (200)
FjildTypeBeskriuwing
textferplichtstringThe document text from offset (untrusted content)
documentNameferplichtstring
documentTypeferplichtstring
mimeTypeferplichtstring | null
characterCountferplichtintegerCharacters in the whole document
wordCountferplichtintegerWords in the whole document
offsetferplichtinteger
nextOffsetferplichtinteger | nullPass as offset to read on; null when the text ends here
truncatedferplichtbooleantrue 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

Helje in bewarre analyze op: gearfetting, risiko, wichtige betingsten, bepalings en oanbefellings.

Scope:DOCUMENTS_READ
Paadparameters
FjildTypeBeskriuwing
analysisIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstring
documentIdferplichtstring
documentNameferplichtstring
summaryferplichtstring | null
riskLevelferplicht"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
riskScoreferplichtnumber
keyTermsferplichtarray of any
clausesferplichtarray of any
recommendationsferplichtarray of any
modeferplichtstringSINGLE or CONSENSUS
createdAtferplichtstringISO 8601 date-time
urlferplichtstring
curl
curl "https://attorly.ai/api/v1/analyses/your_analysisId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/comparisonscreateComparison

Ferlykje twa dokuminten of teksten rigel foar rigel.

Scope:DOCUMENTS_READ
Ynhâld fan it fersyk
FjildTypeBeskriuwing
sourceDocumentIdstring
sourceContentstring
targetDocumentIdstring
targetContentstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
differencesferplichtarray of object
summaryferplichtobject
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"
}'

Bepalings

GET/api/v1/clausessearchClauses

Sykje yn de bepalingsbibleteek.

Scope:CLAUSES_READ
Queryparameters
FjildTypeBeskriuwing
queryferplichtstring
category"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …
jurisdictionstring
riskLevel"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
limitinteger
Antwurdgegevens (200)
FjildTypeBeskriuwing
clausesferplichtarray of object
countferplichtinteger
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

Beoardielje it risiko fan in bepaling.

Scope:CLAUSES_READ
Ynhâld fan it fersyk
FjildTypeBeskriuwing
clauseTextferplichtstring
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" | …
Antwurdgegevens (200)
FjildTypeBeskriuwing
clauseTextstring
clauseTypeferplichtstring
jurisdictionferplichtstring
overallRiskScoreferplichtnumber
riskLevelferplicht"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
riskFactorsferplichtarray of object
recommendationsferplichtarray 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

Ferlykje in bepaling mei marktkonforme formulearring.

Scope:CLAUSES_READ
Ynhâld fan it fersyk
FjildTypeBeskriuwing
clauseTextferplichtstring
categoryferplicht"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …
contractTypestring
jurisdictionstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
inputClauseferplichtstring
categoryferplichtstring
marketStandardsferplichtarray of object
comparisonferplichtobject
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

Kontrolearje in bepaling tsjin in playbook.

Scope:CLAUSES_READ
Ynhâld fan it fersyk
FjildTypeBeskriuwing
clauseTextferplichtstring
playbookIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
playbookNameferplichtstring
compliantferplichtboolean
violationsferplichtarray of string
warningsferplichtarray of string
rulesCheckedferplichtinteger
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"
}'

Ûndersyk

POST/api/v1/research/searchessearchResearch

Sykje yn juridyske boarnen lykas Lovdata, EUR-Lex en CourtListener.

Scope:RESEARCH_READBrûkt AI-tegoed
Ynhâld fan it fersyk
FjildTypeBeskriuwing
queryferplichtstring
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
Antwurdgegevens (200)
FjildTypeBeskriuwing
queryferplichtstring
jurisdictionferplichtstring
resultsferplichtarray of object
totalCountferplichtintegerResults 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

Sykje in wet op oan de hân fan de ferwizing.

Scope:RESEARCH_READBrûkt AI-tegoed
Queryparameters
FjildTypeBeskriuwing
citationferplichtstring
jurisdictionferplichtstringISO 3166-1 alpha-2 country code, or "EU"
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstring
titleferplichtstring
sourceferplichtstring
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"

Wizigingsfoarstellen

POST/api/v1/redlinescreateRedlines

Generearje wizigingsfoarstellen foar in dokumint of tekst.

Scope:REDLINES_GENERATEBrûkt AI-tegoed
Ynhâld fan it fersyk
FjildTypeBeskriuwing
documentIdstring
contentstring
partyRoleferplicht"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
Antwurdgegevens (200)
FjildTypeBeskriuwing
changesferplichtarray of object
summaryobject
negotiationNotesarray of string
statisticsferplichtobject
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

Akseptearje of wiis wizigingsfoarstellen yn in dokumint ôf.

Scope:REDLINES_GENERATE
Paadparameters
FjildTypeBeskriuwing
documentIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
changesferplichtarray of object
Antwurdgegevens (200)
FjildTypeBeskriuwing
acceptedferplichtinteger
rejectedferplichtinteger
messageferplichtstring
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"
    }
  ]
}'

Ûnderhannelings

POST/api/v1/negotiations/position-analysescreateNegotiationPositionAnalysis

Analysearje in ûnderhannelingsposysje.

Scope:NEGOTIATIONS_READBrûkt AI-tegoed
Ynhâld fan it fersyk
FjildTypeBeskriuwing
documentIdstring
contentstring
partyRoleferplicht"BUYER" | "SELLER" | "LANDLORD" | "TENANT" | "EMPLOYER" | "EMPLOYEE"
contextobject
Antwurdgegevens (200)
FjildTypeBeskriuwing
overallPositionferplichtstringFAVORABLE, BALANCED or UNFAVORABLE
positionsferplichtarray 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

Bou in ûnderhannelingsplaybook út in strategy.

Scope:NEGOTIATIONS_READBrûkt AI-tegoed
Ynhâld fan it fersyk
FjildTypeBeskriuwing
strategyferplichtobject
contextobject
Antwurdgegevens (200)
FjildTypeBeskriuwing
playbookferplichtarray of object
anticipatedObjectionsferplichtarray of object
recommendationsferplichtarray of string
summaryferplichtobject
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"
    ]
  }
}'

Workflows

GET/api/v1/workflows/templateslistWorkflowTemplates

Toan workflowsjabloanen.

Scope:WORKFLOWS_EXECUTE
Queryparameters
FjildTypeBeskriuwing
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

Toan workflowútfierings, nijste earst, as jo wolle foar ien projekt of status.

Scope:WORKFLOWS_EXECUTE
Queryparameters
FjildTypeBeskriuwing
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

Begjin in workflow op in due-diligenceprojekt.

Scope:WORKFLOWS_EXECUTEBrûkt AI-tegoed
Ynhâld fan it fersyk
FjildTypeBeskriuwing
templateIdferplichtstring
projectIdferplichtstring
inputsferplichtobject
optionsobject
Antwurdgegevens (202)
FjildTypeBeskriuwing
executionIdferplichtstring
templateIdferplichtstring
templateNameferplichtstring
statusferplichtstring
startedAtferplichtstringISO 8601 date-time
messageferplichtstring
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

Helje de status op fan in workflowútfiering.

Scope:WORKFLOWS_EXECUTE
Paadparameters
FjildTypeBeskriuwing
executionIdferplichtstring
Queryparameters
FjildTypeBeskriuwing
includeStepsboolean
Antwurdgegevens (200)
FjildTypeBeskriuwing
executionIdferplichtstring
templateNameferplichtstring
statusferplichtstring
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"

Due diligence

GET/api/v1/due-diligence/projectslistDueDiligenceProjects

Toan due-diligenceprojekten, nijste earst.

Scope:DUE_DILIGENCE_FULL
Queryparameters
FjildTypeBeskriuwing
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

Meitsje in due-diligenceprojekt oan.

Scope:DUE_DILIGENCE_FULL
Ynhâld fan it fersyk
FjildTypeBeskriuwing
nameferplichtstring
dealTypeferplicht"MA_ACQUISITION" | "MA_MERGER" | "INVESTMENT" | "IPO" | "REAL_ESTATE" | "REGULATORY" | …
targetCompanystring
descriptionstring
settingsobject
Antwurdgegevens (201)
FjildTypeBeskriuwing
projectIdferplichtstring
nameferplichtstring
projectTypeferplichtstring
statusferplichtstring
createdAtferplichtstringISO 8601 date-time
messageferplichtstring
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

Helje in due-diligenceprojekt op mei it tal dokuminten en befinings.

Scope:DUE_DILIGENCE_FULL
Paadparameters
FjildTypeBeskriuwing
projectIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstring
nameferplichtstring
descriptionferplichtstring | null
projectTypeferplichtstring
statusferplichtstring
priorityferplichtstring
targetCompanyferplichtstring | null
dueDateferplichtstring | null
documentCountferplichtinteger
findingCountferplichtinteger
createdAtferplichtstringISO 8601 date-time
updatedAtferplichtstringISO 8601 date-time
completedAtferplichtstring | 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

Foegje dokuminten ta oan in due-diligenceprojekt.

Scope:DUE_DILIGENCE_FULL
Paadparameters
FjildTypeBeskriuwing
projectIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
documentIdsferplichtarray of string
categorystring
Antwurdgegevens (200)
FjildTypeBeskriuwing
projectIdferplichtstring
documentsAddedferplichtinteger
totalDocumentsferplichtinteger
categoryferplichtstring
messageferplichtstring
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

Toan de befinings fan in due-diligenceprojekt.

Scope:DUE_DILIGENCE_FULL
Paadparameters
FjildTypeBeskriuwing
projectIdferplichtstring
Queryparameters
FjildTypeBeskriuwing
riskLevel"INFO" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
categorystring
limitinteger
Antwurdgegevens (200)
FjildTypeBeskriuwing
projectIdferplichtstring
projectNameferplichtstring
findingsferplichtarray of object
riskSummaryferplichtobjectNumber of findings per severity
totalFindingsferplichtinteger
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

Generearje in due-diligencerapport.

Scope:DUE_DILIGENCE_FULL
Paadparameters
FjildTypeBeskriuwing
projectIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
formatferplicht"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
Antwurdgegevens (201)
FjildTypeBeskriuwing
reportIdferplichtstring
projectIdferplichtstring
projectNamestring
formatferplicht"pdf" | "markdown"
statusferplichtstring
sectionsarray of string
documentCountinteger
findingCountinteger
markdownferplichtstring
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"
}'

Sjabloanen en konsepten

GET/api/v1/templateslistTemplates

Toan dokumintsjabloanen.

Scope:TEMPLATES_READ
Queryparameters
FjildTypeBeskriuwing
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

Meitsje in konsept oan út in sjabloan (mode template) of mei AI (mode ai).

Scope:TEMPLATES_DRAFTBrûkt AI-tegoed

It fjild mode yn de ynhâld kiest ien fan: mode: template, mode: ai.

Ynhâld fan it fersyk
FjildTypeBeskriuwing
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"
  }
}'

Saken

GET/api/v1/caseslistCases

Toan jo saken, de meast resint wizige earst.

Scope:CASES_READ
Queryparameters
FjildTypeBeskriuwing
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

Helje de tiidline fan in saak op: elk barren mei de datum, it bewiis en it stânpunt fan de tsjinpartij.

Scope:CASES_READ
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseferplichtobject
eventsferplichtarray of objectIn date order
countferplichtinteger
needsReviewCountferplichtintegerEvents an AI added that no person has confirmed
deletionRequestedCountferplichtintegerEvents 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

Foegje in barren ta oan de tiidline fan in saak.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
titleferplichtstringWhat happened, in one line (at most 300 characters)
descriptionstring | nullMore detail, or null to clear it
whenferplichtobjectWhen 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
Antwurdgegevens (201)
FjildTypeBeskriuwing
caseIdferplichtstring
eventferplichtobject
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

Wizigje in barren op de tiidline fan in saak, of befêstigje in barren dat in AI tafoege hat.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
eventIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
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
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseIdferplichtstring
eventferplichtobject
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

Freegje om in barren fan de tiidline fan in saak te wiskjen. It barren wurdt pas wiske as de eigner it yn Attorly goedkart.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
eventIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseIdferplichtstring
idferplichtstring
deletedferplichtbooleantrue only when the event is gone
statusferplicht"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

Eksportearje de tiidline fan in saak as PDF-, Word-, ODT-, Excel- of PowerPoint-bestân.

Scope:CASES_READ
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
layoutferplicht"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
formatferplicht"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
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseIdferplichtstring
layoutferplicht"overview" | "chronology" | "numbered" | "visual"
formatferplicht"pdf" | "docx" | "odt" | "xlsx" | "pptx"
localeferplichtstringThe language the file is written in
eventCountferplichtintegerEvents in the file
exhibitCountferplichtintegerDocuments in the exhibit list (chronology and numbered layouts)
leftOutConfidentialferplichtintegerEvents left out because they are marked confidential
attachmentferplichtobject
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

Toan de termyns fan in saak, de earstfolgjende earst, mei fan wa’t elke termyn is en oft er ôfhannele of ferstrutsen is.

Scope:CASES_READ
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Queryparameters
FjildTypeBeskriuwing
status"open" | "completed"open: not yet marked done; completed: marked done; both when absent
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseferplichtobject
deadlinesferplichtarray of objectSoonest first
countferplichtinteger
overdueCountferplichtinteger
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

Foegje in termyn ta oan in saak, op in bepaalde datum of teld fan in fêstleine feit ôf.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
titleferplichtstringWhat 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
Antwurdgegevens (201)
FjildTypeBeskriuwing
caseIdferplichtstring
deadlineferplichtobject
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

Wizigje in termyn yn in saak, of markearje him as ôfhannele of wer as iepen.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
deadlineIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
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
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseIdferplichtstring
deadlineferplichtobject
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

Toan de feiten dy’t yn in saak fêstlein binne, mei harren boarne, en de feiten dy’t de saak noch nedich hat.

Scope:CASES_READ
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseferplichtobject
factsferplichtarray of object
countferplichtinteger
caseReadsferplichtobject | 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

Lis in feit yn in saak fêst, of ferbetterje it. Termyns dy’t derfan ôf teld wurde, ferskowe mei.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
keyferplichtstringThe 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
valueferplichtstringThe 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)
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseIdferplichtstring
outcomeferplicht"recorded" | "corrected" | "unchanged"recorded: a new fact; corrected: a new value replaced the old one; unchanged: it already held this value
factferplichtobject
movedDeadlinesferplichtarray of objectOpen deadlines counted from the fact that moved with the correction, due days before and after
urlferplichtstringWhere 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

Toan de partijen fan in saak en de rollen dy’t de saak biedt.

Scope:CASES_READ
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseferplichtobject
partiesferplichtarray of object
countferplichtinteger
rolesferplichtarray 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

Foegje in partij ta oan in saak, yn ien fan de rollen.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
roleKeyferplichtstringThe role the party has in the case, as one of the roles parties_list returns (e.g. "landlord")
partyTypeferplicht"PERSON" | "ENTITY"PERSON for a person, ENTITY for a company or public body
nameferplichtstringThe 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
Antwurdgegevens (201)
FjildTypeBeskriuwing
caseIdferplichtstring
partyferplichtobject
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

Wizigje de gegevens fan in partij yn in saak.

Scope:CASES_WRITE
Paadparameters
FjildTypeBeskriuwing
caseIdferplichtstring
partyIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
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
Antwurdgegevens (200)
FjildTypeBeskriuwing
caseIdferplichtstring
partyferplichtobject
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)"

Operaasjes

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

Helje de status en it resultaat op fan in fersyk dat mei Prefer of Idempotency-Key stjoerd is.

Paadparameters
FjildTypeBeskriuwing
operationIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstringop_…
objectferplicht"operation"
operationIdferplichtstringThe REST operation that was called, e.g. createRedlines
statusferplicht"running" | "awaiting_approval" | "succeeded" | "failed"
livemodeferplichtboolean
idempotencyKeystring | null
resultUrlferplichtstringWhere to poll: /api/v1/operations/{id}
createdAtferplichtstring (date-time)
completedAtferplichtstring (date-time) | null
expiresAtferplichtstring (date-time)
httpStatusferplichtinteger | null
resultferplichtanyThe data of the successful call
metaobject
errorferplichtobject | null
curl
curl "https://attorly.ai/api/v1/operations/op_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

Webhooks

GET/api/v1/webhook-endpointslistWebhookEndpoints

Toan de webhook-einpunten fan de organisaasje en de modus fan de kaai.

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

Meitsje in webhook-einpunt oan. It antwurd befettet it ûndertekeningsgeheim, dat mar ien kear toand wurdt.

Ynhâld fan it fersyk
FjildTypeBeskriuwing
urlferplichtstring (uri)HTTPS URL that receives the events
descriptionstring
enabledEventsferplichtarray 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.
Antwurdgegevens (201)
FjildTypeBeskriuwing
idferplichtstringwe_…
objectferplicht"webhook_endpoint"
urlferplichtstring
descriptionstring | null
enabledEventsferplichtarray of string
statusferplicht"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeferplichtboolean
includeSnapshotsferplichtboolean
apiVersionferplichtstring
failingSincestring (date-time) | null
createdAtferplichtstring (date-time)
updatedAtferplichtstring (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

Helje in webhook-einpunt op.

Paadparameters
FjildTypeBeskriuwing
endpointIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstringwe_…
objectferplicht"webhook_endpoint"
urlferplichtstring
descriptionstring | null
enabledEventsferplichtarray of string
statusferplicht"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeferplichtboolean
includeSnapshotsferplichtboolean
apiVersionferplichtstring
failingSincestring (date-time) | null
createdAtferplichtstring (date-time)
updatedAtferplichtstring (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

Wizigje de URL, barrens of snapshots fan in einpunt, of skeakelje it út en wer yn.

Paadparameters
FjildTypeBeskriuwing
endpointIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
urlstring (uri)
descriptionstring | null
enabledEventsarray of string
includeSnapshotsboolean
status"enabled" | "disabled"Disable to pause deliveries; enable to resume
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstringwe_…
objectferplicht"webhook_endpoint"
urlferplichtstring
descriptionstring | null
enabledEventsferplichtarray of string
statusferplicht"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeferplichtboolean
includeSnapshotsferplichtboolean
apiVersionferplichtstring
failingSincestring (date-time) | null
createdAtferplichtstring (date-time)
updatedAtferplichtstring (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

Wiskje in webhook-einpunt en de leveringsskiednis dêrfan.

Paadparameters
FjildTypeBeskriuwing
endpointIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstring
objectferplicht"webhook_endpoint"
deletedferplichttrue
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

Ferfang it ûndertekeningsgeheim. It âlde bliuwt 24 oeren noch ûndertekenjen.

Paadparameters
FjildTypeBeskriuwing
endpointIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstringwe_…
objectferplicht"webhook_endpoint"
urlferplichtstring
descriptionstring | null
enabledEventsferplichtarray of string
statusferplicht"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeferplichtboolean
includeSnapshotsferplichtboolean
apiVersionferplichtstring
failingSincestring (date-time) | null
createdAtferplichtstring (date-time)
updatedAtferplichtstring (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

Stjoer in webhook_endpoint.test-barren allinnich nei dit einpunt.

Paadparameters
FjildTypeBeskriuwing
endpointIdferplichtstring
Antwurdgegevens (202)
FjildTypeBeskriuwing
eventIdferplichtstring
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

Toan de leveringen fan in einpunt, nijste earst, mei de besykjen en de útkomst.

Paadparameters
FjildTypeBeskriuwing
endpointIdferplichtstring
Queryparameters
FjildTypeBeskriuwing
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"

Barrens

GET/api/v1/eventslistEvents

Toan de barrens fan de lêste 30 dagen, nijste earst.

Queryparameters
FjildTypeBeskriuwing
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

Helje in barren op sa’t webhook-einpunten it ûntfange.

Paadparameters
FjildTypeBeskriuwing
eventIdferplichtstring
Antwurdgegevens (200)
FjildTypeBeskriuwing
idferplichtstringevt_… — also sent as the webhook-id header; deduplicate on it
objectferplicht"event"
typeferplicht"analysis.completed" | "analysis.failed" | "redlines.generated" | "due_diligence.report.completed" | "operation.succeeded" | "operation.failed" | …
apiVersionferplichtstring
createdAtferplichtstring (date-time)
livemodeferplichtboolean
dataferplichtobject
curl
curl "https://attorly.ai/api/v1/events/your_eventId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/events/{eventId}/redeliveriesredeliverEvent

Stjoer in barren opnij, nei ien einpunt of nei elk einpunt dat derop abonnearre is.

Paadparameters
FjildTypeBeskriuwing
eventIdferplichtstring
Ynhâld fan it fersyk
FjildTypeBeskriuwing
endpointIdstringOnly this endpoint; default every endpoint subscribed to the event
Antwurdgegevens (202)
FjildTypeBeskriuwing
eventIdferplichtstring
deliveriesScheduledferplichtinteger
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"
}'

Akkount, gebrûk en loggen

GET/api/v1/organizationgetOrganization

De organisaasje fan de kaai: abonnemint, AI-tegoed, standertjurisdiksje en wat de kaai dwaan mei.

Antwurdgegevens (200)
FjildTypeBeskriuwing
organizationferplichtobject
userferplichtobject
planferplichtstringSTANDARD, PRO or ENTERPRISE
billingferplichtobject
defaultJurisdictionferplichtstring | nullISO 3166-1 alpha-2 country used when a document names no governing law
credentialferplichtobject
appUrlferplichtstring
curl
curl "https://attorly.ai/api/v1/organization" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/usagegetUsage

Fersiken per dei, kaai en operaasje, mei it tal flaters, oer REST en MCP.

Queryparameters
FjildTypeBeskriuwing
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

Toan de API-fersiken fan de organisaasje fan de lêste 30 dagen, nijste earst.

Queryparameters
FjildTypeBeskriuwing
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

Wa wat oanroppen hat, wannear en mei hokker kaai. Foar eigners en behearders fan de organisaasje.

Queryparameters
FjildTypeBeskriuwing
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

Wiskje elk objekt, barren en operaasje yn testmodus fan de organisaasje. Allinnich testkaaien.

Antwurdgegevens (200)
FjildTypeBeskriuwing
objectferplicht"test_data_purge"
deletedferplichtobject
curl
curl -X DELETE "https://attorly.ai/api/v1/test-data" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"