Pureframe AI API Documentation

Poll GET /v1/jobs/{job_id} until status is done or failed.

curl https://api.pureframe.ai/v1/jobs/job_xyz789 \
  -H "Authorization: Bearer pf_..."

{
  "data": {
    "job_id": "job_xyz789",
    "status": "processing",
    "progress_pct": 64
  }
}

Status values

Status	Meaning
`queued`	Waiting for processing to begin
`pending`	Preparing to process the video
`processing`	Actively being indexed: `progress_pct` updates live
`done`	Fully indexed and searchable
`failed`	Processing failed: retry the upload

A video is only searchable once its job reaches done. Searching before that returns no results for that video.

Polling recommendation

Use exponential backoff. For most videos, check at 5s, 10s, 20s intervals:

import time, httpx

def wait_for_job(job_id: str, api_key: str) -> dict:
    headers = {"Authorization": f"Bearer {api_key}"}
    delay = 5
    while True:
        resp = httpx.get(
            f"https://api.pureframe.ai/v1/jobs/{job_id}",
            headers=headers
        ).json()
        status = resp["data"]["status"]
        if status in ("done", "failed"):
            return resp["data"]
        time.sleep(delay)
        delay = min(delay * 2, 60)

Getting notified instead of polling

If you don’t want to poll, subscribe to job.completed and job.failed webhook events. See Webhooks.

If a job fails

When a job reaches failed, re-upload the video to create a new job. If the same file fails again, verify its container and codec, then contact support with the job_id and video_id.