Overview

from pathlib import Path
from vlmrun.client import VLMRun
from vlmrun.client.types import PredictionResponse

# Initialize the client
client = VLMRun(api_key="<VLMRUN_API_KEY>")

# Document -> JSON
response: PredictionResponse = client.document.generate(
    file=Path("path/to/document.pdf"),
    model="vlm-1",
    domain="document.invoice",
)

import { VLMRun } from "vlmrun";

// Initialize the client
const client = new VLMRun({
    apiKey: "<VLMRUN_API_KEY>",
});

// Upload a document
const file = await client.files.upload({
  filePath: "path/to/invoice.pdf",
});

// Process a document using file ID
const response = await client.document.generate({
  fileId: file.id,
  model: "vlm-1",
  domain: "document.markdown",
});
console.log(response);

from vlmrun.client import VLMRun

# Initialize the VLM Run client
client = VLMRun(api_key="<VLMRUN_API_KEY>")

# Create a chat completion
response = client.agent.completions.create(
    model="vlmrun-orion-1:auto",
    messages=[
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "What do you see in this image?" },
                {"type": "image_url", "image_url": {"url": "https://example.com/image.jpg"}}
            ]
        }
    ],
    max_tokens=1000
)

import { VlmRun } from "vlmrun";

// Initialize the VLM Run client
const client = new VlmRun({
  apiKey: "<VLMRUN_API_KEY>"
});

// Create a chat completion
const response = await client.agent.completions.create({
  model: "vlmrun-orion-1:auto",
  messages: [
    {
      role: "user",
      content: [
        { type: "text", text: "What do you see in this image?" },
        { type: "image_url", image_url: { url: "https://example.com/image.jpg" } }
      ]
    }
  ],
  max_tokens: 1000
});
console.log(response.choices[0].message.content);

curl -X POST https://api.vlm.run/v1/openai/chat/completions \
  -H "Authorization: Bearer $VLMRUN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "vlmrun-orion-1:auto",
    "messages": [
      {
        "role": "user",
        "content": [
          { "type": "text", "text": "What do you see in this image?" },
          { "type": "image_url", "image_url": {"url": "https://example.com/image.jpg"}}
        ]
      }
    ],
    "max_tokens": 1000
  }'