Skip to main content
    Ivy Biosciences logo
    Ivy Biosciences.bloom* docs
    login.bloom*
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/GET /v1/jobs/{jobId}/plate-types

    GET /v1/jobs/{jobId}/plate-types

    List plate types and suggestions

    Open in Claude(opens in a new tab)Open in ChatGPT(opens in a new tab)1 min read
    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 full plate catalogue in plates, and in suggestions up to 8 catalogue plates ranked for the assay useCase. The catalogue and suggestions do not depend on the job's data; the job id is used only to check that you can read the job.

    Without a valid useCase, suggestions is an empty array. A useCase, wellCount or sterileOnly value that is not one of the allowed values is ignored rather than rejected.

    Request

    Path parameters

    jobIdstring (uuid)

    Job UUID.

    Query parameters

    useCaseenum ("absorbance" | "cell_culture" | "fluorescence_assay" | "fluorescence_imaging" | "luminescence")

    Assay use case to rank plates for

    wellCountenum (24 | 96 | 384 | 1536)

    Only suggest plates with this many wells

    sterileOnlyboolean

    true to suggest only sterile plates; false to not filter on sterility

    Responses

    200 OK

    The plate catalogue and the ranked suggestions

    Response shape:

    successenum (true)
    platesobject[]

    The full plate catalogue.

    suggestionsobject[]

    Up to 8 catalogue plates, best match first. Empty without a valid useCase.

    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

    405

    The method is not GET (checked after sign-in); the Allow header says GET

    Response shape: object

    429 Too Many Requests

    Rate limit exceeded

    Response shape: object

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

    Was this page helpful?

    GET /v1/jobs/{jobId}/plate

    Read a job's plate layout

    GET /v1/jobs/{jobId}/procurement

    Read a job's procurement items

    Loading...