Ves al contingut principal

Desenvolupadors

Documentació de l'API REST

Una API JSON sobre HTTPS per a la IA jurídica d'Attorly. Executa les mateixes operacions que el servidor MCP, amb les mateixes claus, àmbits, límits i facturació.

Inici ràpid

Puja un contracte i analitza'l en quatre passos.

  1. 1. Crea una clau

    Crea una clau a Configuració › Desenvolupadors i tria API REST. La mateixa clau serveix per al servidor MCP. Guarda-la en una variable d'entorn:

    bash
    export ATTORLY_API_KEY=lbmcp_your_api_key
  2. 2. Puja un document

    Envia el fitxer com a multipart/form-data. El data.id de la resposta és l'id del document. analyze=false el desa sense iniciar l'anàlisi en segon pla, perquè el pas següent n'executa una.

    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. Analitza'l

    Prefer: wait=30 espera fins a 30 segons el resultat. Una anàlisi acabada torna com a 200 amb el resultat a data. Si triga més, reps 202 Accepted amb una capçalera Location que apunta a l'operació.

    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. Recull el resultat

    Consulta l'operació periòdicament fins que l'estat sigui succeeded o failed. L'anàlisi és a result. Retry-After indica quants segons has d'esperar entre consultes.

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

Autenticació

Envia una credencial a la capçalera Authorization com a testimoni Bearer. Les claus de Configuració › Desenvolupadors comencen per lbmcp_ i funcionen a Pro i Enterprise, tant per a l'API REST com per al servidor MCP. Les claus d'organització d'Enterprise comencen per atly_ (atly_rk_ per a claus restringides, atly_test_ per al mode de prova); les claus lb_ antigues continuen funcionant. Les aplicacions que actuen en nom d'una persona fan servir OAuth.

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

Àmbits

Cada punt final necessita els àmbits que s'hi indiquen. Una clau que no els tingui rep 403 insufficient_scope, i requiredScopes a l'error llista tots els àmbits que necessita la crida. Les claus d'API d'organització i OAuth fan servir aquests noms d'àmbit:

ÀmbitÀmbit de la clau d'API d'organització
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

Errors

Tots els errors tenen la mateixa forma: un codi estable sobre el qual ramificar, un missatge per a les persones i un requestId per citar al suport.

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

Cada codi s'explica, amb què cal fer-ne, a la pàgina de codis d'error

Versions

L'API es versiona per data. Envia Attorly-Version per triar una versió per a una sola sol·licitud; sense ella, una sol·licitud fa servir la versió amb què es va crear la seva clau (les claus creades abans del versionat fan servir 2026-10-01). Cada resposta indica quina versió ha respost. Els canvis incompatibles només arriben amb una versió nova, i el registre de canvis els llista.

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

Idempotència

Envia una capçalera Idempotency-Key, per exemple un UUID, en les sol·licituds POST, PATCH i DELETE. Un reintent amb la mateixa clau i la mateixa sol·licitud retorna la primera resposta amb Idempotent-Replayed: true, i la feina no s'executa ni es factura de nou. Una clau reutilitzada per a una sol·licitud diferent rep 422 idempotency_key_reused, i una que encara s'està executant rep 409 o, en una crida de llarga durada, la mateixa operació. Els errors del servidor no es desen, de manera que el seu reintent s'executa de nou. Les claus es conserven durant 24 hores.

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

Sol·licituds de llarga durada

A partir de la versió 2026-11-01, les anàlisis completes, els redlines, els playbooks de negociació, els fluxos de treball, els informes de due diligence i els esborranys amb IA responen de seguida 202 Accepted amb una operació. Envia Prefer: wait=30 per esperar primer fins a 30 segons (com a màxim 60) el resultat, o Prefer: respond-async per demanar 202 en qualsevol escriptura. Consulta periòdicament el Location fins que l'estat sigui succeeded o failed, o subscriu-te a operation.succeeded. Els resultats es conserven durant 24 hores. Com a màxim s'executen 5 operacions d'IA de llarga durada alhora per organització; les addicionals reben 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", … } }

Paginació

