Developers

REST API documentation

A JSON-over-HTTPS API for Attorly's legal AI. It runs the same operations as the MCP server, with the same keys, scopes, limits and billing.

Create a key openapi.json Changelog

Quickstart

Upload a contract and analyse it in four steps.

1. Create a key
Create a key in Settings › Developers and choose REST API. The same key works for the MCP server. Keep it in an environment variable:
bash
```
export ATTORLY_API_KEY=lbmcp_your_api_key
```
2. Upload a document
Send the file as multipart/form-data. The response's data.id is the document's id. analyze=false stores it without starting the background analysis, because the next step runs one.
bash
```
curl -X POST https://attorly.ai/api/v1/documents \
  -H "Authorization: Bearer $ATTORLY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@nda.pdf" \
  -F "type=NDA" \
  -F "analyze=false"
```

3. Analyse it

Prefer: wait=30 waits up to 30 seconds for the result. A finished analysis comes back as 200 with the result in data. If it takes longer, you get 202 Accepted with a Location header pointing to the operation.

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. Collect the result
Poll the operation until its status is succeeded or failed. The analysis is in result. Retry-After says how many seconds to wait between polls.
bash
```
curl https://attorly.ai/api/v1/operations/$OPERATION_ID \
  -H "Authorization: Bearer $ATTORLY_API_KEY"
```

Authentication

Send a credential in the Authorization header as a Bearer token. Keys from Settings › Developers start with lbmcp_ and work on Pro and Enterprise, for the REST API and the MCP server alike. Enterprise organization keys start with atly_ (atly_rk_ for restricted keys, atly_test_ for test mode); older lb_ keys keep working. Apps that act for a person use OAuth.

http

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

Scopes

Each endpoint needs the scopes listed next to it. A key without them gets 403 insufficient_scope, and requiredScopes in the error lists every scope the call needs. Organization API keys and OAuth use these scope names:

Scope	Organization API key scope
`DOCUMENTS_READ`	`documents:read`
`DOCUMENTS_WRITE`	`documents:write`
`DOCUMENTS_DELETE`	`documents:delete`
`DOCUMENTS_ANALYZE`	`analysis:create`
`CLAUSES_READ`	`clauses:read`
`RESEARCH_READ`	`research:read`
`REDLINES_GENERATE`	`redlines:write`
`NEGOTIATIONS_READ`	`negotiations:read`
`WORKFLOWS_EXECUTE`	`workflows:execute`
`DUE_DILIGENCE_FULL`	`due-diligence:write`
`TEMPLATES_READ`	`templates:read`
`TEMPLATES_DRAFT`	`drafts:write`

Errors

Every error has the same shape: a stable code to branch on, a message for people, and a requestId to quote to support.

http

HTTP/1.1 403 Forbidden
Content-Type: application/json
Request-Id: req_7Hq2LmN4pX9sT1vB3cD5eF6g
Attorly-Version: 2026-11-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"
  }
}

Each code is explained, with what to do about it, on the error codes page

Versioning

The API is versioned by date. Send Attorly-Version to choose a version for one request; without it, a request uses the version its key was created with (keys created before versioning use 2026-10-01). Every response says which version answered. Breaking changes only come in a new version, and the changelog lists them.

http

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

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

Idempotency

Send an Idempotency-Key header, for example a UUID, on POST, PATCH and DELETE requests. A retry with the same key and the same request gets the first response back with Idempotent-Replayed: true, and the work is not run or billed again. A key reused for a different request gets 422 idempotency_key_reused, and one still running gets 409 or, for a long-running call, the same operation. Server errors are not stored, so their retry runs again. Keys are kept for 24 hours.

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

Long-running requests

From version 2026-11-01, full analyses, redlines, negotiation playbooks, workflows, due diligence reports and AI drafts answer 202 Accepted with an operation at once. Send Prefer: wait=30 to wait up to 30 seconds (at most 60) for the result first, or Prefer: respond-async to ask for 202 on any write. Poll the Location until status is succeeded or failed, or subscribe to operation.succeeded. Results are kept for 24 hours. At most 5 long-running AI operations run per organization at a time; more get 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", … } }

Pagination

