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

    GET /v1/jobs/{jobId}/lineage

    Read a job's lineage

    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 recorded inputs of a job you can read: one row per producer job output that fed it, newest first. Each row names the producer job, the producer output and the input slot it filled.

    A row's output carries that output's data type, quality score and preview only when the output belongs to the row's producer job and you can read that producer job; otherwise output is null. A job with no recorded lineage returns an empty lineage array.

    With a project-scoped API key, a job outside the key's projects, or with no project, returns 404, and a producer job outside them is treated as one you cannot read.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Responses

    200 OK

    The job's lineage rows

    Response shape:

    lineageobject[]

    Lineage rows, newest first

    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, it is outside your API key's project scope, or the id is not a job UUID. All of these return the same body.

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    Reading lineage failed

    Response shape: object

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

    Was this page helpful?

    Loading...