Skip to main content

API quickstart

Authenticate and make your first REST API request.

The ElemBio™ API is a REST API that provides programmatic access to your ElemBio Cloud account data. This quickstart shows you how to authenticate with an API key and make your first requests. The same operations are also available through the ElemBio CLI.

This guide uses curl, but you can use any HTTP client. Before you begin, create an API key from your ElemBio Cloud account settings. For complete endpoint documentation, request and response schemas, and interactive examples, see the API reference.

Set your credentials​

export ELEMBIO_API_KEY=ebp_s6iyTXunEXAMPLE
export ELEMBIO_API_URL=https://cloud-api.usw2.elembio.io

Verify your key​

Confirm the key works and see the tenant it belongs to and the scopes it carries:

curl -sSf "$ELEMBIO_API_URL/v1/auth" \
  -H "x-api-key: $ELEMBIO_API_KEY"
{
  "tenantId": "ten_your-tenant-id",
  "scopes": ["runs", "executions"]
}

List your runs​

curl -sSf "$ELEMBIO_API_URL/v1/runs" \
  -H "x-api-key: $ELEMBIO_API_KEY"

The response contains a runs array plus nextPageToken for pagination:

{
  "runs": [
    {
      "id": "seq_...",
      "description": "..."
    }
  ],
  "nextPageToken": "..."
}

Errors​

Errors return a JSON body with an integer code, a human-readable message, and a details array. Each entry in details carries a machine-readable reason (for example RUN_NOT_FOUND or INVALID_API_KEY).

When reporting a problem to support, include the request_id from the error detail — it matches the X-Request-ID response header and helps us trace the exact request.

Next steps​

Last updated on