Lists return { object: "list", data, hasMore, nextCursor } and take limit (1 to 100, default 20) and cursor. To get the next page, send nextCursor as cursor. On the last page, nextCursor is null. Cursors stay valid while new items are added.

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…

Rate limits

A request counts against several windows: the key's hourly limit, 300 a minute per person, 600 a minute per organization, a per-minute limit per key for reads, writes and AI calls, and each operation's own limit. REST and MCP share the same counters. The RateLimit-Policy and RateLimit headers show every window; X-RateLimit-* shows the one closest to running out. Over a limit you get 429 with 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

Create an endpoint with POST /api/v1/webhook-endpoints to be told when work finishes, instead of polling. Attorly sends a POST with a JSON event and signs it per Standard Webhooks with the endpoint's whsec_ secret. Verify the signature before you trust the body, answer 2xx within 15 seconds and deduplicate on webhook-id: failed deliveries are retried for 72 hours. You can roll the secret, send a test event and see every delivery.

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

Test mode

Test keys (atly_test_…) reach every endpoint, but work on separate test data and return fixed sample results: no AI runs and no credits are used. A test key never sees live data. Put a magic value such as __fail_credits__, __fail_consent__ or __slow__ in any text field to get that failure or delay. DELETE /api/v1/test-data clears everything a test key created.

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 that act for an Attorly user sign in with OAuth 2.1: discovery at /.well-known/oauth-authorization-server, dynamic client registration, and the authorization code flow with PKCE (S256). Ask for resource=https://attorly.ai/api/v1 to get a token for the REST API; a token issued for the MCP server is refused here. Add offline_access to get a refresh token. The person picks the organization and can narrow the scopes on the consent screen.

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

Documents

GET/api/v1/documentslistDocuments

List the stored documents the key can read, newest first.

Scope:DOCUMENTS_READ

