Skip to main content

Deploying Agents via API

Integrate Cassidy Agents into your application

Jake Rosenthal avatar
Written by Jake Rosenthal
Updated yesterday

How to deploy Agents via API

To seamlessly integrate Cassidy Agents into your application via API, follow these step-by-step instructions:

  1. Navigate to the Agents page: Click on the "Agents" tab in the left sidebar to access your list of Agents.

  2. Select the Agent: Choose the Agent you want to deploy via API by clicking on its card or opening the ellipses (more options) menu and selecting "Edit."

  3. Access the Deployments section: In the Agent's settings, navigate to the "Deployments" tab to configure and make Agents available in external tools.

  4. Create an API key:

    1. Click on the "API Keys" link in the instructions. Alternatively, you can navigate to API Keys by opening Organization Settings:

      1. Click on your name in the bottom left of the sidebar.

      2. Click the settings icon for your organization.

    2. In the Organization Settings window, navigate to the API Keys tab.

    3. Click "+ Create API Key".

    4. Enter an API Key Name and click Save.

    5. Click the eye icon to reveal the API key (you will not be able to see it again).

    6. Click copy and save the API key to a secure location.

    7. Once finished, click Exit.

    8. Note: You can delete the API key by clicking the ellipses and selecting Delete.

  5. Return to the Deploy via API tab: Go back to your Agent's settings and the Deploy via API tab. Follow the sample code provided for creating threads and messages.

  6. Refer to the API documentation: For detailed information on available endpoints and request formats, refer to the Cassidy API documentation here.

Did this answer your question?