Les llistes retornen { object: "list", data, hasMore, nextCursor } i accepten limit (d'1 a 100, per defecte 20) i cursor. Per obtenir la pàgina següent, envia nextCursor com a cursor. A l'última pàgina, nextCursor és null. Els cursors continuen sent vàlids mentre s'afegeixen elements nous.

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…

Límits de velocitat

Una sol·licitud compta en diverses finestres: el límit horari de la clau, 300 per minut per persona, 600 per minut per organització, un límit per minut per clau per a lectures, escriptures i crides d'IA, i el límit propi de cada operació. REST i MCP comparteixen els mateixos comptadors. Les capçaleres RateLimit-Policy i RateLimit mostren totes les finestres; X-RateLimit-* mostra la que s'està esgotant primer. Si se supera un límit, reps 429 amb 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

Crea un punt final amb POST /api/v1/webhook-endpoints perquè t'avisin quan acabi una feina, en lloc de consultar periòdicament. Attorly envia un POST amb un esdeveniment JSON i el signa segons Standard Webhooks amb el secret whsec_ del punt final. Verifica la signatura abans de fiar-te del cos, respon 2xx en 15 segons i desduplica per webhook-id: els lliuraments fallits es reintenten durant 72 hores. Pots renovar el secret, enviar un esdeveniment de prova i veure cada lliurament.

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

Mode de prova

Les claus de prova (atly_test_…) arriben a tots els punts finals, però treballen amb dades de prova separades i retornen resultats d'exemple fixos: no s'executa cap IA ni es consumeix cap crèdit. Una clau de prova no veu mai dades reals. Posa un valor màgic com __fail_credits__, __fail_consent__ o __slow__ a qualsevol camp de text per obtenir aquell error o aquella demora. DELETE /api/v1/test-data esborra tot el que ha creat una clau de prova.

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

Les aplicacions que actuen en nom d'un usuari d'Attorly inicien la sessió amb OAuth 2.1: descobriment a /.well-known/oauth-authorization-server, registre dinàmic de clients i flux de codi d'autorització amb PKCE (S256). Demana resource=https://attorly.ai/api/v1 per obtenir un testimoni per a l'API REST; aquí es rebutja un testimoni emès per al servidor MCP. Afegeix offline_access per obtenir un testimoni d'actualització. La persona tria l'organització i pot restringir els àmbits a la pantalla de consentiment.

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

Facturació

Les operacions que executen IA consumeixen els mateixos crèdits d'IA que l'aplicació Attorly, de la cartera del propietari de la clau o de la seva organització, tant si les crides per REST com per MCP. Quan s'esgoten els crèdits, reps 402 insufficient_credits. Les crides en mode de prova són gratuïtes.

Plans

L'API s'inclou a Pro i Enterprise. Si el pla del propietari de la clau ja no inclou l'accés a l'API, o el propietari ha deixat l'organització, les sol·licituds es rebutgen amb 403.

Referència

Cada operació, generada a partir del document OpenAPI que serveix l'API. Les rutes són relatives a https://attorly.ai. Les respostes correctes inclouen el resultat a data. Les descripcions dels camps són en anglès.

Documents

GET/api/v1/documentslistDocuments

Llista els documents desats que la clau pot llegir, del més recent al més antic.

Àmbit:DOCUMENTS_READ
Paràmetres de consulta
CampTipusDescripció
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

Puja un document com a multipart/form-data, o com a JSON amb contingut en base64 o text pla. S'analitza en segon pla tret que analyze sigui false.

Àmbit:DOCUMENTS_WRITEConsumeix crèdits d'IAAccepta pujades de fitxers
Cos de la sol·licitud
CampTipusDescripció
filenameobligatoristringThe 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
Dades de la resposta (201)
CampTipusDescripció
idobligatoristring
nameobligatoristring
originalNameobligatoristring
typeobligatori"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …
sizeobligatoriinteger
statusobligatori"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"PENDING until processing starts; ANALYZED once the analysis is stored
analysisQueuedobligatoribooleantrue when the background analysis was started
createdAtobligatoristringISO 8601 date-time
urlobligatoristringWhere 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

Cerca al text dels documents que la clau pot llegir, per significat i per paraules exactes.

Àmbit:DOCUMENTS_READ
Paràmetres de consulta
CampTipusDescripció
queryobligatoristringWhat 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

Obté un document, el seu estat de processament i la darrera anàlisi.

Àmbit:DOCUMENTS_READ
Paràmetres de ruta
CampTipusDescripció
documentIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristring
nameobligatoristring
originalNameobligatoristring
typeobligatori"EMPLOYMENT_CONTRACT" | "LEASE_AGREEMENT" | "PURCHASE_AGREEMENT" | "NDA" | "TERMS_OF_SERVICE" | "EMAIL" | …
mimeTypeobligatoristring
sizeobligatoriinteger
statusobligatori"PENDING" | "PROCESSING" | "ANALYZED" | "FAILED"PENDING until processing starts; ANALYZED once the analysis is stored
archivedobligatoriboolean
ownedByYouobligatoriboolean
versionNumberobligatoriinteger | 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.
createdAtobligatoristringISO 8601 date-time
updatedAtobligatoristringISO 8601 date-time
fileAvailableobligatoribooleanfalse when the stored file can no longer be read
governingLawRequiredobligatoribooleantrue when the analysis is held until a governing law is chosen for the document in Attorly
latestAnalysisobligatoriobject | null
urlobligatoristringWhere 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

Demana suprimir un document del qual ets propietari. El document només se suprimeix quan l'aproves a Attorly.

Àmbit:DOCUMENTS_DELETE
Paràmetres de ruta
CampTipusDescripció
documentIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristring
deletedobligatoribooleantrue only when the document is gone
statusobligatori"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

Analitza un document o un text en línia. mode és full (document desat) o quick.

Àmbit:DOCUMENTS_ANALYZEDOCUMENTS_READConsumeix crèdits d'IA

El camp mode del cos tria un de: mode: full, mode: quick.

Cos de la sol·licitud
CampTipusDescripció
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

Llista les anàlisis desades d'un document, de la més recent a la més antiga.

Àmbit:DOCUMENTS_READ
Paràmetres de ruta
CampTipusDescripció
documentIdobligatoristring
Paràmetres de consulta
CampTipusDescripció
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

Analitza un document desat.

Àmbit:DOCUMENTS_ANALYZEDOCUMENTS_READConsumeix crèdits d'IA
Paràmetres de ruta
CampTipusDescripció
documentIdobligatoristring

El camp mode del cos tria un de: mode: full, mode: quick.

Cos de la sol·licitud
CampTipusDescripció
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

Extreu el text pla d'un document PDF o DOCX desat.

Àmbit:DOCUMENTS_READ
Paràmetres de ruta
CampTipusDescripció
documentIdobligatoristring
Paràmetres de consulta
CampTipusDescripció
offsetintegerCharacter offset to start from; pass the nextOffset of the previous call to read on
maxCharactersintegerMost characters to return in this call
Dades de la resposta (200)
CampTipusDescripció
textobligatoristringThe document text from offset (untrusted content)
documentNameobligatoristring
documentTypeobligatoristring
mimeTypeobligatoristring | null
characterCountobligatoriintegerCharacters in the whole document
wordCountobligatoriintegerWords in the whole document
offsetobligatoriinteger
nextOffsetobligatoriinteger | nullPass as offset to read on; null when the text ends here
truncatedobligatoribooleantrue 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

Obté una anàlisi desada: resum, risc, termes clau, clàusules i recomanacions.

Àmbit:DOCUMENTS_READ
Paràmetres de ruta
CampTipusDescripció
analysisIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristring
documentIdobligatoristring
documentNameobligatoristring
summaryobligatoristring | null
riskLevelobligatori"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
riskScoreobligatorinumber
keyTermsobligatoriarray of any
clausesobligatoriarray of any
recommendationsobligatoriarray of any
modeobligatoristringSINGLE or CONSENSUS
createdAtobligatoristringISO 8601 date-time
urlobligatoristring
curl
curl "https://attorly.ai/api/v1/analyses/your_analysisId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/comparisonscreateComparison

Compara dos documents o textos línia per línia.

Àmbit:DOCUMENTS_READ
Cos de la sol·licitud
CampTipusDescripció
sourceDocumentIdstring
sourceContentstring
targetDocumentIdstring
targetContentstring
Dades de la resposta (200)
CampTipusDescripció
differencesobligatoriarray of object
summaryobligatoriobject
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àusules

GET/api/v1/clausessearchClauses

Cerca a la biblioteca de clàusules.

Àmbit:CLAUSES_READ
Paràmetres de consulta
CampTipusDescripció
queryobligatoristring
category"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …
jurisdictionstring
riskLevel"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
limitinteger
Dades de la resposta (200)
CampTipusDescripció
clausesobligatoriarray of object
countobligatoriinteger
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

Avalua el risc d'una clàusula.

Àmbit:CLAUSES_READ
Cos de la sol·licitud
CampTipusDescripció
clauseTextobligatoristring
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" | …
Dades de la resposta (200)
CampTipusDescripció
clauseTextstring
clauseTypeobligatoristring
jurisdictionobligatoristring
overallRiskScoreobligatorinumber
riskLevelobligatori"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
riskFactorsobligatoriarray of object
recommendationsobligatoriarray 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

Compara una clàusula amb el redactat habitual al mercat.

Àmbit:CLAUSES_READ
Cos de la sol·licitud
CampTipusDescripció
clauseTextobligatoristring
categoryobligatori"INDEMNIFICATION" | "LIABILITY" | "TERMINATION" | "CONFIDENTIALITY" | "INTELLECTUAL_PROPERTY" | "PAYMENT" | …
contractTypestring
jurisdictionstring
Dades de la resposta (200)
CampTipusDescripció
inputClauseobligatoristring
categoryobligatoristring
marketStandardsobligatoriarray of object
comparisonobligatoriobject
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

Comprova una clàusula amb un playbook.

Àmbit:CLAUSES_READ
Cos de la sol·licitud
CampTipusDescripció
clauseTextobligatoristring
playbookIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
playbookNameobligatoristring
compliantobligatoriboolean
violationsobligatoriarray of string
warningsobligatoriarray of string
rulesCheckedobligatoriinteger
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"
}'