Query parameters
Field	Type	Description
`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
`query`	`string`	Only documents whose name contains this text
`includeArchived`	`boolean`	Also list archived documents (left out by default)
`limit`	`integer`
`cursor`	`string`	Pass 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

Upload a document as multipart/form-data, or as JSON with base64 content or plain text. It is analysed in the background unless analyze is false.

Scope:DOCUMENTS_WRITEUses AI creditsAccepts file uploads

Request body
Field	Type	Description
`filename`required	`string`	The file name with its extension, e.g. "nda.pdf"; the extension decides the file type when mimeType is absent
`contentBase64`	`string`	The file, base64-encoded
`text`	`string`	Plain text to store as a .txt document, instead of contentBase64
`mimeType`	`string`	The file's MIME type; checked against its content
`name`	`string`	Display name; defaults to the file name
`type`	`"EMPLOYMENT_CONTRACT" \| "LEASE_AGREEMENT" \| "PURCHASE_AGREEMENT" \| "NDA" \| "TERMS_OF_SERVICE" \| "EMAIL" \| …`	What the document is
`url`	`string (uri)`	An https URL Attorly downloads the file from (public hosts only, up to 10 MB), instead of contentBase64 or text
`analyze`	`boolean`	Analyse the document in the background after upload, as the app does (uses AI credits). false stores it only

Response data (201)
Field	Type	Description
`id`required	`string`
`name`required	`string`
`originalName`required	`string`
`type`required	`"EMPLOYMENT_CONTRACT" \| "LEASE_AGREEMENT" \| "PURCHASE_AGREEMENT" \| "NDA" \| "TERMS_OF_SERVICE" \| "EMAIL" \| …`
`size`required	`integer`
`status`required	`"PENDING" \| "PROCESSING" \| "ANALYZED" \| "FAILED"`	PENDING until processing starts; ANALYZED once the analysis is stored
`analysisQueued`required	`boolean`	true when the background analysis was started
`createdAt`required	`string`	ISO 8601 date-time
`url`required	`string`	Where 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

Search the text of the documents the key can read, by meaning and by exact words.

Scope:DOCUMENTS_READ

Query parameters
Field	Type	Description
`query`required	`string`	What 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
`limit`	`integer`
`cursor`	`string`	Pass 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

Get a document, its processing status and its latest analysis.

Scope:DOCUMENTS_READ

Path parameters
Field	Type	Description
`documentId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`
`name`required	`string`
`originalName`required	`string`
`type`required	`"EMPLOYMENT_CONTRACT" \| "LEASE_AGREEMENT" \| "PURCHASE_AGREEMENT" \| "NDA" \| "TERMS_OF_SERVICE" \| "EMAIL" \| …`
`mimeType`required	`string`
`size`required	`integer`
`status`required	`"PENDING" \| "PROCESSING" \| "ANALYZED" \| "FAILED"`	PENDING until processing starts; ANALYZED once the analysis is stored
`archived`required	`boolean`
`ownedByYou`required	`boolean`
`createdAt`required	`string`	ISO 8601 date-time
`updatedAt`required	`string`	ISO 8601 date-time
`fileAvailable`required	`boolean`	false when the stored file can no longer be read
`governingLawRequired`required	`boolean`	true when the analysis is held until a governing law is chosen for the document in Attorly
`latestAnalysis`required	`object \| null`
`url`required	`string`	Where 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

Permanently delete a document you own.

Scope:DOCUMENTS_DELETE

Path parameters
Field	Type	Description
`documentId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`
`deleted`required	`true`

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

Analyse a document or inline text. mode is full (stored document) or quick.

Scope:DOCUMENTS_ANALYZEDOCUMENTS_READUses AI credits

The body's mode field picks one of: mode: full, mode: quick.

Request body
Field	Type	Description
`mode`	`"full" \| "quick"`	Runs documents_analyze.
`documentId`	`string`
`content`	`string`
`mimeType`	`string`
`options`	`object`

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

List a document's stored analyses, newest first.

Scope:DOCUMENTS_READ

Path parameters
Field	Type	Description
`documentId`required	`string`

Query parameters
Field	Type	Description
`limit`	`integer`
`cursor`	`string`	Pass 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

Analyse a stored document.

Scope:DOCUMENTS_ANALYZEDOCUMENTS_READUses AI credits

Path parameters
Field	Type	Description
`documentId`required	`string`

The body's mode field picks one of: mode: full, mode: quick.

Request body
Field	Type	Description
`mode`	`"full" \| "quick"`	Runs documents_analyze.
`content`	`string`
`mimeType`	`string`
`options`	`object`

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

Extract the plain text of a stored PDF or DOCX document.

Scope:DOCUMENTS_READ

Path parameters
Field	Type	Description
`documentId`required	`string`

Query parameters
Field	Type	Description
`offset`	`integer`	Character offset to start from; pass the nextOffset of the previous call to read on
`maxCharacters`	`integer`	Most characters to return in this call

Response data (200)
Field	Type	Description
`text`required	`string`	The document text from offset (untrusted content)
`documentName`required	`string`
`documentType`required	`string`
`mimeType`required	`string \| null`
`characterCount`required	`integer`	Characters in the whole document
`wordCount`required	`integer`	Words in the whole document
`offset`required	`integer`
`nextOffset`required	`integer \| null`	Pass as offset to read on; null when the text ends here
`truncated`required	`boolean`	true 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

Get a stored analysis: summary, risk, key terms, clauses and recommendations.

Scope:DOCUMENTS_READ

Path parameters
Field	Type	Description
`analysisId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`
`documentId`required	`string`
`documentName`required	`string`
`summary`required	`string \| null`
`riskLevel`required	`"LOW" \| "MEDIUM" \| "HIGH" \| "CRITICAL"`
`riskScore`required	`number`
`keyTerms`required	`array of any`
`clauses`required	`array of any`
`recommendations`required	`array of any`
`mode`required	`string`	SINGLE or CONSENSUS
`createdAt`required	`string`	ISO 8601 date-time
`url`required	`string`

curl

curl "https://attorly.ai/api/v1/analyses/your_analysisId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

POST/api/v1/comparisonscreateComparison

Compare two documents or texts line by line.

Scope:DOCUMENTS_READ

Request body
Field	Type	Description
`sourceDocumentId`	`string`
`sourceContent`	`string`
`targetDocumentId`	`string`
`targetContent`	`string`

Response data (200)
Field	Type	Description
`differences`required	`array of object`
`summary`required	`object`

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

Clauses

GET/api/v1/clausessearchClauses

Search the clause library.

Scope:CLAUSES_READ

Query parameters
Field	Type	Description
`query`required	`string`
`category`	`"INDEMNIFICATION" \| "LIABILITY" \| "TERMINATION" \| "CONFIDENTIALITY" \| "INTELLECTUAL_PROPERTY" \| "PAYMENT" \| …`
`jurisdiction`	`string`
`riskLevel`	`"LOW" \| "MEDIUM" \| "HIGH" \| "CRITICAL"`
`limit`	`integer`

Response data (200)
Field	Type	Description
`clauses`required	`array of object`
`count`required	`integer`

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

Assess the risk of a clause.

Scope:CLAUSES_READ

Request body
Field	Type	Description
`clauseText`required	`string`
`category`	`"INDEMNIFICATION" \| "LIABILITY" \| "TERMINATION" \| "CONFIDENTIALITY" \| "INTELLECTUAL_PROPERTY" \| "PAYMENT" \| …`	The kind of clause; its risk rules are applied
`jurisdiction`	`string`	ISO 3166-1 alpha-2 country code; defaults to international
`contractType`	`string`
`partyRole`	`"BUYER" \| "SELLER" \| "LANDLORD" \| "TENANT" \| "EMPLOYER" \| "EMPLOYEE" \| …`

Response data (200)
Field	Type	Description
`clauseText`	`string`
`clauseType`required	`string`
`jurisdiction`required	`string`
`overallRiskScore`required	`number`
`riskLevel`required	`"LOW" \| "MEDIUM" \| "HIGH" \| "CRITICAL"`
`riskFactors`required	`array of object`
`recommendations`required	`array of string`
`alternatives`	`array of object`
`complianceIssues`	`array of object`
`negotiationTips`	`array 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

