Cancel Batch Job
jina.cancel_batch
ActionAI & modelsconnection required
Calls the Jina AI API with the connection's credentials.
Cancel a batch embedding job that is still running.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Jina AI
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url, default_embedding_model, default_reranker_model
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
batch_id The job to cancel. | string | Yes | — | — | batch_abc123 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"batch_id": "batch_abc123"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
batch_id Identifier of the batch job. | string | — |
status Job state: pending, processing, completed, failed, expired or cancelled. | string | — |
finished True once the job has reached a terminal state. | boolean | — |
succeeded True only when the job finished as 'completed'. | boolean | — |
model The embedding model the job runs. | string | — |
created_at When the job was created. | string | — |
completed_at When the job finished, if it has. | string | — |
expires_at When the output URL stops working. | string | — |
output_url Signed URL of the output JSONL, once completed. | string | — |
error_file_url URL of the per-line error JSONL, when lines failed. | string | — |
error Why the job failed, when it did. | string | — |
total Input lines submitted. | number | — |
completed Input lines embedded successfully. | number | — |
failed Input lines that failed. | number | — |
total_tokens Tokens billed across the job. | number | — |
{
"batch_id": "",
"completed": 0,
"completed_at": "",
"created_at": "",
"error": "",
"error_file_url": "",
"expires_at": "",
"failed": 0,
"finished": false,
"model": "",
"output_url": "",
"status": "",
"succeeded": false,
"total": 0,
"total_tokens": 0
}See Cancel Batch Job run in a workflow.
In a technical demo we add the Jina AI connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.