Get Model

import httpx
from urllib.parse import quote

model_id = quote("paddleocr/pp-ocrv6", safe="")
response = httpx.get(
    f"https://gateway.vlm.run/v1/models/{model_id}",
    headers={"Authorization": "Bearer <VLMRUN_API_KEY>"},
)
print(response.json())

curl "https://gateway.vlm.run/v1/models/paddleocr%2Fpp-ocrv6" \
  -H "Authorization: Bearer $VLMRUN_API_KEY"

const modelId = encodeURIComponent("paddleocr/pp-ocrv6");
const response = await fetch(`https://gateway.vlm.run/v1/models/${modelId}`, {
  headers: { Authorization: "Bearer <VLMRUN_API_KEY>" },
});
console.log(await response.json());

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "architecture": {
    "input_modalities": [
      "<string>"
    ],
    "output_modalities": [
      "<string>"
    ],
    "modality": "<string>"
  },
  "capabilities": {
    "max_images": 1,
    "max_videos": 0,
    "supports_text_only": true,
    "supports_document_url": false,
    "supported_input_types": [
      "<string>"
    ]
  },
  "pricing": {
    "prompt": 0,
    "completion": 0,
    "input_cache_read": 0,
    "input_cache_write": 0,
    "image": 0
  },
  "hf_model_id": "<string>",
  "task": "chat",
  "context_length": 123,
  "aliases": [
    "<string>"
  ],
  "methods": [
    "<string>"
  ],
  "supported_parameters": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

models

{model_id}

import httpx
from urllib.parse import quote

model_id = quote("paddleocr/pp-ocrv6", safe="")
response = httpx.get(
    f"https://gateway.vlm.run/v1/models/{model_id}",
    headers={"Authorization": "Bearer <VLMRUN_API_KEY>"},
)
print(response.json())

curl "https://gateway.vlm.run/v1/models/paddleocr%2Fpp-ocrv6" \
  -H "Authorization: Bearer $VLMRUN_API_KEY"

const modelId = encodeURIComponent("paddleocr/pp-ocrv6");
const response = await fetch(`https://gateway.vlm.run/v1/models/${modelId}`, {
  headers: { Authorization: "Bearer <VLMRUN_API_KEY>" },
});
console.log(await response.json());

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "architecture": {
    "input_modalities": [
      "<string>"
    ],
    "output_modalities": [
      "<string>"
    ],
    "modality": "<string>"
  },
  "capabilities": {
    "max_images": 1,
    "max_videos": 0,
    "supports_text_only": true,
    "supports_document_url": false,
    "supported_input_types": [
      "<string>"
    ]
  },
  "pricing": {
    "prompt": 0,
    "completion": 0,
    "input_cache_read": 0,
    "input_cache_write": 0,
    "image": 0
  },
  "hf_model_id": "<string>",
  "task": "chat",
  "context_length": 123,
  "aliases": [
    "<string>"
  ],
  "methods": [
    "<string>"
  ],
  "supported_parameters": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authentication is optional. See Rate Limits for per-tier quotas. For the full catalog, use List Models or see Models. model_id is a path parameter, so any / in the id (e.g. paddleocr/pp-ocrv6) must be percent-encoded as %2F. An unencoded slash is read as two path segments and returns 404.

import httpx
from urllib.parse import quote

model_id = quote("paddleocr/pp-ocrv6", safe="")
response = httpx.get(
    f"https://gateway.vlm.run/v1/models/{model_id}",
    headers={"Authorization": "Bearer <VLMRUN_API_KEY>"},
)
print(response.json())

curl "https://gateway.vlm.run/v1/models/paddleocr%2Fpp-ocrv6" \
  -H "Authorization: Bearer $VLMRUN_API_KEY"

const modelId = encodeURIComponent("paddleocr/pp-ocrv6");
const response = await fetch(`https://gateway.vlm.run/v1/models/${modelId}`, {
  headers: { Authorization: "Bearer <VLMRUN_API_KEY>" },
});
console.log(await response.json());

Response fields

This endpoint returns a flat, single-model detail object, richer than the entries in GET /v1/openai/models:

Field	Description
`id`	Preferred public model id.
`name`, `description`	Human-readable catalog metadata.
`hf_model_id`	Upstream Hugging Face repo id, when the model is open-weight.
`task`	`chat`, `embed`, or `transcribe`.
`context_length`	Maximum context length, when defined.
`architecture`	`input_modalities`, `output_modalities`, and a summary `modality` string.
`capabilities`	Same shape as on List Models: max images/videos, accepted input types.
`aliases`, `methods`	Accepted request ids and supported `method` values.
`supported_parameters`	Request fields this model actually honors (a model may ignore fields like `temperature` or `top_p` that don’t apply to it).
`pricing`	USD per 1M tokens for `prompt`, `completion`, `image`, `input_cache_read`, and `input_cache_write`, plus `request` and `per_page` flat rates. Zero during the free alpha; see Pricing.

pricing and supported_parameters are only available here, not on the list endpoint. Fetch a single model’s detail before you build cost estimates or validate which request fields it will respect.

List Models

Full catalog in one call.

Pricing

How to read the pricing object during the free alpha.

Authorizations

Authorization

string

header

required

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

Path Parameters

model_id

string

required

Response

Successful Response

Flat JSON response for GET /v1/models/{model_id}.

Internal catalog fields such as provider are intentionally omitted.

string

required

name

string

required

description

string

required

architecture

ModelArchitecture · object

required

Hide child attributes

architecture.input_modalities

string[]

required

architecture.output_modalities

string[]

required

architecture.modality

string

required

capabilities

ModelCapabilities · object

required

Declared input capabilities exposed via GET /v1/openai/models.

Describes how many images / videos a model accepts and whether it supports text-only prompts, so clients can validate a request before sending it. None means unlimited (no cap on that input type).

Hide child attributes

capabilities.max_images

integer | null

default:1

capabilities.max_videos

integer | null

default:0

capabilities.supports_text_only

boolean

default:true

capabilities.supports_document_url

boolean

default:false

capabilities.supported_input_types

string[]

pricing

ModelPricing · object

required

USD per 1M tokens (image is per-1M image-token equivalent).

Hide child attributes

pricing.prompt

number

default:0

pricing.completion

number

default:0

pricing.input_cache_read

number

default:0

pricing.input_cache_write

number

default:0

pricing.image

number

default:0

hf_model_id

string | null

task

enum<string>

default:chat

Available options:

chat,

embed,

transcribe

context_length

integer | null

aliases

string[]

methods

string[]

supported_parameters

string[]

List Models Embeddings

Overview

Guides

API Reference

Misc

Response fields

List Models

Pricing

Authorizations

Path Parameters

Response

​Response fields

​Related

List Models

Pricing

Authorizations

Path Parameters

Response

Response fields

Related