Batch Processing

Cancel a batch job

Changed on Aug 26, 2026

Cancels a batch job. This will stop the batch job from being processed further. Policy-first endpoint: batch jobs are created from a policy_id.

post/v1/batch-jobs/{batchJobId}/cancel

Request

Base URL
https://gateway.app.clavata.ai:8443
Auth
HTTP bearer
TypeScript
https://skmtc.dev/clavata/apis/clavata-public-api-v1/docs/v1/batch-jobs/:batchJobId/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

batchJobIdstring required

The ID of the batch job to cancel

Request body

V1GatewayServiceCancelBatchJobBody required

Response

A successful response.

batchJobIdstring

state'BATCH_JOB_STATE_UNSPECIFIED' | 'BATCH_JOB_STATE_ERROR' | 'BATCH_JOB_STATE_INITIALIZED' | 'BATCH_JOB_STATE_QUEUED' | 'BATCH_JOB_STATE_PREPROCESSING' | 'BATCH_JOB_STATE_PREPROCESSED' | 'BATCH_JOB_STATE_SUBMITTED' | 'BATCH_JOB_STATE_POSTPROCESSING' | 'BATCH_JOB_STATE_POSTPROCESSED' | 'BATCH_JOB_STATE_COMPLETED' | 'BATCH_JOB_STATE_CANCELLED' | 'BATCH_JOB_STATE_EVALUATING'

Changes

Aug 26, 2026b7cf208dca32 Revision changes
- warning
  added the new BATCH_JOB_STATE_EVALUATING enum value to the response property for the response status

Operation history