POST
/
v1
/
experimental
/
document
/
embeddings

Authorizations

Authorization
string
headerrequired

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

Body

application/json

Request to the VLM API for embedding a document.

url
string | null

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

file_id
string | null

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

id
string

Unique identifier of the request.

created_at
string

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

callback_url
string | null

The URL to call when the request is completed.

Minimum length: 1
model
string
default: vlm-1-embeddings

The model identifier.

Allowed value: "vlm-1-embeddings"
batch
boolean
default: false

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

metadata
object | null

Optional metadata to pass to the model.

Response

201 - application/json

Base prediction response for all API responses.

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: pending

The status of the job.