POST
/
v1
/
schema
curl --request POST \
  --url https://api.vlm.run/v1/schema \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {
    "prompt": "<string>",
    "detail": "auto",
    "response_model": "<any>",
    "json_schema": {},
    "gql_stmt": "<string>",
    "max_retries": 3,
    "max_tokens": 4096,
    "temperature": 0,
    "confidence": false,
    "grounding": false
  },
  "domain": "<string>"
}'
{
  "domain": "<string>",
  "description": "<string>",
  "schema_version": "<string>",
  "schema_hash": "<string>",
  "gql_stmt": "<string>",
  "json_schema": {}
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Schema request model for internal schemas: /v1/schema

​
domain
string
required

The domain to get the schema for (e.g. document.invoice).

​
config
object

The VLM generation config to be used for /<dtype>/generate.

Response

200
application/json
Successful Response

Response model for internal schemas (/v1/schema)

​
domain
string
required

The domain to get the schema for.

​
description
string
required

The description of the domain.

​
schema_version
string
required

The specific version of the schema.

​
schema_hash
string
required

The sha256 hash of the schema.

​
gql_stmt
string
required

The GraphQL statement for the domain.

​
json_schema
object
required

The JSON schema for the domain.