Compare a clause with market-standard language.

Scope:CLAUSES_READ

Request body
Field	Type	Description
`clauseText`required	`string`
`category`required	`"INDEMNIFICATION" \| "LIABILITY" \| "TERMINATION" \| "CONFIDENTIALITY" \| "INTELLECTUAL_PROPERTY" \| "PAYMENT" \| …`
`contractType`	`string`
`jurisdiction`	`string`

Response data (200)
Field	Type	Description
`inputClause`required	`string`
`category`required	`string`
`marketStandards`required	`array of object`
`comparison`required	`object`

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

Check a clause against a playbook.

Scope:CLAUSES_READ

Request body
Field	Type	Description
`clauseText`required	`string`
`playbookId`required	`string`

Response data (200)
Field	Type	Description
`playbookName`required	`string`
`compliant`required	`boolean`
`violations`required	`array of string`
`warnings`required	`array of string`
`rulesChecked`required	`integer`

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

Research

POST/api/v1/research/searchessearchResearch

Search legal sources such as Lovdata, EUR-Lex and CourtListener.

Scope:RESEARCH_READUses AI credits

Request body
Field	Type	Description
`query`required	`string`
`jurisdictions`	`array of string`	ISO 3166-1 alpha-2 country code to search under, or "EU"; the first entry is used. Defaults to the key owner's country.
`sources`	`array of "lovdata" \| "eurlex" \| "legislation_uk" \| "congress_gov" \| "courtlistener" \| "finlex"`	Keep only results from these publishers
`dateFrom`	`string`	Keep only dated results on or after this day
`dateTo`	`string`	Keep only dated results on or before this day
`limit`	`integer`

Response data (200)
Field	Type	Description
`query`required	`string`
`jurisdiction`required	`string`
`results`required	`array of object`
`totalCount`required	`integer`	Results matching the filters, before limit
`sources`	`string`

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

Look up a statute by citation.

Scope:RESEARCH_READUses AI credits

Query parameters
Field	Type	Description
`citation`required	`string`
`jurisdiction`required	`string`	ISO 3166-1 alpha-2 country code, or "EU"

Response data (200)
Field	Type	Description
`id`required	`string`
`title`required	`string`
`source`required	`string`
`jurisdiction`	`string`
`citation`	`string`
`url`	`string`
`date`	`string`
`excerpt`	`string`
`relevanceScore`	`number`
`attribution`	`string`
`asOf`	`string`

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

Generate redline suggestions for a document or text.

Scope:REDLINES_GENERATEUses AI credits

