Docs

Appearance

API Reference ​

The Converra REST API allows you to programmatically manage prompts, run optimizations, and log conversations.

Base URL ​

https://converra.ai/api/v1

Authentication ​

All API requests require a Bearer token:

bash
curl https://converra.ai/api/v1/prompts \
  -H "Authorization: Bearer YOUR_API_KEY"

Get your API key from Settings → API Keys.

Endpoints ​

Prompts ​

MethodEndpointDescription
GET/promptsList all prompts
POST/promptsCreate a prompt
GET/prompts/:idGet a prompt
PATCH/prompts/:idUpdate a prompt
GET/prompts/:id/insightsGet prompt insights

Optimizations ​

MethodEndpointDescription
GET/optimizationsList optimizations
POST/optimizationsTrigger optimization
GET/optimizations/:idGet optimization details
GET/optimizations/:id/variantsGet variant details
POST/optimizations/:id/applyApply winning variant
POST/optimizations/:id/stopStop running optimization

Conversations ​

MethodEndpointDescription
GET/conversationsList conversations
POST/conversationsLog a conversation
GET/conversations/:idGet conversation details
GET/conversations/:id/insightsGet conversation insights

Account & Settings ​

MethodEndpointDescription
GET/settingsGet settings
PATCH/settingsUpdate settings
GET/accountGet account info
GET/usageGet usage stats
GET/webhooksList webhooks
POST/webhooksCreate webhook
DELETE/webhooks/:idDelete webhook

Rate Limits ​

Rate limits vary by plan:

PlanRequests/minute
Free60
Pro300
EnterpriseCustom

Additional limits:

  • Concurrent optimizations: 10 per account

See Authentication for rate limit headers and handling.

Error Responses ​

json
{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid"
  }
}

Next Steps ​

Copyright © 2025 Converra