Cancel the remaining items
View as Markdown · Open in Claude Desktop
- Endpoint
POST /v1/batches/{id}/cancel- Who can call it
- An API key, or an OAuth token for an app.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Examples
Set NEATTRIM_API_KEY to your key, then copy an example. A tool that draws from your allowance reads an uploaded file: upload a sample file as in the quickstart and set VIDEO_FILE_ID (or AUDIO_FILE_ID, IMAGE_FILE_ID, SUBTITLES_FILE_ID) to its file_id. Any other id in an example, such as JOB_ID, is read from a variable of the same name.
curl -X POST "https://api.neattrim.com/v1/batches/$BATCH_ID/cancel" \
-H "Authorization: Bearer $NEATTRIM_API_KEY"Response
200- Batch
Response 200 Name Type Required Description batch_idstring yes toolstring no statusany yes (one of "queued", "working", "completed", "cancelled") itemsarray of object yes usageany no zip_urlstring or null no
Errors
401- UNAUTHENTICATED or INACTIVE
404- NOT_FOUND (also for other accounts' ids)
429- RATE_LIMITED