Quickstart

from pathlib import Path
from vlmrun.client import VLMRun
from vlmrun.client.types import GenerationConfig, AgentSkill

client = VLMRun(api_key="<VLMRUN_API_KEY>")

response = client.document.generate(
    file=Path("invoice.pdf"),
    model="vlm-1",
    config=GenerationConfig(
        skills=[AgentSkill(skill_name="invoice-extraction", version="latest")]
    ),
)

print(response.response)

import { VlmRun } from "vlmrun";

const client = new VlmRun({ apiKey: "<VLMRUN_API_KEY>" });

const fileResponse = await client.files.upload({ filePath: "invoice.pdf" });
const response = await client.document.generate({
    fileId: fileResponse.id,
    model: "vlm-1",
    config: {
        skills: [{ skillName: "invoice-extraction", version: "latest" }],
    },
});

console.log(response.response);

curl -X POST https://api.vlm.run/v1/document/generate \
  -H "Authorization: Bearer <VLMRUN_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "vlm-1",
    "file_id": "<file-id>",
    "config": {
      "skills": [{"skill_name": "invoice-extraction", "version": "latest"}]
    }
  }'