Skip to main content

Base URL

https://api.convosphere.site/api

Authentication

All API requests require authentication. See Authentication Guide for details.

Using API Keys

Include your API key in the Authorization header:
Authorization: Bearer conv_YOUR_API_KEY

Using JWT Tokens

Include your access token in the Authorization header:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Rate Limits

API requests are rate-limited based on your plan:
  • Free: 100 requests/minute
  • Starter: 500 requests/minute
  • Business: 2,000 requests/minute
  • Pro: 10,000 requests/minute
Rate limit headers are included in responses:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Error Responses

All errors follow this format:
{
  "error": "Error code",
  "message": "Human-readable error message"
}
Common HTTP status codes:
  • 200 - Success
  • 201 - Created
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 429 - Rate Limit Exceeded
  • 500 - Internal Server Error

API Endpoints

Authentication

Agents

Chat

Knowledge Base

Integrations

Webhooks

SDKs and Libraries

JavaScript/TypeScript

npm install @convosphere/ai-sdk
import { ConvosphereClient } from '@convosphere/ai-sdk';

const client = new ConvosphereClient({
  apiKey: 'conv_YOUR_API_KEY'
});

const response = await client.agents.chat('agent_123', {
  message: 'Hello',
  stream: false
});

Python

pip install convosphere-ai
from convosphere import ConvosphereClient

client = ConvosphereClient(api_key='conv_YOUR_API_KEY')

response = client.agents.chat('agent_123', {
    'message': 'Hello',
    'stream': False
})

Quick Start Example

# Get your API key from the dashboard
export CONVOSPHERE_API_KEY="conv_YOUR_API_KEY"

# List your agents
curl -H "Authorization: Bearer $CONVOSPHERE_API_KEY" \
  https://api.convosphere.site/api/agents

# Send a message
curl -X POST \
  -H "Authorization: Bearer $CONVOSPHERE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello", "stream": false}' \
  https://api.convosphere.site/api/agents/agent_123/chat

Next Steps