Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/POST /v1/jobs/{jobId}/cancel

    POST /v1/jobs/{jobId}/cancel

    Cancel a job — Requests cancellation of an in-flight job you can write to. A job that has already finished returns its current status unchanged.

    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_…), a signed-in session token (Authorization: Bearer …) or the session cookie (browser sessions). See Authentication.

    Requests cancellation of an in-flight job you can write to. A job that has already finished returns its current status unchanged. Credits held for the job are released after cancellation is confirmed, not in this response. A project viewer, or a caller with no access, receives 404.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Request body

    No body is read.

    Type: object

    Responses

    200 OK

    Cancellation acknowledged, or the job had already finished

    Response shape:

    idstring
    statusstring
    messagestring

    "Job already finished" when the job was already in a terminal state.

    400 Bad Request

    Invalid request

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    404 Not Found

    Resource not found

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    502 Bad Gateway

    The compute backend did not accept the cancellation (failed or timed out after 15 seconds)

    Response shape: object

    curl -X POST 'https://ivybiosciences.com/api/v1/jobs/{jobId}/cancel' \
      -H "Authorization: Bearer $IVY_API_KEY" \
      -H 'Content-Type: application/json' \
      -d '{}'

    Was this page helpful?

    Loading...