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

    GET /v1/jobs/{jobId}/checkpoints

    Read a job's checkpoints

    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.

    Lists the processing checkpoints recorded for a job you can read, one per step, with a summary that groups the step names by status.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Responses

    200 OK

    The job's checkpoints and a per-status summary

    Response shape:

    jobIdstring
    checkpointsobject[]
    summaryobject

    Step names grouped by checkpoint status. All five keys are always present.

    400 Bad Request

    The job id is empty

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    404 Not Found

    The job does not exist, you cannot read it, or it is outside your API key's project scope. All of these return the same body.

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    The checkpoints could not be read

    Response shape: object

    curl -X GET 'https://ivybiosciences.com/api/v1/jobs/{jobId}/checkpoints' \
      -H "Authorization: Bearer $IVY_API_KEY"

    Was this page helpful?

    Loading...