API Reference

Agents API

# Agents API Reference

Complete reference for the Agents API endpoints.

List Agents

GET /agents

Query Parameters

  • `category` - Filter by category
  • `sort` - Sort by (rating, newest, reviews)
  • `limit` - Number of results (default: 20)
  • `offset` - Pagination offset (default: 0)
  • `minRating` - Minimum rating (0-5)

Response

json
{
  "data": [
    {
      "id": "agent-123",
      "name": "Support Agent",
      "description": "...",
      "rating": 4.8,
      "reviewCount": 245,
      "category": "Customer Support",
      "pricing": {
        "model": "per-request",
        "cost": 0.05
      }
    }
  ],
  "total": 1000,
  "limit": 20,
  "offset": 0
}

Get Agent

GET /agents/:id

Response

json
{
  "id": "agent-123",
  "name": "Support Agent",
  "description": "...",
  "rating": 4.8,
  "reviewCount": 245,
  "category": "Customer Support",
  "company": {
    "id": "company-1",
    "name": "AI Corp",
    "website": "..."
  },
  "pricing": {
    "model": "per-request",
    "cost": 0.05
  },
  "documentation": "...",
  "useCases": ["..."]
}

Invoke Agent

POST /agents/:id/invoke

Request Body

json
{
  "input": "Your input here",
  "parameters": {
    "language": "en",
    "tone": "professional"
  }
}

Response

json
{
  "id": "result-456",
  "agentId": "agent-123",
  "status": "success",
  "output": "Agent response here",
  "executionTime": 1234,
  "tokens": {
    "input": 50,
    "output": 150
  }
}

Error Responses

json
{
  "error": {
    "code": "AGENT_NOT_FOUND",
    "message": "Agent not found"
  }
}

Rate Limits

  • 100 requests per minute (free)
  • 1000 requests per minute (pro)
  • 10000 requests per minute (enterprise)