Skip to main content
POST
/
v1
/
hub
/
schema
!pip install vlmrun

from vlmrun.client import VLMRun

client = VLMRun(api_key="<VLMRUN_API_KEY>")
response = client.hub.get_schema(domain="document.invoice")

{
  "domain": "<string>",
  "description": "<string>",
  "schema_version": "<string>",
  "schema_hash": "<string>",
  "gql_stmt": "<string>",
  "json_schema": {},
  "json_sample": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.vlm.run/llms.txt

Use this file to discover all available pages before exploring further.

!pip install vlmrun

from vlmrun.client import VLMRun

client = VLMRun(api_key="<VLMRUN_API_KEY>")
response = client.hub.get_schema(domain="document.invoice")

​
Description

This endpoint returns the JSON schema for a given domain, as defined in the VLM Run Hub.

Body

application/json

Request model for the hub schema: /v1/hub/schema

​
domain
string
required

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

​
config
GenerationConfig · object

The VLM generation config to be used for //generate.

Response

Successful Response

Response model for the hub schema: /v1/hub/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
Json Schema · object
required

The JSON schema for the domain.

​
json_sample
Json Sample · object

A sample JSON object that matches the schema.