API ReferenceDocument Insights

List extractions

Returns recent Document Insights extractions with status, document summary, and paging details. Use this endpoint for history and status views. Use Get extraction for the full output.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Query parameters

pageintegerOptional1-100Defaults to 50

Zero-based page index. Defaults to 0.

sizeintegerOptional1-100Defaults to 50
Page size between 1 and 100. Defaults to 50.
statusenumOptional
Filter by extraction status.
Allowed values:
fromdatetimeOptional

Return extractions created at or after this UTC ISO-8601 timestamp.

todatetimeOptional

Return extractions created at or before this UTC ISO-8601 timestamp.

sortByenumOptional
Field used to sort the list. Defaults to createdAt.
Allowed values:
sortenumOptional
Sort direction. Defaults to desc.
Allowed values:
tagsmap from strings to stringsOptional

Filter by tags using tags[key]=value. Use tags[key]= (empty value) to match extractions that have the tag, or tags[key]=value for an exact match. Multiple keys are combined with AND. Example: ?tags[docType]=lab-result&tags[customerDocumentId]=lab-42.

Response

One page of extractions, without the full output.

datalist of objects
Items on the requested page.
pageInfoobject
Paging details for this result set.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error