Skip to main content
The Bluejay REST API takes and returns JSON. To find an endpoint, use the sidebar or the cheat sheet.

Make your first request

1

Get an API key

Open the API Keys page of the app and create a key. The API ignores the X-Organization-Id header.
2

Send a request

Send every request to the base URL https://api.getbluejay.ai, with the key in the X-API-Key header. Endpoint paths start with /v1. The two /v2 retrieve endpoints add the grade of each success-criteria bullet. This request lists the agents your key can reach:
3

Read the response

A successful request returns a 2xx status and a JSON body. This request returns a list of agents, and each item has the agent’s id, which other endpoints take as agent_id. Each endpoint page shows the fields of its response and an example. If the request fails, read the status code and the detail field, as Errors explains.
To try an endpoint without writing code, use the API Playground.

Errors

When a request fails, the response has an HTTP status code and a JSON body whose detail field explains the problem:
When billing blocks a request, the body also has a code field next to detail:

Pagination

A list endpoint that can return many rows splits them into pages, using one of three styles. Each endpoint page shows its parameters, defaults, and maximum values.
Other list endpoints return all rows in one response.

Rate limits

Endpoints with a rate limit allow 100 requests per minute from each client IP address, unless the end of the endpoint page shows a different limit. Evaluate counts requests for your whole organization instead of for each IP address. It allows 100 requests per minute, or 500 for enterprise accounts. If you go over a limit, the request returns 429. Wait until the next minute, then send the request again.
Last modified on November 16, 2026