Cancel a job

POST /v1/jobs/:id/cancel cancels a parent job’s remaining non-terminal children. Children that already reached a terminal state (completed, partial, failed) keep their outcome and their artifacts — cancellation only stops work that hasn’t finished.

string

required

The parent job id (dotless, e.g. job_8t2q).

Request

curl -X POST https://api.aisearchapi.dev/v1/jobs/job_8t2q/cancel \
  -H "Authorization: Bearer $AISEARCH_API_KEY"

const res = await fetch('https://api.aisearchapi.dev/v1/jobs/job_8t2q/cancel', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.AISEARCH_API_KEY}` },
});
const { job } = await res.json();

import os, requests

res = requests.post(
    "https://api.aisearchapi.dev/v1/jobs/job_8t2q/cancel",
    headers={"Authorization": f"Bearer {os.environ['AISEARCH_API_KEY']}"},
)
job = res.json()["job"]

Response

200 OK

{
  "job": {
    "id": "job_8t2q",
    "status": "canceled"
  }
}

job.id

string

The parent job id.

job.status

string

The parent’s status after cancellation. If some children had already completed, the rollup can be partial or completed rather than canceled — cancellation never rewrites a finished child’s result.

Cancellation is a request to stop, not a rollback. A capture already in flight may still finish; a successful capture is still billed. Only work that hadn’t started is guaranteed not to run (or be charged).

Errors

404

JOB_NOT_FOUND

No parent job exists for that id, or it belongs to another tenant (reads and writes are owner-scoped — another tenant’s id is a 404, never a 403).

404

{
  "code": "JOB_NOT_FOUND",
  "error": "no job with id 'job_8t2q'",
  "request_id": "req_9f2c1a7e4b5d48f1a3c6e8d0b2a4f6c8",
  "docs_url": "https://docs.aisearchapi.dev/guides/errors#job_not_found"
}

Get a job

Read the parent rollup and per-child status.

Job lifecycle

Terminal states and when work can still be canceled.

Endpoints

Account & discovery

Watches

By surface

Request

Response

Errors

Get a job

Job lifecycle

​Request

​Response

​Errors

Get a job

Job lifecycle

Request

Response

Errors