Chat API

Endpoint

The Chat API allows you to send messages to an agent and receive its responses. This is the primary API for building custom chat interfaces or integrating Botrelic into existing applications.

POST https://api.botrelic.com/v1/chat/completions

Authentication

All API requests must be authenticated using a Bearer token. You can generate an API key in your workspace settings.

Authorization: Bearer YOUR_API_KEY

Request example

Sends a message to an agent and returns the response. Include the session_id to maintain conversation context.

curl -X POST https://api.botrelic.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "agent_id": "agt_123456789",
  "session_id": "sess_987654321",
  "messages": [
    {
      "role": "user",
      "content": "Hello, how can I help you today?"
    }
  ]
}'

Response example

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "botrelic-agent-v1",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "I can help you with your account settings."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

Error codes

The API uses standard HTTP status codes to indicate the success or failure of an API request.

Related APIs

• Session API
• Webhook API