API Documentation

Build custom integrations with ChatCrew's powerful REST API

Quick Start

Get your API key from your dashboard and start making requests in minutes.

# Get your API key from Dashboard → Account Settings

curl https://api.chatcrew.ai/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "your_agent_id",
    "message": "Hello, world!",
    "session_id": "unique_session_id"
  }'

Base URL

https://api.chatcrew.ai/v1

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API Endpoints

POST/chat

Send a message to your AI agent and get a response.

Request Body

{
  "agent_id": "string",      // Your agent ID (required)
  "message": "string",        // User message (required)
  "session_id": "string",     // Unique session ID (optional)
  "stream": boolean           // Enable streaming (optional, default: false)
}

Response

{
  "response": "AI generated response",
  "session_id": "unique_session_id",
  "credits_used": 1,
  "model": "gpt-4"
}
GET/agents/:agent_id

Retrieve information about a specific agent.

Response

{
  "id": "agent_id",
  "name": "Agent Name",
  "model": "gpt-4",
  "created_at": "2024-01-01T00:00:00Z",
  "status": "active"
}
GET/agents

List all your AI agents.

Response

{
  "agents": [
    {
      "id": "agent_id",
      "name": "Agent Name",
      "model": "gpt-4",
      "status": "active"
    }
  ],
  "total": 1
}

Rate Limits

API rate limits depend on your subscription tier:

Starter
60 requests/min
Growth
300 requests/min
Business
1,000 requests/min
Enterprise
Custom

Error Codes

400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
403Forbidden - Insufficient credits or permissions
404Not Found - Agent or resource not found
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Something went wrong on our end