POST
/
v1
/
image
/
schema
curl --request POST \
  --url https://api.vlm.run/v1/image/schema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "callback_url": "<string>",
  "model": "vlm-1",
  "images": [
    "<string>"
  ]
}'
{
  "usage": {
    "elements_processed": 123,
    "element_type": "image",
    "credits_used": 123,
    "steps": 123,
    "message": "<string>"
  },
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "response": "<any>",
  "status": "pending"
}

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 an image (jpeg, png, gif, webp).

​
images
string[]
required

List of base64 encoded images or URLs to the images.

​
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

The model to use for generating the response.

Allowed value: "vlm-1"

Response

201
application/json
Successful Response

Base prediction response for all API responses.

​
usage
object

The usage metrics for the request.

​
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
enum<string>
default:pending

The status of the job.

Available options:
pending,
enqueued,
running,
completed,
failed,
paused