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

    GET /v1/jobs/{jobId}/download/plate-map

    Download a job's plate map as CSV

    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 the job's plate map as a CSV file with one row per well: well, row, column, compound id, compound label, volume in microlitres and concentration in micromolar. A job with no plate rows returns a CSV with only the header row and sets X-Plate-Map-Fallback: headers-only.

    A job you cannot read, a job outside your API key's project scope and a job that does not exist all return the same 401 on this route.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Responses

    200 OK

    The plate map

    400 Bad Request

    The job id is missing

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    405

    The method is not GET or HEAD

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

    500 Internal Server Error

    Generating the plate map failed

    Response shape: object

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

    Was this page helpful?

    Loading...