ANanam
Avatar Videos

Cancel an avatar video

Changed on

Requests a clean worker/session shutdown. Terminal cancellation is idempotent and any replay that finalizes later remains accessible.

post/v1/avatar-videos/{id}/cancel

Request

  • Base URL
    https://api.anam.ai
  • URL
    https://api.anam.ai/v1/avatar-videos/{id}/cancel
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

Current cancelled or already-terminal resource

idstring required
status'pending' | 'running' | 'finalizing' | 'completed' | 'failed' | 'cancelled' required
completionReason'script_completed' | 'max_duration_reached' | 'cancelled' | 'null' nullable
truncatedboolean required
durationSecondsnumber nullable
effectiveMaxDurationSecondsinteger required
sessionIdstring nullable

Underlying normal EngineSession ID. Use its recording deletion endpoint for deletion.

region'eu' | 'us' | 'null' nullable required

Region the job is pinned to: eu when created on api.eu.anam.ai, us when created on api.us.anam.ai. Its session, recording and retries stay in that region. Null when created on api.anam.ai.

zeroDataRetentionboolean required

Whether the job runs with Zero Data Retention, which keeps its script, and a direct request's style prompts, out of Lab's database. A persona-sourced job's director notes stay in its stored persona. Always true for a job created on a regional host.

retryOfstring nullable
createdAtstring date-time required
startedAtstring date-time nullable
completedAtstring date-time nullable
metadataobject required

Example response

{
  "id": "avv_123"
}

Changes

  • e85ef0cd491eRevision changes
    • info

      added the non-success response with the status

  • 6767eb6e88fbRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status