Lexifina External API
Scoped personal API keys. Existing ownership, account security and usage quotas apply. Required scopes are listed on each operation. Every successful JSON…
Government & public#government
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Scoped personal API keys. Existing ownership, account security and usage quotas apply. Required scopes are listed on each operation.
Every successful JSON response has one shape. A resource is returned as itself, with id and object (its type, such as "invoice"). A list is {"object": "list", "data": [...], "has_more", "next_cursor", "first_id", "last_id"}; pass next_cursor as after for the next page. A deletion is {"id", "object", "deleted": true}. Downloads are the file itself. Timestamps are ISO 8601 in UTC, ending in Z. Errors are {"error": {"type", "code", "message", "retryable", "fields", "details"}, "request_id"}: branch on type, retry only when retryable is true. Ignore fields you do not recognise.
Typical agent flow: start a run on a document (runs.create), poll it (runs.retrieve) until is_terminal or subscribe to run webhooks, then open a review with the run's run_id and resolve every proposal. Read documents as plain text with the text operation; section identifiers are shared by text, citations, proposals and section edits.
Writes accept Idempotency-Key for JSON requests up to 1 MiB. A retry with the same key and body returns the first response; a request refused before it changed anything (a retryable error) can be retried with the same key; an outcome that is unknown (outcome_unknown) is never re-executed: read the resource, then use a new key. Send X-Client-Request-Id to have your own identifier echoed and logged.
Versions are dates. Send Lexifina-Version to choose one; without it a request runs at the version its key was created with. Every response names the version that served it. New operations, optional fields, response fields, enum values, error codes and event types are added without a new version; ignore what you do not recognise. Operations marked beta (x-beta, and a Lexifina-Beta: true response header) may change without a new version.
Endpoints 202
api_keys
- GETList the calling key and the keys it made, with this month's spend.
/api_keysRequired scope: keys:read. The calling key and the keys it made, with this month's spend. Secrets are never returned again. - POSTMake a key with some or all of the calling key's scopes. Its secret is returned only in this response.
/api_keysRequired scope: keys:write. Make a key with some or all of the calling key's scopes. The secret is returned only now: store it. - GETGet the calling key, or a key it made.
/api_keys/:key_idRequired scope: keys:read. The calling key, or a key it made. - DELETERevoke the calling key or a key it made, and the keys that key made.
/api_keys/:key_idRequired scope: keys:write. Revoke the calling key or a key it made. It stops working at once, and so do the keys it made. - PATCHChange a key's default API version, or the limits of a key the calling key made.
/api_keys/:key_idRequired scope: keys:write. Change a key's default API version, or the spending limits of a key the calling key made. Only the fields sent change. - POSTReplace a key's secret, keeping its id, scopes, limits and spend.
/api_keys/:key_id/rollRequired scope: keys:write. Replace a key's secret. The key keeps its id, scopes, limits, spend and the keys it made; the new secret is returned only now.
search
- GETBrowse and search clauses across your documents.
/clause_libraryRequired scope: search:read. - POSTSearch documents, document text, matters, clients, agent sessions, workflows and signatures together. Every word must match.
/searchRequired scope: search:read. Every word must match, in any order. Each source has up to 8 seconds; check providers for any that timed out. - POSTFull-text search across several documents.
/search/documentsRequired scope: search:read. - POSTSearch supplied sections for text.
/search/sectionsRequired scope: search:read.
clients
- GETList your clients, ordered by ID. Filter with q or external_id; pass next_cursor as after.
/clientsRequired scope: clients:read. List owned clients, ordered by ID. Pass pagination.next_cursor as after. - POSTCreate a client. Posting an existing email returns that client.
/clientsRequired scope: clients:write. - GETGet one client.
/clients/:client_idRequired scope: clients:read. - DELETEDelete a client that has no matters.
/clients/:client_idRequired scope: clients:delete. - PATCHUpdate a client.
/clients/:client_idRequired scope: clients:write. - PUTSet your system's identifier and metadata on a client.
/clients/:client_id/external_referenceRequired scope: clients:write.
clients.matters
- GETList the matters attached to a client.
/clients/:client_id/mattersRequired scope: clients:read.
conversions
- POSTConvert a file to another format and get it back: Word, PDF, OpenDocument, RTF, HTML, Markdown, text, emails and pictures in; Word, PDF, OpenDocument, RTF, HTML, Markdown, text, JPG or PNG out. Nothing is stored. For long files or many files, use a conversion job.
/conversionsRequired scope: documents:transform.
conversions.jobs
- GETList your conversion jobs, newest first.
/conversions/jobsRequired scope: documents:transform. - POSTConvert up to 50 files in the background: answers at once with the job. Poll it or subscribe to conversion.completed, then download each result (kept for 24 hours).
/conversions/jobsRequired scope: documents:transform. - GETGet a conversion job: its status and, for each file, its status, error or result.
/conversions/jobs/:job_idRequired scope: documents:transform. - POSTCancel a conversion job: files not yet converted are not converted.
/conversions/jobs/:job_id/cancelRequired scope: documents:transform.
conversions.jobs.items
- GETDownload one file's converted result.
/conversions/jobs/:job_id/items/:index/contentRequired scope: documents:transform.
documents
- GETList documents you can access. Filter with search, folder, writable_only or external_id; page with limit and after.
/documentsRequired scope: documents:read. - POSTCreate a document: upload a file (multipart, field file), or send JSON with content (editor JSON), a template name, or neither for an empty document.
/documentsRequired scope: documents:write. Create a document from a file you upload, from editor JSON, from a template, or empty. - POSTCompare two documents, or two versions of one document. Returns changed sections as JSON (format=json), a unified text diff (format=diff) or a tracked-changes .docx (format=docx). Read-only.
/documents/compareRequired scope: documents:read. Compare two documents or two versions section by section. Nothing is stored. - GETMetadata facet values across your documents.
/documents/facetsRequired scope: documents:read. - POSTMake a new document from files or stored documents: combine, extract_pages, split, reorder_pages, clean_metadata, optimize or ocr.
/documents/transformsRequired scope: documents:transform. One operation for every page and PDF transform. Inputs are uploaded files, stored documents, or both. - GETGet one document's record, including its version list.
/documents/:document_idRequired scope: documents:read. - DELETEDelete a document and queue cleanup of its files.
/documents/:document_idRequired scope: documents:delete. - PATCHUpdate a document's title and custom metadata, and optionally its external_reference.
/documents/:document_idRequired scope: documents:write. - GETGet who wrote each block of the current version.
/documents/:document_id/blameRequired scope: documents:read. - GETGet a version's rich content as editor JSON. Use the text operation for plain text.
/documents/:document_id/contentBeta: may change without a new API version. Required scope: documents:read. - GETDownload a version as a .docx (format=docx, the default), a PDF (format=pdf), or a tracked-changes .docx against an earlier version (format=redline_docx with source_version).
/documents/:document_id/downloadRequired scope: documents:read. - PUTSet your system's identifier and metadata on a document.
/documents/:document_id/external_referenceRequired scope: documents:write. - GETGet the available representations of the current version.
/documents/:document_id/formatsRequired scope: documents:read. - PUTRename a document, as Lexifina shows it. Its file type stays.
/documents/:document_id/nameRequired scope: documents:write. Rename a document as the web app's rename does: the name listings and search show. - GETGet the status of background structure and clause analysis.
/documents/:document_id/processingRequired scope: documents:read. - GETGet length and readability for every version, with words added and removed.
/documents/:document_id/readabilityRequired scope: documents:read. - GETGet a version as plain text, section by section, with the section identifiers that section edits use.
/documents/:document_id/textRequired scope: documents:read. The document as plain text, one entry per section.
analysis
- POSTSummarise the change between a version and its parent.
/documents/:document_id/analysis/change_summary?version=0Required scope: documents:analyze. - POSTSummarise changes to key terms across a document's saved versions. Needs two or more versions.
/documents/:document_id/analysis/keywordsRequired scope: documents:analyze. - POSTSummarise risks introduced across a document's saved versions. Needs two or more versions; for a review of the contract itself, run an agent.
/documents/:document_id/analysis/risksRequired scope: documents:analyze. - POSTSummarise structural changes across a document's saved versions. Needs two or more versions.
/documents/:document_id/analysis/structureRequired scope: documents:analyze.
documents.clauses
- GETList clauses with the versions in which each changed.
/documents/:document_id/clausesRequired scope: documents:read. - GETGet the text of one clause in every version.
/documents/:document_id/clauses/:clause_uuid/historyRequired scope: documents:read.
documents.comments
- GETList the document's comment threads, each with its section, quoted text and replies.
/documents/:document_id/commentsRequired scope: documents:read. The document's comment threads, each with the section it is on, the text it quotes and its replies. - POSTComment on a section, or on text within it, as you.
/documents/:document_id/commentsRequired scope: documents:write. Add a comment to a section, attached to quote_text within it or to the whole section. - POSTReopen a resolved comment thread.
/documents/:document_id/comments/:comment_id/reopenRequired scope: documents:write. Reopen a resolved comment thread. - POSTReply to a comment thread.
/documents/:document_id/comments/:comment_id/repliesRequired scope: documents:write. Reply to a comment thread. - POSTMark a comment thread resolved.
/documents/:document_id/comments/:comment_id/resolveRequired scope: documents:write. Mark a comment thread resolved.
comparisons
- POSTStart a background clause-level comparison of two versions. Poll the comparison for the result.
/documents/:document_id/comparisonsRequired scope: documents:analyze. Start a metered comparison after checking write access to the document. - POSTStart a background comparison of two versions' metadata. Poll the comparison for the result.
/documents/:document_id/comparisons/metadataRequired scope: documents:analyze. Start a metadata comparison after checking write access to the document. - GETGet the status and result of a metadata comparison.
/documents/:document_id/comparisons/metadata/:comparison_idRequired scope: documents:analyze. - GETGet the status and result of a clause-level comparison.
/documents/:document_id/comparisons/:comparison_idRequired scope: documents:analyze.
redactions
- GETTell whether a document is a redacted copy, of which document, and whether it can be reverted.
/documents/:document_id/redaction_statusRequired scope: documents:transform. - GETList the redactions applied to a document (its redaction log).
/documents/:document_id/redactionsRequired scope: documents:transform. - POSTRedact a stored document (document_id) or an uploaded file (multipart, field file) into a new copy, or preview what would be removed (dry_run, or content you send).
/redactionsRequired scope: documents:transform. Redact a stored document or an uploaded file into a new copy, or check what would be removed. - GETList the entity types redaction can remove.
/redactions/entity_typesRequired scope: documents:transform.
reviews
- POSTOpen a review of the agent's proposed changes to a document, optionally limited to one run.
/documents/:document_id/reviewsRequired scope: agents:review. Snapshot the open proposals so they can be decided together. - POSTClose an open review without deciding.
/documents/:document_id/reviews/:review_id/abandonRequired scope: agents:review. Close a review without deciding. Its proposals stay open. - POSTAccept, modify or reject every proposal in an open review. Accepted changes create a new version.
/documents/:document_id/reviews/:review_id/resolveRequired scope: agents:review. Commit the decisions. Accepted and modified proposals produce one new version.
documents.sections
- GETGet one section's rich content as editor JSON.
/documents/:document_id/sections/:section_id/contentBeta: may change without a new API version. Required scope: documents:read. - GETGet one section as a .docx file, base64-encoded in JSON.
/documents/:document_id/sections/:section_id/downloadRequired scope: documents:read. - GETGet the stored metadata for one section.
/documents/:document_id/sections/:section_id/metadataRequired scope: documents:read. - PUTUpdate one section's metadata.
/documents/:document_id/sections/:section_id/metadataRequired scope: documents:write. - PUTReplace one section's text, creating a new version, or with mode=suggest record the edit as tracked changes. Works on documents open for live collaboration.
/documents/:document_id/sections/:section_id/textRequired scope: documents:write. Replace one section's text and save a new version. Inline formatting in the section takes the formatting of its first run.…
sessions
- POSTCreate an agent session for a document.
/documents/:document_id/sessionsBeta: may change without a new API version. Required scope: agents:write. Create an agent session without changing the web application's current session. - GETList your agent sessions, including conversations without a document. Filter by document or matter.
/sessionsRequired scope: agents:read.
documents.tracked_changes
- GETList the document's pending tracked changes: who made each, when, and what it inserts and deletes.
/documents/:document_id/tracked_changesRequired scope: documents:read. The document's pending tracked changes: who made each, when, and the text it inserts and deletes. - POSTSuggest an edit as a tracked change, attributed to you, for someone to accept or reject.
/documents/:document_id/tracked_changesRequired scope: documents:write. Suggest an edit as a tracked change. Nothing changes in the agreed text until someone accepts it. - POSTAccept a pending tracked change.
/documents/:document_id/tracked_changes/:tracked_change_id/acceptRequired scope: documents:write. Accept a pending tracked change: its insertions stay and its deletions go. - POSTReject a pending tracked change and restore the text.
/documents/:document_id/tracked_changes/:tracked_change_id/rejectRequired scope: documents:write. Reject a pending tracked change: the text is restored as it was.
translations
- GETList the translations made of a document's sections (its translation log).
/documents/:document_id/translationsRequired scope: documents:transform. - POSTTranslate rich content (editor JSON) or a list of plain-text sections without saving them.
/translationsRequired scope: documents:transform. - GETList supported translation languages.
/translations/languagesRequired scope: documents:transform.
documents.versions
- POSTUpload a .docx as a new version of an existing document.
/documents/:document_id/versionsRequired scope: documents:write. - GETGet the metadata recorded for one version.
/documents/:document_id/versions/:versionRequired scope: documents:read.
law.jurisdictions
- GETList the jurisdictions in the record, or describe one, with the names the law operations take.
/law/jurisdictionsRequired scope: law:read. The jurisdictions in the record, with what is held for each: the names the other law operations take.
law.provisions
- GETRead a provision as it stood on a date, with the amending act that made that version.
/law/provisions?path=stringRequired scope: law:read. Read a provision as it stood on a date, with the commit (the amending act) that made that version. - GETFind provisions from a citation or a name, with their paths.
/law/provisions/find?query=stringRequired scope: law:read. Find provisions from a citation or a name, with their paths. - GETList a provision's versions: when each took effect and the amending act that made it.
/law/provisions/history?path=stringRequired scope: law:read. A provision's amendment history: each version, when it took effect and the act that made it.
law
- GETSearch a jurisdiction's law, as it stood on a date, for words or a phrase.
/law/search?query=stringRequired scope: law:read. Search a jurisdiction's law, as it stood on a date, for words or a phrase. The answer's data.matches holds one entry per provision…
law.tools
- GETList the law tools: legislation and case law at any date from global-law, with each tool's arguments.
/law/toolsBeta: may change without a new API version. Required scope: law:read. The law tools, with what each does and the arguments it takes (JSON Schema). - POSTCall a law tool with its arguments: read a provision at a date, trace its amendments, search, resolve citations.
/law/tools/:tool_nameBeta: may change without a new API version. Required scope: law:read. Call one law tool with its arguments. Every other law operation is a shortcut for one of…
matters
- GETList custom matter field definitions.
/matter_fieldsRequired scope: matters:read. - GETList matter detail profiles.
/matter_profilesRequired scope: matters:read. - GETList matters you own or that are shared into your organisation. Filter with external_id.
/mattersRequired scope: matters:read. - POSTCreate a matter, optionally for an existing client and from a questionnaire template.
/mattersRequired scope: matters:write. - GETGet one matter.
/matters/:matter_idRequired scope: matters:read. - DELETEDiscard an unused draft matter. Refused once it has documents, files, signature requests or financial records.
/matters/:matter_idRequired scope: matters:delete. Purge an unused draft matter you own, leaving a purge receipt. - PATCHUpdate a matter: its details (name, number, practice area, jurisdiction and dates), contacts and custom field values, in one request.
/matters/:matter_idRequired scope: matters:write. Apply details, then contacts, then custom fields; returns the matter as matters.retrieve shows it. - POSTClose a matter. Retention policy then schedules its deletion.
/matters/:matter_id/closeRequired scope: matters:write. - PUTSet your system's identifier and metadata on a matter.
/matters/:matter_id/external_referenceRequired scope: matters:write. - GETGet a matter's consolidated overview: details, documents, tasks, people and activity.
/matters/:matter_id/overviewRequired scope: matters:read. - POSTReopen a closed matter.
/matters/:matter_id/reopenRequired scope: matters:write. - GETGet a matter's questionnaire and submission status.
/matters/:matter_id/statusRequired scope: matters:read.
matters.documents
- POSTAttach a document to a matter.
/matters/:matter_id/documentsRequired scope: matters:write. - DELETETake a document off a matter. The document itself is kept.
/matters/:matter_id/documents/:document_idRequired scope: matters:write.
matters.events
- GETList a matter's timeline events.
/matters/:matter_id/eventsRequired scope: matters:read. - POSTAdd a note or custom event to the matter timeline.
/matters/:matter_id/eventsRequired scope: matters:write.
matters.files
- POSTUpload a file owned by the matter.
/matters/:matter_id/filesRequired scope: matters:write.
finance.invoices
- GETList a matter's invoices, newest first.
/matters/:matter_id/invoicesRequired scope: billing:read. - POSTPrepare a draft invoice from unbilled work or fee lines.
/matters/:matter_id/invoicesRequired scope: billing:write. - POSTNumber and issue a draft invoice.
/matters/:matter_id/invoices/:invoice_id/issueRequired scope: billing:write. - POSTVoid an invoice and return its entries to unbilled work.
/matters/:matter_id/invoices/:invoice_id/voidRequired scope: billing:write. - GETGet one invoice with its lines and allocations.
/matters/:matter_id/invoices/:invoice_idRequired scope: billing:read. - GETDownload an invoice as a PDF (format=pdf, the default) or, once issued, in LEDES 1998B (format=ledes).
/matters/:matter_id/invoices/:invoice_id/downloadRequired scope: billing:read.
finance
- GETGet a matter's ledger: unbilled work, invoices, payments and rates.
/matters/:matter_id/ledgerRequired scope: billing:read. - GETDownload a matter's ledger as CSV.
/matters/:matter_id/ledger/exportRequired scope: billing:read.
finance.payments
- GETList a matter's payments, newest first.
/matters/:matter_id/paymentsRequired scope: billing:read. - POSTRecord a payment and allocate it to invoices.
/matters/:matter_id/paymentsRequired scope: billing:write. - POSTReverse a payment.
/matters/:matter_id/payments/:payment_id/reverseRequired scope: billing:write. - GETGet one payment with its allocations.
/matters/:matter_id/payments/:payment_idRequired scope: billing:read.
matters.questionnaires
- GETList the questionnaires attached to a matter.
/matters/:matter_id/questionnairesRequired scope: matters:read. - POSTAttach a questionnaire template to a matter.
/matters/:matter_id/questionnairesRequired scope: matters:write. - PUTSave questionnaire answers.
/matters/:matter_id/questionnaires/answersRequired scope: matters:write. - POSTSubmit a matter's questionnaire for review.
/matters/:matter_id/questionnaires/submitRequired scope: matters:write.
finance.rates
- GETList a matter's hourly rates.
/matters/:matter_id/ratesRequired scope: billing:read. The matter's hourly rates. Rates from the organisation's rate card apply when the matter has none. - POSTAdd an hourly rate to a matter for every fee earner, one grade or one fee earner, and price its unpriced time.
/matters/:matter_id/ratesRequired scope: billing:write. Add an hourly rate to a matter, as the web ledger's rate form does. - PATCHChange a rate's amount, start date or label.
/matters/:matter_id/rates/:rate_idRequired scope: billing:write. Change a rate's amount, start date or label. Time already priced keeps its price. - POSTStop using a rate. Time already priced keeps its price.
/matters/:matter_id/rates/:rate_id/archiveRequired scope: billing:write. Stop using a rate. Time already priced keeps its price; the rate stays in the matter's history.
matters.tasks
- GETList a matter's tasks and deadlines.
/matters/:matter_id/tasksRequired scope: matters:read. - POSTCreate a task or deadline.
/matters/:matter_id/tasksRequired scope: matters:write. - PATCHUpdate a task or deadline. Set status to completed, cancelled or open to complete, cancel or reopen it.
/matters/:matter_id/tasks/:task_idRequired scope: matters:write.
finance.time_entries
- POSTRecord time on a matter.
/matters/:matter_id/time_entriesRequired scope: billing:write. Record time exactly as the web time form does; the matter's rates price it. - PATCHCorrect an unbilled time entry: its time, narrative, date or billable flag.
/matters/:matter_id/time_entries/:entry_idRequired scope: billing:write. Correct an unbilled time entry, as the web time form does; billed time is changed through its invoice. - POSTTake an unbilled time entry off the matter's unbilled work. It stays in the matter's history.
/matters/:matter_id/time_entries/:entry_id/archiveRequired scope: billing:write. Take an unbilled time entry off the matter's unbilled work. It stays in the matter's history.
portal.invitations
- POSTInvite a client contact to a matter's client portal. They are emailed a sign-in link unless send_email is false.
/matters/:matter_id/portal/invitationsBeta: may change without a new API version. Required scope: clients:write. Invite a contact to a matter's portal exactly as the web Share dialog does.
portal.messages
- GETRead the messages between your firm and the client on a matter's client portal.
/matters/:matter_id/portal/messagesBeta: may change without a new API version. Required scope: clients:read. - POSTSend the client a message on a matter's client portal. They are emailed a notice to read it unless notify is false.
/matters/:matter_id/portal/messagesBeta: may change without a new API version. Required scope: clients:write.
questionnaire_templates
- GETList questionnaire templates.
/questionnaire_templatesRequired scope: templates:read. - POSTCreate a questionnaire template.
/questionnaire_templatesRequired scope: templates:write. - GETGet one questionnaire template.
/questionnaire_templates/:template_idRequired scope: templates:read. - PUTUpdate a questionnaire template.
/questionnaire_templates/:template_idRequired scope: templates:write. - POSTCopy a questionnaire template.
/questionnaire_templates/:template_id/duplicateRequired scope: templates:write. - GETExport a questionnaire template as a portable JSON package.
/questionnaire_templates/:template_id/exportRequired scope: templates:read.
runs
- GETList runs in your sessions, newest first. Filter by session, document, status, source, creation time or external_id.
/runsRequired scope: agents:read. Runs in your sessions, started from the API or the app, newest first. Subagent runs are not listed. - POSTStart an agent run on a document or in a conversation of its own, in a new session or an existing one, optionally with a skill, extra documents and an output schema.
/runsRequired scope: agents:write. Start an agent run on a document, or in a conversation of its own (omit document_id). Without session_id a new session is… - GETGet a run's status, answer, citations, questions, proposed changes, structured output and cost. Poll this after starting a run.
/runs/:run_idRequired scope: agents:read. A run's status, answer, citations, questions, proposed changes, structured output and cost. Poll until is_terminal is true (and… - POSTCancel a run. Idempotent: returns the run's result.
/runs/:run_id/cancelRequired scope: agents:write. Stop a run and every subagent run it started. The result's status is cancel_requested at once and cancelled once the run has… - PUTSet your system's identifier and metadata on a run.
/runs/:run_id/external_referenceRequired scope: agents:write. - POSTAnswer a question the agent asked during a run.
/runs/:run_id/user_inputRequired scope: agents:write. Answer the question a running agent asked (result.pending_user_input), including one a subagent asked. The run that asked then…
runs.directions
- GETList the directions sent to a run, with whether the agent has taken each into account.
/runs/:run_id/directionsBeta: may change without a new API version. Required scope: agents:read. Directions sent to a run, oldest first, with whether the agent has taken each into… - POSTRedirect a running run: the agent stops what it is doing at the next safe point and takes the new instruction into account.
/runs/:run_id/directionsBeta: may change without a new API version. Required scope: agents:write. Redirect a running run without cancelling it. The agent stops the step it is on at…
runs.events
- GETStream a run's events (Server-Sent Events) until it finishes: items as the agent works, proposals, and the final run. Resume with Last-Event-ID.
/runs/:run_id/eventsRequired scope: agents:read. Server-Sent Events, one per change, until the run finishes. Each event's id is its sequence_number; reconnect with Last-Event-ID…
sessions.goal
- GETGet a session's standing goal.
/sessions/:session_id/goalBeta: may change without a new API version. Required scope: agents:read. - PUTSet a session's standing goal. The agent starts working towards it at once, using your AI allowance.
/sessions/:session_id/goalBeta: may change without a new API version. Required scope: agents:write. - PATCHChange a session's standing goal or its status (active or paused). While the agent works, the change applies at its next safe point, so the call can take several seconds.
/sessions/:session_id/goalBeta: may change without a new API version. Required scope: agents:write.
signature_requests
- GETList signature requests. Filter with external_id.
/signature_requestsRequired scope: signatures:read. - POSTCreate a draft signature request from documents. Signers are {name, email} objects.
/signature_requestsRequired scope: signatures:write. - GETGet one signature request with its signers, fields and events.
/signature_requests/:signature_request_idRequired scope: signatures:read. - DELETEDelete a draft signature request.
/signature_requests/:signature_request_idRequired scope: signatures:write. - PATCHUpdate a draft's title, message, signers, fields, order and reminders.
/signature_requests/:signature_request_idRequired scope: signatures:write. - GETDownload the signed documents.
/signature_requests/:signature_request_id/downloadRequired scope: signatures:read. - PUTSet your system's identifier and metadata on a signature request.
/signature_requests/:signature_request_id/external_referenceRequired scope: signatures:write. - POSTRemind signers who have not signed.
/signature_requests/:signature_request_id/remindRequired scope: signatures:write. - POSTRetry making the signed copies of a completed request after that failed.
/signature_requests/:signature_request_id/retry_completionRequired scope: signatures:write. - POSTSend a draft for signature. Signers are emailed.
/signature_requests/:signature_request_id/sendRequired scope: signatures:write. - POSTSuggest signature fields for the current signers without saving them.
/signature_requests/:signature_request_id/suggest_fieldsRequired scope: signatures:write. - POSTWithdraw a request that is out for signature.
/signature_requests/:signature_request_id/voidRequired scope: signatures:write.
signature_requests.documents
- POSTAdd a document to a draft.
/signature_requests/:signature_request_id/documentsRequired scope: signatures:write. - DELETERemove a document from a draft.
/signature_requests/:signature_request_id/documents/:document_keyRequired scope: signatures:write. - POSTTake a new copy of a document from its current version.
/signature_requests/:signature_request_id/documents/:document_key/refreshRequired scope: signatures:write. - POSTRecord partner sign-off of an agent-drafted document.
/signature_requests/:signature_request_id/documents/:document_key/sign_offRequired scope: signatures:write.
signature_requests.signers
- PATCHUpdate a signer's name or email.
/signature_requests/:signature_request_id/signers/:signer_idRequired scope: signatures:write.
skills
- GETList the skills this account can run, with their versions and arguments.
/skillsRequired scope: agents:read. Skills this account can run. Pass id (and version to pin it) as a run's skill.
time.timer
- GETGet your timers: the running one, paused ones and stopped ones awaiting review, the same on every device.
/timerRequired scope: billing:read. - PUTSave your timers. Send the revision you last read; a 409 means another device changed them first.
/timerRequired scope: billing:write.
time
- GETGet recorded time and capture suggestions by day.
/timesheetRequired scope: billing:read.
uploads
- POSTStart a resumable upload of a Word document or PDF (up to 50 MB), or another document (up to 10 MB). Send parts, then complete it.
/uploadsRequired scope: documents:write. Start an upload. Send its parts, then complete it. - GETGet an upload's status and the parts received.
/uploads/:upload_idRequired scope: documents:write. An upload's status and the parts received so far. - POSTStop an upload and discard its parts.
/uploads/:upload_id/cancelRequired scope: documents:write. Stop an upload and discard its parts. - POSTCheck and assemble the parts and create the document. Completing again returns the same document.
/uploads/:upload_id/completeRequired scope: documents:write. Assemble the parts and create the document, exactly as a direct upload would. - PUTSend one part (up to 16 MiB) as the raw body. Sending a number again replaces it.
/uploads/:upload_id/parts/:part_numberRequired scope: documents:write. Send one part as the raw request body (up to 16 MiB). Sending a number again replaces that part.
usage
- GETReport AI tokens and estimated cost for your account by day, feature, matter, run, key or model.
/usageRequired scope: usage:read. Tokens and estimated cost (USD, as the matter ledger prices AI usage) for your account, grouped. Up to 93 days. - GETGet your agent allowance: what your plan includes, what you have used and when it resets.
/usage/limitsRequired scope: usage:read.
webhook_endpoints
- GETList the account's webhook endpoints and the event types they can subscribe to.
/webhook_endpointsRequired scope: webhooks:read. The account's webhook endpoints (at most 10), and every event type they can subscribe to. - POSTAdd a webhook endpoint. Its signing secret is returned only in this response.
/webhook_endpointsRequired scope: webhooks:write. Add a webhook endpoint. The signing secret is returned only now: store it. - GETGet one webhook endpoint.
/webhook_endpoints/:endpoint_idRequired scope: webhooks:read. One webhook endpoint. - DELETERemove a webhook endpoint.
/webhook_endpoints/:endpoint_idRequired scope: webhooks:write. Remove a webhook endpoint. Deliveries waiting for it are cancelled. - PATCHChange an endpoint's URL, note or event types, or stop and start its deliveries.
/webhook_endpoints/:endpoint_idRequired scope: webhooks:write. Change an endpoint's URL, note or event types, or stop and start its deliveries. Only the fields sent change. - POSTReplace an endpoint's signing secret. The old one also signs deliveries for 24 hours.
/webhook_endpoints/:endpoint_id/rotate_secretRequired scope: webhooks:write. A new signing secret, returned only now. For 24 hours deliveries are signed with both, so you can switch over. - POSTSend a test event to an endpoint.
/webhook_endpoints/:endpoint_id/testRequired scope: webhooks:write. Send a webhook.test event to the endpoint. Follow it in the endpoint's deliveries.
webhook_endpoints.deliveries
- GETList an endpoint's recent deliveries, with their status, attempts and last response.
/webhook_endpoints/:endpoint_id/deliveriesRequired scope: webhooks:read. The endpoint's recent deliveries, newest first: each event sent, its status, attempts and the last response. - POSTSend a delivery's event to its endpoint again, with the same event id.
/webhook_endpoints/:endpoint_id/deliveries/:delivery_id/redeliverRequired scope: webhooks:write. Send a delivery's event to the endpoint again, with the same event id. Events are kept for 30 days.
webhook_events
- GETList the account's events of the last 30 days, newest first.
/webhook_eventsRequired scope: webhooks:read. The account's events of the last 30 days, newest first, whether or not an endpoint received them.
workflow_interventions
- POSTApprove a waiting step and resume the run.
/workflow_interventions/:intervention_id/approveBeta: may change without a new API version. Required scope: workflows:write. - POSTReject a waiting step.
/workflow_interventions/:intervention_id/rejectBeta: may change without a new API version. Required scope: workflows:write.
workflow_runs
- GETList workflow runs.
/workflow_runsBeta: may change without a new API version. Required scope: workflows:read. - GETGet one workflow run.
/workflow_runs/:workflow_run_idBeta: may change without a new API version. Required scope: workflows:read. - POSTCancel a workflow run.
/workflow_runs/:workflow_run_id/cancelBeta: may change without a new API version. Required scope: workflows:write. - GETGet a workflow run's audit log.
/workflow_runs/:workflow_run_id/logsBeta: may change without a new API version. Required scope: workflows:read.
workflow_runs.interventions
- GETList the approvals a workflow run is waiting for.
/workflow_runs/:workflow_run_id/interventionsBeta: may change without a new API version. Required scope: workflows:read.
workflows
- GETList your workflows.
/workflowsBeta: may change without a new API version. Required scope: workflows:read. - POSTCreate a workflow.
/workflowsBeta: may change without a new API version. Required scope: workflows:write. - GETList the steps a workflow can use.
/workflows/capabilitiesBeta: may change without a new API version. Required scope: workflows:read. - GETList ready-made workflows for common matters.
/workflows/recipesBeta: may change without a new API version. Required scope: workflows:read. - GETGet one workflow.
/workflows/:workflow_idBeta: may change without a new API version. Required scope: workflows:read. - PUTUpdate a workflow.
/workflows/:workflow_idBeta: may change without a new API version. Required scope: workflows:write. - POSTRecompile a workflow's triggers.
/workflows/:workflow_id/compileBeta: may change without a new API version. Required scope: workflows:write. - POSTStart a workflow manually.
/workflows/:workflow_id/startBeta: may change without a new API version. Required scope: workflows:write.
API details
- Authentication
- A bearer token in the Authorization header
- Operations
- 202 operations on 164 pathsGET 88POST 81PUT 14PATCH 11DELETE 8
- Main resources
- documents 17matters 12signature_requests 12workflows 8webhook_endpoints 7api_keys 6clients 6finance.invoices 6questionnaire_templates 6runs 6
- Response formats
application/jsonapplication/pdfapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.oasis.opendocument.text- Webhooks
- 17 described
- Description format
- OpenAPI 3.1.0, API version
2026-10-21 - Links
- OpenAPI document
- Listed from
- Lexifina's published OpenAPI description
How to test the Lexifina External API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Lexifina External API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List the calling key and the keys it made, with this month's spend.” (GET /api_keys), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Lexifina External API?
Scoped personal API keys. Existing ownership, account security and usage quotas apply. Required scopes are listed on each operation. Every successful JSON… It is listed under Government & public and has 202 endpoints.
Who publishes the Lexifina External API?
It is listed from Lexifina's public API description (an OpenAPI document), not published by Lexifina on Swastik Codes. Anyone who controls lexifina.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Lexifina External API?
With A bearer token in the Authorization header.
How many endpoints does the Lexifina External API have?
202 operations on 164 paths (88 GET, 81 POST, 14 PUT, 11 PATCH, 8 DELETE). The largest groups are documents, matters, signature_requests, workflows.
Is forking the Lexifina External API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.