The Platform API

Exports

Manage your videos, ask questions, and build applications with the Platform API. Explore the operations below for request details, responses, and examples.

Exports

Turn any Markdown document — a chat answer, a job result, a summary — into a PDF, an evidence pack, or a message on one of your notification channels. Every export is recorded in the project's audit log.

POST/api/v1/projects/:projectId/exports/pdfRender a document as PDF

Render a document as PDF

Body: markdown (required, up to 1 MB), title, footer, kind (for example job_result, summary, chat_answer) and resource_id. Returns the PDF file. Answers 503 if PDF rendering is unavailable.

POST/api/v1/projects/:projectId/exports/evidence-packDownload an evidence pack

Download an evidence pack

Returns a ZIP with the document (and its PDF when available), the frames and clips you list, and a manifest.json with each file's SHA-256 checksum. Up to 40 frames and 20 clips of at most 60 seconds each. Needs the right to download evidence packs; one pack at a time per caller.

{
    "title": "Incident at gate 3",
    "markdown": "## What happened\nA vehicle entered at 14:32...",
    "kind": "alert",
    "resource_id": "ALERT_ID",
    "frames": [{ "videoId": "VIDEO_ID", "start": 872.5, "label": "Vehicle enters" }],
    "clips": [{ "videoId": "VIDEO_ID", "start": 865, "end": 895 }]
  }

POST/api/v1/projects/:projectId/exports/sendSend a document to a notification channel

Send a document to a notification channel

Body: channel_id (one of the project's notification channels), markdown, title, up to 4 frames, and attach: pdf to attach the PDF where the channel supports it. Needs the right to send to channels. Returns { "sent": true, "attached": "pdf" }.

Exports are rate limited per caller; a 429 with rate_limited means wait a few minutes.