Skip to main content
The Cassidy Agents API lets your applications chat with your Agents. Start a chat with an Agent, send it messages, read the replies, and mint tokens for secure embedded chats.
You need an API key. To create one, follow the steps in Deploy via API.

Authenticate

An API key acts as the user who created it, with that user’s permissions. Send it as a bearer token in the Authorization header:
Keep your API key secure. Call the API from your backend, never from browser or mobile code, and don’t commit the key to version control.

Make your first request

Create a chat with an Agent. The Agent’s ID is shown on its Deploy via API tab:
The response contains a thread_id. Use it to send a message. The response contains the Agent’s reply:
Each endpoint has its own page in the API reference with its parameters and response format.

Download the API specification

The OpenAPI specification describes every endpoint. Use it to load the API into another tool, such as Postman or a code generator:

API keys vs. Admin API keys

To pull organization-wide usage and activity into your own reports instead, use an Admin API key. Admin API keys act as your organization, not as a user, and can only read organization-wide data.