Cancel Job | Captain Docs

Cancel/delete an indexing job.

Maps to POST /v1/index-stop/{job_id}

Behavior:

If job is pending or running -> transition to cancelled
If job is already completed/failed/cancelled -> return 200 with current state (idempotent)

Returns:

job_id: The job identifier
status: Current status after cancel attempt
message: Human-readable description
cancelled_at: Cancellation timestamp (RFC3339)

Authentication: Requires Bearer token in Authorization header

Cancel/delete an indexing job. Maps to POST /v1/index-stop/{job_id} Behavior: - If job is pending or running -> transition to cancelled - If job is already completed/failed/cancelled -> return 200 with current state (idempotent) Returns: - job_id: The job identifier - status: Current status after cancel attempt - message: Human-readable description - cancelled_at: Cancellation timestamp (RFC3339) Authentication: Requires Bearer token in Authorization header

Path parameters

job_idstringRequired

Response

Successful Response

job_idstring

messagestring

statusstring

cancelled_atstring or null

cleanup_initiatedboolean or null

1	import json
2	import requests
3	import uuid
4
5	BASE_URL = "https://api.runcaptain.com"
6	API_KEY = "your_api_key"
7	JOB_ID = "job_abc123"
8
9	headers = {
10	"Authorization": f"Bearer {API_KEY}",
11	"Idempotency-Key": str(uuid.uuid4()),
12	}
13
14	response = requests.delete(
15	f"{BASE_URL}/v2/jobs/{JOB_ID}",
16	headers=headers,
17	timeout=30.0
18	)
19
20	print(json.dumps(response.json(), indent=2))

Path parameters

Headers

Response