Request body
Field	Type	Description
`documentId`	`string`
`content`	`string`
`partyRole`required	`"BUYER" \| "SELLER" \| "LANDLORD" \| "TENANT" \| "EMPLOYER" \| "EMPLOYEE"`
`riskTolerance`	`"CONSERVATIVE" \| "MODERATE" \| "AGGRESSIVE"`
`focusAreas`	`array of string`
`playbookId`	`string`	Redline 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

Response data (200)
Field	Type	Description
`changes`required	`array of object`
`summary`	`object`
`negotiationNotes`	`array of string`
`statistics`required	`object`

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

Accept or reject redline changes on a document.

Scope:REDLINES_GENERATE

Path parameters
Field	Type	Description
`documentId`required	`string`

Request body
Field	Type	Description
`changes`required	`array of object`

Response data (200)
Field	Type	Description
`accepted`required	`integer`
`rejected`required	`integer`
`message`required	`string`

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

Negotiations

POST/api/v1/negotiations/position-analysescreateNegotiationPositionAnalysis

Analyse a negotiation position.

Scope:NEGOTIATIONS_READUses AI credits

Request body
Field	Type	Description
`documentId`	`string`
`content`	`string`
`partyRole`required	`"BUYER" \| "SELLER" \| "LANDLORD" \| "TENANT" \| "EMPLOYER" \| "EMPLOYEE"`
`context`	`object`

Response data (200)
Field	Type	Description
`overallPosition`required	`string`	FAVORABLE, BALANCED or UNFAVORABLE
`positions`required	`array of object`
`prioritizedConcessions`	`array of string`
`dealBreakers`	`array of string`
`suggestedApproach`	`string`
`estimatedOutcome`	`object`

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

Build a negotiation playbook from a strategy.

Scope:NEGOTIATIONS_READUses AI credits

Request body
Field	Type	Description
`strategy`required	`object`
`context`	`object`

Response data (200)
Field	Type	Description
`playbook`required	`array of object`
`anticipatedObjections`required	`array of object`
`recommendations`required	`array of string`
`summary`required	`object`

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

List workflow templates.

Scope:WORKFLOWS_EXECUTE

Query parameters
Field	Type	Description
`category`	`"MA_ACQUISITION" \| "MA_MERGER" \| "INVESTMENT" \| "IPO" \| "REAL_ESTATE" \| "REGULATORY" \| …`	Due diligence project type the template is built for
`limit`	`integer`
`cursor`	`string`	Pass 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

List workflow executions, newest first, optionally for one project or status.

Scope:WORKFLOWS_EXECUTE

Query parameters
Field	Type	Description
`projectId`	`string`	Only executions on this due diligence project
`status`	`"PENDING" \| "RUNNING" \| "WAITING_FOR_INPUT" \| "WAITING_FOR_APPROVAL" \| "PAUSED" \| "COMPLETED" \| …`
`limit`	`integer`
`cursor`	`string`	Pass 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

Start a workflow on a due diligence project.

Scope:WORKFLOWS_EXECUTEUses AI credits

Request body
Field	Type	Description
`templateId`required	`string`
`projectId`required	`string`
`inputs`required	`object`
`options`	`object`

Response data (202)
Field	Type	Description
`executionId`required	`string`
`templateId`required	`string`
`templateName`required	`string`
`status`required	`string`
`startedAt`required	`string`	ISO 8601 date-time
`message`required	`string`

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

Get the status of a workflow execution.

Scope:WORKFLOWS_EXECUTE

Path parameters
Field	Type	Description
`executionId`required	`string`

Query parameters
Field	Type	Description
`includeSteps`	`boolean`

