Document

Create Web Document Processing Request By User

Posts an async request for a document file from a URL (image or PDF) processing with user authentication

Accepts:

  • Image files: PNG, JPEG, JPG, GIF, WEBP, HEIC/HEIF, AVIF
  • PDF files: PDF

Returns document ID and storage location for further processing

post/api/v1/documents/requests/user/web

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/requests/user/web
  • Auth: one of:
    • OAuth 2 (password, token URL token)
    • API key in header X-API-Key

Request body

createdAtstring date-time nullable
createdAtTimestampnumber nullable
externalIdstring required

External identifier for the document

endUserIdstring nullable

End User ID for the document

extractionTypesUploadExtractionTypeEnum[] required

Target extractions to perform on the document

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

Whether to use the Thinning model for the document

evaluationboolean nullable

Whether to use the Evaluation model for the document

correctionboolean nullable

Whether to use the Correction model for the document

includeCoordinatesboolean nullable

Whether to include coordinates in the extraction results

templateIdstring uuid nullable

Template ID for custom template extraction

urlstring uri required

URL for the document

Response

Successful Response

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

Changes

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