POST
/v2/risk/{job_id}/cancelBetaCancel a job
Cancels an in-flight risk job. The job moves to failed, a run_failed event is emitted, and unused credits are refunded. If the job is already completed or failed, the call is idempotent and refunded_credits is 0.
Beta. This endpoint is available for production integrations, but fields, categories, and credit weights may change without a version pin.
Base URL
https://api.relativity6.comAuthentication
Send your API key in the x-api-key header. Send the same API key you used to submit the job.
Response
| Field | Type | Required | Description |
|---|---|---|---|
| job_id | string | Required | The cancelled job id. |
| status | string | Required | Lifecycle state after cancel. In-flight jobs become failed.queued · running · completed · failed |
| refunded_credits | number | Required | Credits returned to the organization when this call cancelled an active job. 0 if the job was already terminal. |
Response headers
RateLimit-PolicyStructured policy descriptor reporting your sustained per-minute quota (q, w=60) and per-second burst capacity (w=1) for this endpoint group.
RateLimitRemaining requests (r) in the current sustained window and seconds until reset (t).
Retry-AfterReturned on HTTP 429 responses. Whole seconds to wait before retrying.
Errors
| Status | Description |
|---|---|
| 200 | Cancel accepted, or the job was already terminal. |
| 401 | Missing or invalid API key. |
| 403 | The job belongs to a different organization. |
| 404 | No job exists with this id. |
| 429 | Rate limit exceeded (code RATE_LIMIT_EXCEEDED). Honor Retry-After. |
| 500 | Server error. |