Recerca

POST/api/v1/research/searchessearchResearch

Cerca fonts jurídiques com Lovdata, EUR-Lex i CourtListener.

Àmbit:RESEARCH_READConsumeix crèdits d'IA
Cos de la sol·licitud
CampTipusDescripció
queryobligatoristring
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
Dades de la resposta (200)
CampTipusDescripció
queryobligatoristring
jurisdictionobligatoristring
resultsobligatoriarray of object
totalCountobligatoriintegerResults 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

Consulta una llei per la seva cita.

Àmbit:RESEARCH_READConsumeix crèdits d'IA
Paràmetres de consulta
CampTipusDescripció
citationobligatoristring
jurisdictionobligatoristringISO 3166-1 alpha-2 country code, or "EU"
Dades de la resposta (200)
CampTipusDescripció
idobligatoristring
titleobligatoristring
sourceobligatoristring
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"

Redlines

POST/api/v1/redlinescreateRedlines

Genera suggeriments de redline per a un document o un text.

Àmbit:REDLINES_GENERATEConsumeix crèdits d'IA
Cos de la sol·licitud
CampTipusDescripció
documentIdstring
contentstring
partyRoleobligatori"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
Dades de la resposta (200)
CampTipusDescripció
changesobligatoriarray of object
summaryobject
negotiationNotesarray of string
statisticsobligatoriobject
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

