Cancel a video generation

POST

/v1/video-generations/{generationId}/cancel

Requests cancellation for a generation owned by the authenticated workspace. Completed, failed, or already-cancelled generations cannot be cancelled.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Generation cancelled.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/video-generations//cancel' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "Customer requested cancellation before completion."
}'

Response Example

200 - Cancelled generation

{
    "id": "job_01HXAMPLE",
    "status": "cancelled",
    "statusDetail": "Cancelled",
    "progress": 42,
    "video": {
        "durationTargetSeconds": 45,
        "aspectRatio": "9:16",
        "resolution": "1080p",
        "qualityTier": "balanced"
    },
    "creative": {
        "format": "newsExplainer"
    },
    "resultUrl": null,
    "errorCode": "JOB_CANCELLED",
    "errorMessage": "Customer requested cancellation before completion.",
    "createdAt": "2026-05-13T10:00:00.000Z",
    "updatedAt": "2026-05-13T10:04:00.000Z",
    "completedAt": "2026-05-13T10:04:00.000Z"
}

Modified at 2026-05-24 15:07:59

Get completed generation result

Create a researched video generation