Response data (200)
Field	Type	Description
`executionId`required	`string`
`templateName`required	`string`
`status`required	`string`
`startedAt`	`string`	ISO 8601 date-time
`completedAt`	`string`	ISO 8601 date-time
`variables`	`object`
`error`	`string \| null`
`steps`	`array 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

List due diligence projects, newest first.

Scope:DUE_DILIGENCE_FULL

Query parameters
Field	Type	Description
`status`	`"NOT_STARTED" \| "IN_PROGRESS" \| "UNDER_REVIEW" \| "COMPLETED" \| "ON_HOLD" \| "CANCELLED"`	Only projects in this state
`limit`	`integer`
`cursor`	`string`	Pass 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

Create a due diligence project.

Scope:DUE_DILIGENCE_FULL

Request body
Field	Type	Description
`name`required	`string`
`dealType`required	`"MA_ACQUISITION" \| "MA_MERGER" \| "INVESTMENT" \| "IPO" \| "REAL_ESTATE" \| "REGULATORY" \| …`
`targetCompany`	`string`
`description`	`string`
`settings`	`object`

Response data (201)
Field	Type	Description
`projectId`required	`string`
`name`required	`string`
`projectType`required	`string`
`status`required	`string`
`createdAt`required	`string`	ISO 8601 date-time
`message`required	`string`

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

Get a due diligence project with its document and finding counts.

Scope:DUE_DILIGENCE_FULL

Path parameters
Field	Type	Description
`projectId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`
`name`required	`string`
`description`required	`string \| null`
`projectType`required	`string`
`status`required	`string`
`priority`required	`string`
`targetCompany`required	`string \| null`
`dueDate`required	`string \| null`
`documentCount`required	`integer`
`findingCount`required	`integer`
`createdAt`required	`string`	ISO 8601 date-time
`updatedAt`required	`string`	ISO 8601 date-time
`completedAt`required	`string \| 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

Add documents to a due diligence project.

Scope:DUE_DILIGENCE_FULL

Path parameters
Field	Type	Description
`projectId`required	`string`

Request body
Field	Type	Description
`documentIds`required	`array of string`
`category`	`string`

Response data (200)
Field	Type	Description
`projectId`required	`string`
`documentsAdded`required	`integer`
`totalDocuments`required	`integer`
`category`required	`string`
`message`required	`string`

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

List the findings of a due diligence project.

Scope:DUE_DILIGENCE_FULL

Path parameters
Field	Type	Description
`projectId`required	`string`

Query parameters
Field	Type	Description
`riskLevel`	`"INFO" \| "LOW" \| "MEDIUM" \| "HIGH" \| "CRITICAL"`
`category`	`string`
`limit`	`integer`

Response data (200)
Field	Type	Description
`projectId`required	`string`
`projectName`required	`string`
`findings`required	`array of object`
`riskSummary`required	`object`	Number of findings per severity
`totalFindings`required	`integer`

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

Generate a due diligence report.

Scope:DUE_DILIGENCE_FULL

Path parameters
Field	Type	Description
`projectId`required	`string`

Request body
Field	Type	Description
`format`required	`"pdf" \| "markdown"`	"markdown" returns the report text; "pdf" also returns the formatted PDF (base64)
`sections`	`array of "executive_summary" \| "risk_overview" \| "findings_detail" \| "document_analysis" \| "recommendations"`
`includeRecommendations`	`boolean`

Response data (201)
Field	Type	Description
`reportId`required	`string`
`projectId`required	`string`
`projectName`	`string`
`format`required	`"pdf" \| "markdown"`
`status`required	`string`
`sections`	`array of string`
`documentCount`	`integer`
`findingCount`	`integer`
`markdown`required	`string`
`attachment`	`object`
`message`	`string`

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

Templates and drafts

GET/api/v1/templateslistTemplates

List document templates.

Scope:TEMPLATES_READ

Query parameters
Field	Type	Description
`category`	`"NDA" \| "EMPLOYMENT" \| "SERVICE_AGREEMENT" \| "LEASE" \| "REAL_ESTATE" \| "CORPORATE" \| …`
`jurisdiction`	`string`	ISO 3166-1 alpha-2 country code (e.g. "NO", "GB"); jurisdiction-neutral templates are always included
`language`	`string`	ISO 639-1 language code of the template text (e.g. "en", "nb")
`limit`	`integer`
`cursor`	`string`	Pass 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

Create a draft from a template (mode template) or with AI (mode ai).

Scope:TEMPLATES_DRAFTUses AI credits

The body's mode field picks one of: mode: template, mode: ai.

Request body
Field	Type	Description
`mode`	`"template" \| "ai"`	Runs templates_draft.
`templateId`	`string`
`variables`	`object`
`options`	`object`
`documentType`	`string`
`requirements`	`string`
`context`	`object`

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

Operations

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

Get the status and result of a request sent with Prefer or Idempotency-Key.

