Getting Started with Colossal

1. Selecting an Agent

Colossal agents are designed to be powerful tools for your AI applications. Each agent is specialized in a particular service (like Zendesk, Twilio, or Slack) and comes pre-built with the necessary tools to interact with these services.

When you integrate a Colossal agent, it becomes available as a tool in your AI system, allowing your AI to perform complex operations without writing custom integration code.

Zendesk Agent

Autonomous support ticket handling and customer service operations

Twilio Agent

Automated SMS and email communications with intelligent responses

Slack Agent

Smart message handling and thread management in Slack channels

2. Retrieving Your API Key

To start using Colossal agents, you'll need an API key. This key authenticates your requests and helps us maintain the security of the platform.

Store your API key securely and never expose it in client-side code.

3. Getting Agent Responses

Colossal agents provide structured responses that are easy to integrate into your application flow. Each response includes the agent's actions, reasoning, and any data retrieved from the integrated service.

You can process these responses to update your UI, trigger additional actions, or feed them back into your AI system.

bash

1curl -X POST \
2  https://www.colossalhq.com/api/v1/agents/zendesk \
3  -H 'Content-Type: application/json' \
4  -H 'Accept: text/plain' \
5  -H 'Authorization: Bearer <COLOSSAL_API_TOKEN>' \
6  -d '{
7    "provider": "openai",
8    "providerCredentials": {
9      "apiKey": "<OPENAI_TOKEN>"
10    },
11    "agentCredentials": {
12      "subdomain": "my-zendesk-subdomain",
13      "email": "my-zendesk-email",
14      "apiToken": "<ZENDESK_API_TOKEN>"
15    },
16    "options": {
17      "toolCallStreaming": true,
18      "maxSteps": 10
19    },
20    "metadata": {
21      "messages": [
22        {
23          "role": "user",
24          "content": "I need you to file a support ticket for my broken hat-rack."
25        }
26      ],
27      "userInfo": {
28        "name": "Jonathan Qwilao",
29        "email": "jqwilao@gmail.com"
30      }
31    }
32  }'