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

    GET /v1/jobs/{jobId}/extractions

    List a job's extracted files

    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 extracted files registered for a job you can read, with a count per file type. Each entry gives the stored location of the file in outputUri; that is a storage location, not a download link.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Responses

    200 OK

    The job's registered extractions and counts by type

    Response shape:

    jobIdstring
    extractionsobject[]
    countsByTypeobject

    Number of registered extractions per file type

    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 extractions could not be read

    Response shape: object

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

    Was this page helpful?

    Loading...