API Reference
The Operative API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.
Base URL
https://api.operative.ai/v1Authentication
The Operative API uses API keys to authenticate requests. You can view and manage your API keys in your dashboard settings.
Include your API key in the Authorization header:
Authorization: Bearer op_live_xxxxxxxxxxxxxKeep your API keys secure. Do not share them in publicly accessible areas such as GitHub, client-side code, or public documentation.
Quick Start
Create your first agent with a single API call:
curl -X POST https://api.operative.ai/v1/agents \
-H "Authorization: Bearer op_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Support Agent",
"type": "customer_support",
"model": "gpt-4",
"personality": {
"tone": "friendly",
"formality": "casual"
}
}'Endpoints
Agents
Create, retrieve, update, and delete agents
Conversations
Manage agent conversations and messages
Analytics
Retrieve performance metrics and analytics
Webhooks
Configure webhook endpoints for real-time events
Rate Limits
The API enforces rate limits to ensure fair usage. Limits vary by plan:
| Plan | Requests/minute | Requests/day | Burst limit |
|---|---|---|---|
| Starter | 100 | 10,000 | 20 |
| Growth | 500 | 100,000 | 50 |
| Scale | 2,000 | Unlimited | 200 |
Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset
Errors
Operative uses conventional HTTP response codes to indicate success or failure:
Official SDKs
Use our official SDKs for the best developer experience. All SDKs include TypeScript definitions and comprehensive documentation.