document
document

Document Generate

Changed on

Generate structured prediction for the given document.

post/v1/document/generate

Request

  • Base URL: https://api.vlm.run (the document declares no server; this is the origin it was published from)
  • URL: https://api.vlm.run/v1/document/generate
  • Auth: HTTP bearer

Request body

urlstring nullable

The URL of the file (provide either file_id or url).

file_idstring nullable

The ID of the uploaded file (provide either file_id or url).

idstring

Unique identifier of the request.

created_atstring date-time

Date and time when the request was created (in UTC timezone)

callback_urlstring uri nullable

The URL to call when the request is completed.

batchboolean

Whether to process the document in batch mode (async).

Response

Successful Response

idstring

Unique identifier of the response.

created_atstring date-time

Date and time when the request was created (in UTC timezone)

completed_atstring date-time nullable

Date and time when the response was completed (in UTC timezone)

responseunknown
status'pending' | 'enqueued' | 'running' | 'completed' | 'failed' | 'paused'

The status of the job.

domainstring nullable

The domain of the prediction (e.g. document.invoice, image.caption).

fallbackboolean

True when the JSON was produced by a fallback model. False when the primary model succeeded.

Changes