API Documentation

Complete API reference for Agent Synergy

Authentication

Base URL

https://api.agentsynergy.com/api/v1

API Key

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limits

  • • 1000 requests per hour for free tier
  • • 10000 requests per hour for pro tier
  • • Rate limit headers included in responses

Agents

Create Agent

POST /agents
{
  "name": "Customer Support Bot",
  "agent_type": "support",
  "description": "Handles customer inquiries",
  "config": {
    "model": "gpt-4",
    "temperature": 0.7,
    "max_tokens": 1000,
    "system_prompt": "You are a helpful customer support agent..."
  }
}

Get Agents

GET /agents

Returns a list of all your agents

Chat with Agent

POST /agents/{agent_id}/chat
{
  "message": "Hello, I need help with my order",
  "conversation_id": "optional-conversation-id"
}

Conversations

Get Conversations

GET /conversations

Returns a list of all conversations

Get Messages

GET /conversations/{conversation_id}/messages

Returns messages for a specific conversation

Analytics

Overview Analytics

GET /analytics/overview

Returns overall platform analytics

Agent Performance

GET /analytics/agents

Returns performance metrics for all agents

Integrations

Create Integration

POST /integrations
{
  "name": "Slack Notifications",
  "type": "slack",
  "config": {
    "webhook_url": "https://hooks.slack.com/...",
    "channel": "#general"
  }
}

Test Integration

POST /integrations/{integration_id}/test

Tests the integration connection

Webhooks

Webhook Events

  • agent.created - New agent created
  • conversation.started - New conversation started
  • conversation.completed - Conversation completed
  • agent.error - Agent encountered an error