Gateway

Cancel batch

Cancels a batch request.

post/batches/{batch_id}/cancel

Request

  • Base URL: https://api.phaseo.app/v1
  • URL: https://api.phaseo.app/v1/batches/{batch_id}/cancel
  • Auth: HTTP bearer

Path parameters

batch_idstring required

The ID of the batch to cancel.

Response

Batch status response

idstring
native_batch_idstring nullable

Provider-native batch id when it differs from the gateway-owned id.

objectstring
endpointstring
errorsobject
input_file_idstring
completion_windowstring
statusstring
lifecycle_status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' | 'expired'

Normalized async lifecycle status for polling, websocket, and webhook consumers.

progressinteger

Coarse batch completion percentage derived from provider request counts when available. Completed batches report 100.

polling_urlstring uri
websocket_urlstring uri

WebSocket URL for subscribing to normalized async job lifecycle updates.

cancel_urlstring uri nullable

Reserved for compatibility; currently always null.

results_urlstring uri nullable

Authenticated Phaseo JSONL download URL for terminal supported batches. Null while processing. A terminal batch may have no output. Use an API key from the owning workspace; provider retention limits apply.

output_file_idstring
error_file_idstring
created_atinteger
in_progress_atinteger
expires_atinteger
finalizing_atinteger
completed_atinteger
failed_atinteger
expired_atinteger
cancelling_atinteger
cancelled_atinteger
metadataobject
request_idstring
providerstring
session_idstring
next_webhook_retry_atstring nullable
last_webhook_progressnumber nullable
last_webhook_progress_atstring nullable
last_webhook_dispatched_atstring nullable
finalized_atstring nullable
pricing_linesobject[]

Example response

{
  "webhook": {
    "delivery": {
      "delivered_event_types": [
        "video.completed"
      ]
    },
    "attempts": [
      {
        "delivery_key": "video.completed",
        "event_type": "video.completed"
      }
    ]
  }
}

Changes

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