Document

Add extraction types to an existing document

Run additional extraction types on a document that is already stored.

No upload: the document's stored artifacts are reused and only the extraction step runs. Billed per extraction like an upload. Returns the whole document (all extractions, old and new). When the new extractions are still running the response is HTTP 202 and pollCorrelationId / Location point at the existing results endpoint.

post/api/v1/documents/{document_id}/extractions

Request

  • Base URL: https://api.gemina.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.gemina.co/api/v1/documents/{document_id}/extractions
  • Auth: API key in header X-API-Key

Path parameters

document_idstring uuid required

Request body

extractionTypesUploadExtractionTypeEnum[] required

Extraction types to add to the existing document

modelType'gemina' | 'google' | 'openai' | 'velox' | 'praetorian' | 'invictus'
thinkingboolean nullable

Enable extended reasoning; defaults to the account setting

evaluationboolean nullable

Enable self-evaluation of the extracted data; defaults to the account setting

correctionboolean nullable

Enable self-correction of the extracted data; defaults to the account setting

includeCoordinatesboolean nullable

Return per-field bounding boxes; defaults to the account setting

templateIdstring uuid nullable

Custom template to extract with; required by (and only valid with) the custom_template type

Response

Successful Response

status'pending' | 'in_process' | 'failed' | 'success' | 'partial' | 'empty' required
errorsobject[]
createdAtstring date-time nullable
createdAtTimestampnumber nullable
newExtractionIdsstring[]

Ids of the extractions this call created

pollCorrelationIdstring uuid required

Correlation id to poll for the document's completion

Changes

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