Accepta o rebutja els canvis de redline d'un document.

Àmbit:REDLINES_GENERATE
Paràmetres de ruta
CampTipusDescripció
documentIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
changesobligatoriarray of object
Dades de la resposta (200)
CampTipusDescripció
acceptedobligatoriinteger
rejectedobligatoriinteger
messageobligatoristring
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"
    }
  ]
}'

Negociacions

POST/api/v1/negotiations/position-analysescreateNegotiationPositionAnalysis

Analitza una posició de negociació.

Àmbit:NEGOTIATIONS_READConsumeix crèdits d'IA
Cos de la sol·licitud
CampTipusDescripció
documentIdstring
contentstring
partyRoleobligatori"BUYER" | "SELLER" | "LANDLORD" | "TENANT" | "EMPLOYER" | "EMPLOYEE"
contextobject
Dades de la resposta (200)
CampTipusDescripció
overallPositionobligatoristringFAVORABLE, BALANCED or UNFAVORABLE
positionsobligatoriarray 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

Construeix un playbook de negociació a partir d'una estratègia.

Àmbit:NEGOTIATIONS_READConsumeix crèdits d'IA
Cos de la sol·licitud
CampTipusDescripció
strategyobligatoriobject
contextobject
Dades de la resposta (200)
CampTipusDescripció
playbookobligatoriarray of object
anticipatedObjectionsobligatoriarray of object
recommendationsobligatoriarray of string
summaryobligatoriobject
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"
    ]
  }
}'

