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

    GET /v1/jobs/{jobId}/context

    Read a job's context counts

    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.

    Returns counts and flags that say which follow-up exports a job supports: poses, plate rows, vendor rows, routes, molecules, extractions, descriptors, BLAST hits and proteins, plus QC, the overall ADMET score, a completeness score and a checkpoint summary. manifest is true when the job has a manifest and null otherwise; the manifest itself is not returned.

    The response is cached privately for 30 seconds. A job you cannot read, and a job outside your API key's project scope, both return 403 on this route.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Responses

    200 OK

    The job context

    Response shape:

    jobIdstring (uuid)
    posesCountinteger
    plateRowsinteger
    vendorRowsinteger
    routesCountinteger
    moleculesCountinteger
    qcobject
    overallAdmetScorenumber
    manifestboolean

    true when the job has a manifest, otherwise null.

    biobertRanboolean
    completenessScoreobject
    checkpointsSummaryobject
    extractionsCountinteger
    biobertCountinteger
    descriptorsCountinteger
    fingerprintsAvailableboolean
    blastHitsCountinteger
    proteinCountinteger
    auditEnabledboolean

    400 Bad Request

    The job id is missing or is not a UUID

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    403 Forbidden

    You cannot read the job, or it is outside your API key's project scope

    Response shape: object

    404 Not Found

    The job has no context data yet (code NOT_FOUND)

    Response shape: object

    405

    The method is not GET

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    Reading the context failed

    Response shape: object

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

    Was this page helpful?

    Loading...