Relativity6Platform Docs
POST/v2/risk/{job_id}/cancelBeta

Cancel 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 URLhttps://api.relativity6.com

Authentication

Send your API key in the x-api-key header. Send the same API key you used to submit the job.

Response

FieldTypeRequiredDescription
job_idstringRequiredThe cancelled job id.
statusstringRequiredLifecycle state after cancel. In-flight jobs become failed.queued · running · completed · failed
refunded_creditsnumberRequiredCredits returned to the organization when this call cancelled an active job. 0 if the job was already terminal.

Response headers

  • RateLimit-Policy

    Structured policy descriptor reporting your sustained per-minute quota (q, w=60) and per-second burst capacity (w=1) for this endpoint group.

  • RateLimit

    Remaining requests (r) in the current sustained window and seconds until reset (t).

  • Retry-After

    Returned on HTTP 429 responses. Whole seconds to wait before retrying.

Errors

StatusDescription
200Cancel accepted, or the job was already terminal.
401Missing or invalid API key.
403The job belongs to a different organization.
404No job exists with this id.
429Rate limit exceeded (code RATE_LIMIT_EXCEEDED). Honor Retry-After.
500Server error.

Example request

Example response