Generate
Document -> JSON
Generate structured prediction for the given document.
POST
/
v1
/
document
/
generate
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
id
string
Unique identifier of the request.
created_at
string
Date and time when the request was created (in UTC timezone)
file_id
string | null
The ID of the uploaded file.
url
string | null
The URL of the audio file (provide either file_id
or url
).
model
enum<string>
requiredThe model to use for generating the response.
Available options:
vlm-1
domain
default: document.file
The domain identifier for the model.
Available options:
document.file
, document.pdf
, document.generative
, document.presentation
, document.invoice
, document.receipt
, document.resume
batch
boolean
default: trueWhether to process the document in batch mode (async).
metadata
object | null
Optional metadata to pass to the model.
Response
201 - application/json
id
string
Unique identifier of the response.
created_at
string
Date and time when the request was created (in UTC timezone)
completed_at
string | null
Date and time when the response was completed (in UTC timezone)
response
any | null
The response from the model.
status
string
default: pendingThe status of the job.