Fluxos de treball

GET/api/v1/workflows/templateslistWorkflowTemplates

Llista les plantilles de flux de treball.

Àmbit:WORKFLOWS_EXECUTE
Paràmetres de consulta
CampTipusDescripció
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

Llista les execucions de fluxos de treball, de la més recent a la més antiga, opcionalment d'un projecte o estat.

Àmbit:WORKFLOWS_EXECUTE
Paràmetres de consulta
CampTipusDescripció
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

Inicia un flux de treball en un projecte de due diligence.

Àmbit:WORKFLOWS_EXECUTEConsumeix crèdits d'IA
Cos de la sol·licitud
CampTipusDescripció
templateIdobligatoristring
projectIdobligatoristring
inputsobligatoriobject
optionsobject
Dades de la resposta (202)
CampTipusDescripció
executionIdobligatoristring
templateIdobligatoristring
templateNameobligatoristring
statusobligatoristring
startedAtobligatoristringISO 8601 date-time
messageobligatoristring
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

Obté l'estat d'una execució d'un flux de treball.

Àmbit:WORKFLOWS_EXECUTE
Paràmetres de ruta
CampTipusDescripció
executionIdobligatoristring
Paràmetres de consulta
CampTipusDescripció
includeStepsboolean
Dades de la resposta (200)
CampTipusDescripció
executionIdobligatoristring
templateNameobligatoristring
statusobligatoristring
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

Llista els projectes de due diligence, del més recent al més antic.

Àmbit:DUE_DILIGENCE_FULL
Paràmetres de consulta
CampTipusDescripció
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

Crea un projecte de due diligence.

Àmbit:DUE_DILIGENCE_FULL
Cos de la sol·licitud
CampTipusDescripció
nameobligatoristring
dealTypeobligatori"MA_ACQUISITION" | "MA_MERGER" | "INVESTMENT" | "IPO" | "REAL_ESTATE" | "REGULATORY" | …
targetCompanystring
descriptionstring
settingsobject
Dades de la resposta (201)
CampTipusDescripció
projectIdobligatoristring
nameobligatoristring
projectTypeobligatoristring
statusobligatoristring
createdAtobligatoristringISO 8601 date-time
messageobligatoristring
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

Obté un projecte de due diligence amb el recompte de documents i troballes.

Àmbit:DUE_DILIGENCE_FULL
Paràmetres de ruta
CampTipusDescripció
projectIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristring
nameobligatoristring
descriptionobligatoristring | null
projectTypeobligatoristring
statusobligatoristring
priorityobligatoristring
targetCompanyobligatoristring | null
dueDateobligatoristring | null
documentCountobligatoriinteger
findingCountobligatoriinteger
createdAtobligatoristringISO 8601 date-time
updatedAtobligatoristringISO 8601 date-time
completedAtobligatoristring | 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

Afegeix documents a un projecte de due diligence.

Àmbit:DUE_DILIGENCE_FULL
Paràmetres de ruta
CampTipusDescripció
projectIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
documentIdsobligatoriarray of string
categorystring
Dades de la resposta (200)
CampTipusDescripció
projectIdobligatoristring
documentsAddedobligatoriinteger
totalDocumentsobligatoriinteger
categoryobligatoristring
messageobligatoristring
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

Llista les troballes d'un projecte de due diligence.

Àmbit:DUE_DILIGENCE_FULL
Paràmetres de ruta
CampTipusDescripció
projectIdobligatoristring
Paràmetres de consulta
CampTipusDescripció
riskLevel"INFO" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL"
categorystring
limitinteger
Dades de la resposta (200)
CampTipusDescripció
projectIdobligatoristring
projectNameobligatoristring
findingsobligatoriarray of object
riskSummaryobligatoriobjectNumber of findings per severity
totalFindingsobligatoriinteger
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

Genera un informe de due diligence.

