Skip to main content
POST
/
v1
/
buckets
/
{bucket_identifier}
/
batches
/
{batch_id}
/
cancel
Cancel Batch
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "task_id": "task_123",
  "task_type": "api_namespaces_create",
  "status": "IN_PROGRESS",
  "inputs": [
    "file1.pdf",
    {
      "config": {
        "key": "value"
      }
    }
  ],
  "outputs": [
    "processed_file1.pdf",
    {
      "result": "success"
    }
  ],
  "additional_data": {
    "priority": "high",
    "user_id": "user_456"
  },
  "error_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

​
bucket_identifier
string
required

The unique identifier of the bucket.

​
batch_id
string
required

The unique identifier of the batch.

Response

Successful Response

Task response.

​
task_id
string
required

Unique identifier for the task

Example:

"task_123"

​
task_type
enum<string>
required

Type of the task

Available options:
api_namespaces_create,
api_buckets_objects_create,
api_buckets_delete,
api_buckets_batches_process,
api_buckets_batches_submit,
api_taxonomies_create,
api_taxonomies_execute,
api_taxonomies_materialize,
engine_feature_extractor_run,
engine_inference_run,
engine_object_processing,
engine_cluster_build,
thumbnail,
materialize
​
status
enum<string>
required

Current status of the task

Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
​
inputs
Inputs · array

List of input parameters or data for the task

Example:
[
  "file1.pdf",
  { "config": { "key": "value" } }
]
​
outputs
Outputs · array

List of output results from the task

Example:
[
  "processed_file1.pdf",
  { "result": "success" }
]
​
additional_data
object | null

Additional metadata or context for the task

Example:
{ "priority": "high", "user_id": "user_456" }
​
error_message
string | null

Flattened error message derived from additional_data['error'] if present.

⌘I