Doc -> JSON - VLM Run

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to the VLM API using a document (doc, docx, pptx, pdf).

batch

boolean

default:

true

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

callback_url

string | null

The URL to call when the request is completed.

Minimum length: 1

created_at

string

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

detail

enum<string>

default:

auto

The detail level to use for the model.

Available options:

auto,

hi,

lo

domain

default:

document.file

The domain identifier for the model.

Available options:

document.file,

document.pdf,

document.generative,

document.invoice,

document.markdown,

document.presentation,

document.receipt,

document.resume,

document.utility-bill,

healthcare.patient-referral,

healthcare.patient-medical-history,

healthcare.patient-consent,

healthcare.patient-intake,

healthcare.patient-insurance-card,

healthcare.patient-identification

file_id

string | null

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

string

Unique identifier of the request.

json_schema

object | null

The schema to use for the model.

metadata

object | null

Optional metadata to pass to the model.

model

string

default:

vlm-1

The model to use for generating the response.

Allowed value: "vlm-1"

url

string | null

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

Response

201 - application/json

Base prediction response for all API responses.

completed_at

string | null

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

created_at

string

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

string

Unique identifier of the response.

response

any | null

The response from the model.

status

string

default:

pending

The status of the job.