Àmbit:DUE_DILIGENCE_FULL
Paràmetres de ruta
CampTipusDescripció
projectIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
formatobligatori"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
Dades de la resposta (201)
CampTipusDescripció
reportIdobligatoristring
projectIdobligatoristring
projectNamestring
formatobligatori"pdf" | "markdown"
statusobligatoristring
sectionsarray of string
documentCountinteger
findingCountinteger
markdownobligatoristring
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"
}'

Plantilles i esborranys

GET/api/v1/templateslistTemplates

Llista les plantilles de documents.

Àmbit:TEMPLATES_READ
Paràmetres de consulta
CampTipusDescripció
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

Crea un esborrany a partir d'una plantilla (mode template) o amb IA (mode ai).

Àmbit:TEMPLATES_DRAFTConsumeix crèdits d'IA

El camp mode del cos tria un de: mode: template, mode: ai.

Cos de la sol·licitud
CampTipusDescripció
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"
  }
}'

Casos

GET/api/v1/caseslistCases

Llista els teus casos, els modificats més recentment primer.

Àmbit:CASES_READ
Paràmetres de consulta
CampTipusDescripció
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

Obté la cronologia d'un cas: cada esdeveniment amb la seva data, les proves i la posició de l'altra part.

Àmbit:CASES_READ
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
caseobligatoriobject
eventsobligatoriarray of objectIn date order
countobligatoriinteger
needsReviewCountobligatoriintegerEvents an AI added that no person has confirmed
deletionRequestedCountobligatoriintegerEvents 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

Afegeix un esdeveniment a la cronologia d'un cas.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
titleobligatoristringWhat happened, in one line (at most 300 characters)
descriptionstring | nullMore detail, or null to clear it
whenobligatoriobjectWhen 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
Dades de la resposta (201)
CampTipusDescripció
caseIdobligatoristring
eventobligatoriobject
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

Canvia un esdeveniment de la cronologia d'un cas, o confirma'n un que ha afegit una IA.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
eventIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
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
Dades de la resposta (200)
CampTipusDescripció
caseIdobligatoristring
eventobligatoriobject
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

Demana suprimir un esdeveniment de la cronologia d'un cas. L'esdeveniment només se suprimeix quan el propietari l'aprova a Attorly.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
eventIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
caseIdobligatoristring
idobligatoristring
deletedobligatoribooleantrue only when the event is gone
statusobligatori"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

Exporta la cronologia d'un cas com a fitxer PDF, Word, ODT, Excel o PowerPoint.

Àmbit:CASES_READ
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
layoutobligatori"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
formatobligatori"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
Dades de la resposta (200)
CampTipusDescripció
caseIdobligatoristring
layoutobligatori"overview" | "chronology" | "numbered" | "visual"
formatobligatori"pdf" | "docx" | "odt" | "xlsx" | "pptx"
localeobligatoristringThe language the file is written in
eventCountobligatoriintegerEvents in the file
exhibitCountobligatoriintegerDocuments in the exhibit list (chronology and numbered layouts)
leftOutConfidentialobligatoriintegerEvents left out because they are marked confidential
attachmentobligatoriobject
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

Llista els terminis d'un cas, el més proper primer, amb de qui és cada termini i si està complert o vençut.

Àmbit:CASES_READ
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Paràmetres de consulta
CampTipusDescripció
status"open" | "completed"open: not yet marked done; completed: marked done; both when absent
Dades de la resposta (200)
CampTipusDescripció
caseobligatoriobject
deadlinesobligatoriarray of objectSoonest first
countobligatoriinteger
overdueCountobligatoriinteger
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

Afegeix un termini a un cas, en una data concreta o comptat a partir d'un fet registrat.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
titleobligatoristringWhat 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
Dades de la resposta (201)
CampTipusDescripció
caseIdobligatoristring
deadlineobligatoriobject
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

Canvia un termini d'un cas, o marca'l com a complert o torna'l a obrir.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
deadlineIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
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
Dades de la resposta (200)
CampTipusDescripció
caseIdobligatoristring
deadlineobligatoriobject
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

Llista els fets registrats en un cas, amb la seva font, i els fets que el cas encara necessita.

Àmbit:CASES_READ
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
caseobligatoriobject
factsobligatoriarray of object
countobligatoriinteger
caseReadsobligatoriobject | 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

