Jobs

Create a document parsing job

Enqueues a new document for parsing. The worker will pick it up and process it asynchronously.

post/jobs

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/jobs
  • Auth: HTTP bearer

Request body

s3Keystring required

S3 object key for the document

personIdinteger required

Person ID this document belongs to

uploadedByUserIdinteger required

User ID who uploaded the document

documentIdinteger required

Document record ID in estate_documents

documentTypeHintstring

Optional hint for document type

uploaderNamestring

Name of the uploader for contact matching

Example request

{
  "s3Key": "uploads/123/doc.pdf",
  "personId": 42,
  "uploadedByUserId": 7,
  "documentId": 101,
  "documentTypeHint": "will",
  "uploaderName": "Jane Smith"
}

Response

Job enqueued

jobIdstring
status'queued' | 'processing' | 'completed' | 'failed' | 'partial'
progressnumber
resultobject
errorstring
createdAtstring date-time
finishedAtstring date-time

Example response

{
  "jobId": "doc-101-1711820400000",
  "progress": 50
}

Changes

No recorded changes to this operation across all 1 revision of this API.