Path parameters
Field	Type	Description
`operationId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`	op_…
`object`required	`"operation"`
`operationId`required	`string`	The REST operation that was called, e.g. createRedlines
`status`required	`"running" \| "succeeded" \| "failed"`
`livemode`required	`boolean`
`idempotencyKey`	`string \| null`
`resultUrl`required	`string`	Where to poll: /api/v1/operations/{id}
`createdAt`required	`string (date-time)`
`completedAt`required	`string (date-time) \| null`
`expiresAt`required	`string (date-time)`
`httpStatus`required	`integer \| null`
`result`required	`any`	The data of the successful call
`meta`	`object`
`error`required	`object \| null`

curl

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

Webhooks

GET/api/v1/webhook-endpointslistWebhookEndpoints

List the webhook endpoints of the key's organization and mode.

curl

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

POST/api/v1/webhook-endpointscreateWebhookEndpoint

Create a webhook endpoint. The response holds its signing secret, shown only once.

Request body
Field	Type	Description
`url`required	`string (uri)`	HTTPS URL that receives the events
`description`	`string`
`enabledEvents`required	`array of string`	Event types to receive, or ["*"] for all
`includeSnapshots`	`boolean`	Send 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.

Response data (201)
Field	Type	Description
`id`required	`string`	we_…
`object`required	`"webhook_endpoint"`
`url`required	`string`
`description`	`string \| null`
`enabledEvents`required	`array of string`
`status`required	`"enabled" \| "disabled"`
`disabledReason`	`string \| null`	disabled_by_user or failing_deliveries
`livemode`required	`boolean`
`includeSnapshots`required	`boolean`
`apiVersion`required	`string`
`failingSince`	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`
`secret`	`string`	whsec_… — 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

Get a webhook endpoint.

Path parameters
Field	Type	Description
`endpointId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`	we_…
`object`required	`"webhook_endpoint"`
`url`required	`string`
`description`	`string \| null`
`enabledEvents`required	`array of string`
`status`required	`"enabled" \| "disabled"`
`disabledReason`	`string \| null`	disabled_by_user or failing_deliveries
`livemode`required	`boolean`
`includeSnapshots`required	`boolean`
`apiVersion`required	`string`
`failingSince`	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`
`secret`	`string`	whsec_… — 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

Change an endpoint's URL, events or snapshots, or disable and enable it.

Path parameters
Field	Type	Description
`endpointId`required	`string`

Request body
Field	Type	Description
`url`	`string (uri)`
`description`	`string \| null`
`enabledEvents`	`array of string`
`includeSnapshots`	`boolean`
`status`	`"enabled" \| "disabled"`	Disable to pause deliveries; enable to resume