Registra un fet en un cas, o corregeix-lo. Els terminis comptats a partir d'ell es mouen amb ell.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
keyobligatoristringThe 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
valueobligatoristringThe 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)
Dades de la resposta (200)
CampTipusDescripció
caseIdobligatoristring
outcomeobligatori"recorded" | "corrected" | "unchanged"recorded: a new fact; corrected: a new value replaced the old one; unchanged: it already held this value
factobligatoriobject
movedDeadlinesobligatoriarray of objectOpen deadlines counted from the fact that moved with the correction, due days before and after
urlobligatoristringWhere 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

Llista les parts d'un cas i els rols que ofereix el cas.

Àmbit:CASES_READ
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
caseobligatoriobject
partiesobligatoriarray of object
countobligatoriinteger
rolesobligatoriarray 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

Afegeix una part a un cas, en un dels seus rols.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
roleKeyobligatoristringThe role the party has in the case, as one of the roles parties_list returns (e.g. "landlord")
partyTypeobligatori"PERSON" | "ENTITY"PERSON for a person, ENTITY for a company or public body
nameobligatoristringThe 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
Dades de la resposta (201)
CampTipusDescripció
caseIdobligatoristring
partyobligatoriobject
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

Canvia les dades d'una part en un cas.

Àmbit:CASES_WRITE
Paràmetres de ruta
CampTipusDescripció
caseIdobligatoristring
partyIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
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
Dades de la resposta (200)
CampTipusDescripció
caseIdobligatoristring
partyobligatoriobject
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)"

Operacions

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

Obté l'estat i el resultat d'una sol·licitud enviada amb Prefer o Idempotency-Key.

Paràmetres de ruta
CampTipusDescripció
operationIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristringop_…
objectobligatori"operation"
operationIdobligatoristringThe REST operation that was called, e.g. createRedlines
statusobligatori"running" | "awaiting_approval" | "succeeded" | "failed"
livemodeobligatoriboolean
idempotencyKeystring | null
resultUrlobligatoristringWhere to poll: /api/v1/operations/{id}
createdAtobligatoristring (date-time)
completedAtobligatoristring (date-time) | null
expiresAtobligatoristring (date-time)
httpStatusobligatoriinteger | null
resultobligatorianyThe data of the successful call
metaobject
errorobligatoriobject | null
curl
curl "https://attorly.ai/api/v1/operations/op_abc123" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

Webhooks

GET/api/v1/webhook-endpointslistWebhookEndpoints

Llista els punts finals de webhook de l'organització i el mode de la clau.

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

Crea un punt final de webhook. La resposta conté el secret de signatura, que només es mostra una vegada.

