What is the VLM Run Gateway?
What is the VLM Run Gateway?
An OpenAI-compatible API for visual AI: OCR, VQA, document extraction, and text detection,
all behind one base URL and one
Authorization header. See Introduction
for the full rationale.How is this different from a general-purpose LLM gateway?
How is this different from a general-purpose LLM gateway?
General-purpose routers are built for text and carry lots of LLMs, but only a small slice of
visual workloads. The VLM Run Gateway is built for OCR and VQA, and exposes each supported
model through the same
chat.completions shape so switching models is a one-line change.Does the Gateway support PDFs and multi-page documents?
Does the Gateway support PDFs and multi-page documents?
Yes. Pass a PDF as a
document_url content part and the Gateway decodes it, fans out per-page
inference, and returns the assembled pages, concatenated or streamed, through the same chat
completions response. In text mode that is one <document> block per PDF, wrapping one
<page> block per page; method decides each page’s body, and the page declares it in
format. Pass multiple document_url parts to get one block per input. See
Flexible Document OCR for the full walkthrough, including the
method and document_dpi knobs for tuning cost, latency, and accuracy per request.Can I get JSON that matches my own schema?
Can I get JSON that matches my own schema?
Not on the Gateway.
response_format={"type":"json_object"} returns the
Gateway’s own response object.For extraction against a schema you define, use the VLM Run API, which supports
structured responses,
custom schemas, and the prebuilt schemas in the
VLM Run Hub. See
Methods & Response Format for the
Gateway’s full contract.Does the Gateway do embeddings and audio transcription too?
Does the Gateway do embeddings and audio transcription too?
Yes, behind the same base URL and API key as chat completions. See
Embeddings and
Audio Transcriptions
for request schemas, or Models
for the models that back each endpoint.
How much does it cost?
How much does it cost?
The Gateway is free during the alpha, subject to per-tier rate limits. Formal pricing
(per-request and per-page) is coming; until then, watch
usage.cost on chat completion
responses for a per-request cost signal. See Pricing and
Rate Limits.Do I need an API key?
Do I need an API key?
Not to start. Every endpoint accepts anonymous access today, rate limited per IP. Authenticate
with an API key from app.vlm.run to get usage attributed to your account
instead of a shared IP bucket, which matters once you’re building something you plan to run in
production. See Authentication.
Is the Gateway production ready?
Is the Gateway production ready?
The Gateway is in alpha: free, rate-limited, and the model catalog is intentionally small.
It already returns a live model catalog, per-request
usage.cost for metering, x-request-id
for tracing, and sanitized error responses. Authenticate with an API key if you’re building
something you plan to run in production, since alpha limits are subject to change.How do I choose between models or methods?
How do I choose between models or methods?
Use
qwen/qwen3.5-0.8b for VQA over images or video. It does not accept
document_url, so use an OCR model for PDFs.
Use paddleocr/pp-ocrv6 for general OCR or method: "detect" when you only
need bounding polygons. zai-org/glm-ocr serves markdown.
rednote-hilab/dots.mocr also defaults to markdown and adds
parse_layout for structured document layout, plus parse_layout_only and
ocr. Use paddlepaddle/pp-doclayoutv3 when you want layout regions, labels,
and reading order without text recognition, for example as the layout stage
ahead of an OCR model.
For documents, treat model, method, and document_dpi as one tunable unit:
start with the cheapest combination that clears your accuracy bar on your own
data, and only pay for more where it actually moves the numbers.Related
Introduction
Why the VLM Run Gateway exists and what it’s built to help you do.
Models
Full catalog with availability, methods, and accepted inputs.
Methods
Per-model method reference and request parameters.
Quickstart
First requests for VQA and document OCR.