Response data (200)
Field	Type	Description
`id`required	`string`	we_…
`object`required	`"webhook_endpoint"`
`url`required	`string`
`description`	`string \| null`
`enabledEvents`required	`array of string`
`status`required	`"enabled" \| "disabled"`
`disabledReason`	`string \| null`	disabled_by_user or failing_deliveries
`livemode`required	`boolean`
`includeSnapshots`required	`boolean`
`apiVersion`required	`string`
`failingSince`	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`
`secret`	`string`	whsec_… — 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

Delete a webhook endpoint and its delivery history.

Path parameters
Field	Type	Description
`endpointId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`
`object`required	`"webhook_endpoint"`
`deleted`required	`true`

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

Replace the signing secret. The old one keeps signing for 24 hours.

Path parameters
Field	Type	Description
`endpointId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`	we_…
`object`required	`"webhook_endpoint"`
`url`required	`string`
`description`	`string \| null`
`enabledEvents`required	`array of string`
`status`required	`"enabled" \| "disabled"`
`disabledReason`	`string \| null`	disabled_by_user or failing_deliveries
`livemode`required	`boolean`
`includeSnapshots`required	`boolean`
`apiVersion`required	`string`
`failingSince`	`string (date-time) \| null`
`createdAt`required	`string (date-time)`
`updatedAt`required	`string (date-time)`
`secret`	`string`	whsec_… — 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

Send a webhook_endpoint.test event to this endpoint only.

Path parameters
Field	Type	Description
`endpointId`required	`string`

Response data (202)
Field	Type	Description
`eventId`required	`string`

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

List an endpoint's deliveries, newest first, with their attempts and outcome.

Path parameters
Field	Type	Description
`endpointId`required	`string`

Query parameters
Field	Type	Description
`limit`	`integer`	Items per page, 1–100 (default 20)
`cursor`	`string`	The 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"

Events

GET/api/v1/eventslistEvents

List the events of the last 30 days, newest first.

Query parameters
Field	Type	Description
`limit`	`integer`	Items per page, 1–100 (default 20)
`cursor`	`string`	The nextCursor of the previous page
`type`	`string`	Only 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

Get an event as webhook endpoints receive it.

Path parameters
Field	Type	Description
`eventId`required	`string`

Response data (200)
Field	Type	Description
`id`required	`string`	evt_… — also sent as the webhook-id header; deduplicate on it
`object`required	`"event"`
`type`required	`"analysis.completed" \| "analysis.failed" \| "redlines.generated" \| "due_diligence.report.completed" \| "operation.succeeded" \| "operation.failed" \| …`
`apiVersion`required	`string`
`createdAt`required	`string (date-time)`
`livemode`required	`boolean`
`data`required	`object`

curl

curl "https://attorly.ai/api/v1/events/your_eventId" \
  -H "Authorization: Bearer $ATTORLY_API_KEY"

POST/api/v1/events/{eventId}/redeliveriesredeliverEvent

Send an event again, to one endpoint or to every endpoint subscribed to it.

Path parameters
Field	Type	Description
`eventId`required	`string`

Request body
Field	Type	Description
`endpointId`	`string`	Only this endpoint; default every endpoint subscribed to the event

Response data (202)
Field	Type	Description
`eventId`required	`string`
`deliveriesScheduled`required	`integer`

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

Account, usage and logs

GET/api/v1/organizationgetOrganization

The key's organization: plan, AI credits, default jurisdiction and what the key may do.

Response data (200)
Field	Type	Description
`organization`required	`object`
`user`required	`object`
`plan`required	`string`	STANDARD, PRO or ENTERPRISE
`billing`required	`object`
`defaultJurisdiction`required	`string \| null`	ISO 3166-1 alpha-2 country used when a document names no governing law
`credential`required	`object`
`appUrl`required	`string`

curl

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

GET/api/v1/usagegetUsage

Requests per day, key and operation, with error counts, over REST and MCP.

Query parameters
Field	Type	Description
`from`	`any`	ISO 8601 date; default 30 days ago (requests are kept 30 days)
`to`	`any`	ISO 8601 date, exclusive; default now

curl

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

GET/api/v1/request-logslistRequestLogs

List the organization's API requests of the last 30 days, newest first.

Query parameters
Field	Type	Description
`limit`	`integer`	Items per page, 1–100 (default 20)
`cursor`	`string`	The nextCursor of the previous page
`status`	`string`	2xx, 4xx, 5xx, or an exact status
`credentialId`	`string`	Only requests made with this key (apikey:<id>, or an MCP connection id)
`operationId`	`string`	Only calls of this operation, e.g. createRedlines
`requestId`	`string`	One request, by its Request-Id
`since`	`any`	ISO 8601; only requests at or after this time
`until`	`any`	ISO 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

Who called what, when and with which key. For organization owners and admins.

Query parameters
Field	Type	Description
`limit`	`integer`	Items per page, 1–100 (default 20)
`cursor`	`string`	The nextCursor of the previous page
`status`	`string`	2xx, 4xx, 5xx, or an exact status
`credentialId`	`string`	Only requests made with this key (apikey:<id>, or an MCP connection id)
`operationId`	`string`	Only calls of this operation, e.g. createRedlines
`requestId`	`string`	One request, by its Request-Id
`since`	`any`	ISO 8601; only requests at or after this time
`until`	`any`	ISO 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

Delete every test-mode object, event and operation of the organization. Test keys only.

Response data (200)
Field	Type	Description
`object`required	`"test_data_purge"`
`deleted`required	`object`

curl

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

REST API documentation

Quickstart

1. Create a key

2. Upload a document

3. Analyse it

4. Collect the result

Authentication

Scopes

Errors

Versioning

Idempotency

Long-running requests

Rate limits

Webhooks

Test mode

OAuth

Billing

Plans

Reference

Documents

Clauses

Research

Redlines

Negotiations

Workflows

Due diligence

Templates and drafts

Operations

Webhooks

Events

Account, usage and logs