analyses

Cancel an analysis (best-effort once analyzing)

post/v1/analyses/{id}/cancel

Request

  • Base URL: https://api.primateintelligence.ai
  • URL: https://api.primateintelligence.ai/v1/analyses/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Canceled (or best-effort race documented in §14.2).

idstring required

Analysis resource id (prefixed ULID).

object'analysis' required
livemodeboolean required

true when the request used a live key; false for test keys and sandbox. Stripe-style.

origin'api' | 'console' | 'system' required

api — submitted via the public API; console — uploaded via the dashboard; system — generated internally (e.g. auto-probe, fixture seeding, run_prompt). System analyses are never billed. Agents should normally only process api/console-origin analyses. (Renamed 2026-07-27: former value user is now api.)

status'queued' | 'preparing' | 'analyzing' | 'rendering' | 'completed' | 'failed' | 'canceled' required

Analysis lifecycle state (§14.2). Clients MUST tolerate unknown future non-terminal values.

video_idstring required

Video resource id (prefixed ULID). Immutable.

promptstring nullable required
queryobject required

CompiledQuery (schema at /v1/schemas/compiled-query.json). Always populated in responses.

parse_mode'llm' | 'heuristic' | 'client' nullable required
modelstring required
queue_positioninteger nullable required
metering_rule'per_second' | 'per_frame'

PRI-552: settlement rule pinned at admission. Resources created before the cutover report per_second.

rerun_eligibleboolean

PRI-493: present on failed analyses — true when this analysis qualifies for ONE free re-run (it failed during a platform incident, or was flagged by ops). POST /v1/analyses/{id}/rerun creates a fresh analysis at no charge. Absent on non-failed analyses.

metadataobject

Free-form key/value metadata. ≤16 keys, key ≤40 chars [a-zA-Z0-9_.-], value ≤500 chars.

created_atstring date-time required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Example response

{
  "id": "an_01KX12XX3BNM688AWHX7406HCF",
  "video_id": "video_01KX12XX3BNM688AWHX7406HCF",
  "model": "Darwin-preview-1.3B",
  "result": {
    "unsupported_action": {
      "reason": "unsupported_query_form",
      "docs_url": "https://primateintelligence.ai/docs/supported-actions"
    }
  },
  "artifacts": {
    "expires_at": "2026-07-08T14:00:00Z"
  },
  "error": {
    "code": "video_unreadable"
  },
  "created_at": "2026-07-08T14:00:00Z",
  "started_at": "2026-07-08T14:00:00Z",
  "completed_at": "2026-07-08T14:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.