Sign in

v4

latestOpenAPI 3.1.02026-08-086635375.7 KB
Avatar Videos

Cancel an avatar video

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

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

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.

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

Example response

{
  "id": "avv_123"
}