Skip to main content
Use the Cassidy API to integrate your Agent into any custom application, internal tool, or Workflow.
Prerequisites:
  • An Agent created in Cassidy
  • An API key (or the ability to create one)
1

Navigate to your Agent

Go to Agents and select the Agent you want to deploy via API. Click Edit to open the Agent settings.
Agents page showing the list of available Agents
2

Open the Deployments tab

Navigate to the Deployments tab and select Deploy via API.
Agent settings with the Deployments tab selected
Deploy via API section showing setup instructions and sample code
3

Open Organization Settings

Click the API Keys link in the instructions, or navigate manually: click your name in the bottom left of the sidebar, then click the settings icon for your organization.
Sidebar showing the organization settings gear icon
4

Navigate to the API Keys tab

In the Organization Settings window, go to the API Keys tab.
Organization Settings window with the API Keys tab selected
5

Create an API key

Click + Create API Key, enter a name for the key, and click Save. Click the eye icon to reveal the key, then copy it and save it to a secure location. Click Exit when finished.
Create API Key dialog with name field and Save button
API key revealed with copy button and Exit option
Copy and save your API key immediately — you won’t be able to see it again after closing the dialog.
6

Use the sample code

Return to the Deploy via API tab in your Agent’s settings. Follow the sample code provided to create conversation threads and send messages programmatically.
Deploy via API tab showing sample code for creating threads and sending messages

​
API basics

The Cassidy API uses threads and messages to manage conversations:
  1. Create a thread — start a new conversation with the Agent
  2. Send a message — add a user message to the thread
  3. Receive a response — the Agent processes the message and returns a reply
For detailed endpoint documentation, request formats, and authentication details, see the Cassidy API documentation.
Keep your API key secure. Do not share it publicly or commit it to version control.
You can delete an API key at any time from the API Keys tab by clicking the ellipsis menu and selecting Delete.

​
Next steps

Agents overview

Learn more about creating and configuring Agents.

Deploy via embed

Embed your Agent on a website without writing code.