SATIK API · V1 BETA

Cancel remaining batch work

Requires a live key. Idempotently cancels unstarted rows. Started verifications may finish and consume quota; cancelling becomes cancelled after settlement. Completed batches remain completed. No body required.

POST

https://api.satik.in/v1/batches/{batch_id}/cancel

Use a server-side Bearer API key. Authentication guide →

Parameters

Endpoint parameters
Parameter	Requirement and type
Batch id`batch_id`	Required · path parameter · string.

Full parameter schema

[
  {
    "name": "batch_id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Sample request (cURL)

Set the Postman variable SATIK_LIVE_KEY to a live key from your workspace.

curl --request POST 'https://api.satik.in/v1/batches/{{BATCH_ID}}/cancel' \
  --header 'Authorization: Bearer {{SATIK_LIVE_KEY}}'

Set BATCH_ID to a batch in your workspace. No body is required. Cancellation stops work that has not started; already-started verifications may finish and consume quota. Repeating this request is safe. Read progress until status is cancelled; completed jobs stay completed.

In Postman, choose Import and paste this cURL command. These double-brace variables are resolved by Postman; for a terminal request, replace them with actual values. For local testing, replace https://api.satik.in/v1 with http://localhost:3001/api/v1, keeping the endpoint path.

Responses and errors

HTTP 200

{
  "description": "Current batch state",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "batch_id": {
            "type": "string"
          },
          "status": {
            "enum": [
              "queued",
              "processing",
              "completed",
              "failed",
              "cancelling",
              "cancelled"
            ]
          },
          "total": {
            "type": "integer"
          },
          "done": {
            "type": "integer",
            "description": "Succeeded plus failed rows. Excludes cancelled rows."
          },
          "succeeded": {
            "type": "integer",
            "minimum": 0
          },
          "failed": {
            "type": "integer",
            "minimum": 0
          },
          "cancelled": {
            "type": "integer",
            "minimum": 0
          }
        }
      }
    }
  }
}

HTTP 401

{
  "description": "Authentication failed"
}

HTTP 404

{
  "description": "Batch not found in this workspace"
}

View shared schemas →