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.Errors
When a request fails, the response has an HTTP status code and a JSON body whosedetail field explains the problem:
code field next to detail: