API Reference
Document Parse Jobs
Start, poll, and apply AI-assisted document field detection jobs.
Document Parse Jobs
Start, poll, and apply AI-assisted document field detection jobs.
Endpoints
POST
/api/v1/documents/{id}/parse-jobsStart parse job — Creates an AI-assisted parse job for the document original file. Requires the documents:parse_ai permission.
Required permissions:documents:writedocuments:parse_ai
client.documents.byId("ID").parseJobs.post(body)GET
/api/v1/documents/{id}/parse-jobs/{jobId}Get parse job status
Required permissions:documents:read
client.documents.byId("ID").parseJobs.byJobId("JOBID").get()POST
/api/v1/documents/{id}/parse-jobs/{jobId}/applyApply preview parse job — Applies a completed preview parse result to the document draft. Requires the documents:parse_ai permission.
Required permissions:documents:writedocuments:parse_ai
client.documents.byId("ID").parseJobs.byJobId("JOBID").apply.post(body)This page is auto-generated from the OpenAPI spec. Run npm run docs:generate to update.