Cos de la sol·licitud
CampTipusDescripció
urlobligatoristring (uri)HTTPS URL that receives the events
descriptionstring
enabledEventsobligatoriarray 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.
Dades de la resposta (201)
CampTipusDescripció
idobligatoristringwe_…
objectobligatori"webhook_endpoint"
urlobligatoristring
descriptionstring | null
enabledEventsobligatoriarray of string
statusobligatori"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeobligatoriboolean
includeSnapshotsobligatoriboolean
apiVersionobligatoristring
failingSincestring (date-time) | null
createdAtobligatoristring (date-time)
updatedAtobligatoristring (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

Obté un punt final de webhook.

Paràmetres de ruta
CampTipusDescripció
endpointIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristringwe_…
objectobligatori"webhook_endpoint"
urlobligatoristring
descriptionstring | null
enabledEventsobligatoriarray of string
statusobligatori"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeobligatoriboolean
includeSnapshotsobligatoriboolean
apiVersionobligatoristring
failingSincestring (date-time) | null
createdAtobligatoristring (date-time)
updatedAtobligatoristring (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

Canvia l'URL, els esdeveniments o les instantànies d'un punt final, o desactiva'l i activa'l.

Paràmetres de ruta
CampTipusDescripció
endpointIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
urlstring (uri)
descriptionstring | null
enabledEventsarray of string
includeSnapshotsboolean
status"enabled" | "disabled"Disable to pause deliveries; enable to resume
Dades de la resposta (200)
CampTipusDescripció
idobligatoristringwe_…
objectobligatori"webhook_endpoint"
urlobligatoristring
descriptionstring | null
enabledEventsobligatoriarray of string
statusobligatori"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeobligatoriboolean
includeSnapshotsobligatoriboolean
apiVersionobligatoristring
failingSincestring (date-time) | null
createdAtobligatoristring (date-time)
updatedAtobligatoristring (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

Suprimeix un punt final de webhook i el seu historial de lliuraments.

Paràmetres de ruta
CampTipusDescripció
endpointIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristring
objectobligatori"webhook_endpoint"
deletedobligatoritrue
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

Substitueix el secret de signatura. L'antic continua signant durant 24 hores.

Paràmetres de ruta
CampTipusDescripció
endpointIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristringwe_…
objectobligatori"webhook_endpoint"
urlobligatoristring
descriptionstring | null
enabledEventsobligatoriarray of string
statusobligatori"enabled" | "disabled"
disabledReasonstring | nulldisabled_by_user or failing_deliveries
livemodeobligatoriboolean
includeSnapshotsobligatoriboolean
apiVersionobligatoristring
failingSincestring (date-time) | null
createdAtobligatoristring (date-time)
updatedAtobligatoristring (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

Envia un esdeveniment webhook_endpoint.test només a aquest punt final.

Paràmetres de ruta
CampTipusDescripció
endpointIdobligatoristring
Dades de la resposta (202)
CampTipusDescripció
eventIdobligatoristring
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

Llista els lliuraments d'un punt final, del més recent al més antic, amb els intents i el resultat.

Paràmetres de ruta
CampTipusDescripció
endpointIdobligatoristring
Paràmetres de consulta
CampTipusDescripció
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"

Esdeveniments

GET/api/v1/eventslistEvents

Llista els esdeveniments dels últims 30 dies, del més recent al més antic.

Paràmetres de consulta
CampTipusDescripció
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

Obté un esdeveniment tal com el reben els punts finals de webhook.

Paràmetres de ruta
CampTipusDescripció
eventIdobligatoristring
Dades de la resposta (200)
CampTipusDescripció
idobligatoristringevt_… — also sent as the webhook-id header; deduplicate on it
objectobligatori"event"
typeobligatori"analysis.completed" | "analysis.failed" | "redlines.generated" | "due_diligence.report.completed" | "operation.succeeded" | "operation.failed" | …
apiVersionobligatoristring
createdAtobligatoristring (date-time)
livemodeobligatoriboolean
dataobligatoriobject
curl
curl "https://attorly.ai/api/v1/events/your_eventId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
POST/api/v1/events/{eventId}/redeliveriesredeliverEvent

Torna a enviar un esdeveniment, a un punt final o a tots els que hi estan subscrits.

Paràmetres de ruta
CampTipusDescripció
eventIdobligatoristring
Cos de la sol·licitud
CampTipusDescripció
endpointIdstringOnly this endpoint; default every endpoint subscribed to the event
Dades de la resposta (202)
CampTipusDescripció
eventIdobligatoristring
deliveriesScheduledobligatoriinteger
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"
}'

Compte, ús i registres

GET/api/v1/organizationgetOrganization

L'organització de la clau: pla, crèdits d'IA, jurisdicció per defecte i què pot fer la clau.

Dades de la resposta (200)
CampTipusDescripció
organizationobligatoriobject
userobligatoriobject
planobligatoristringSTANDARD, PRO or ENTERPRISE
billingobligatoriobject
defaultJurisdictionobligatoristring | nullISO 3166-1 alpha-2 country used when a document names no governing law
credentialobligatoriobject
appUrlobligatoristring
curl
curl "https://attorly.ai/api/v1/organization" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
GET/api/v1/usagegetUsage

Sol·licituds per dia, clau i operació, amb el recompte d'errors, per REST i MCP.

Paràmetres de consulta
CampTipusDescripció
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

Llista les sol·licituds d'API de l'organització dels últims 30 dies, de la més recent a la més antiga.

Paràmetres de consulta
CampTipusDescripció
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

Qui ha cridat què, quan i amb quina clau. Per als propietaris i administradors de l'organització.

Paràmetres de consulta
CampTipusDescripció
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

Suprimeix tots els objectes, esdeveniments i operacions en mode de prova de l'organització. Només claus de prova.

Dades de la resposta (200)
CampTipusDescripció
objectobligatori"test_data_purge"
deletedobligatoriobject
curl
curl -X DELETE "https://attorly.ai/api/v1/test-data" \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"