AI API Documentation

All AI requests use canonical endpoints under /api/v1/ai/*.

Authentication

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Canonical Endpoints

POST /api/v1/ai/intent
POST /api/v1/ai/content
POST /api/v1/ai/email
POST /api/v1/ai/preferences

Request

{
  "message": "Write release notes",
  "provider": "openai",
  "model": "gpt-4o-mini"
}

Response Contract

{
  "success": true,
  "data": {
    "type": "content",
    "provider": "openai",
    "model": "gpt-4o-mini",
    "result": {}
  },
  "meta": {
    "credits_used": 2,
    "credits_remaining": 998,
    "idempotent_replay": false
  }
}

Error Contract

{
  "success": false,
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key."
  }
}

Common status codes: 401, 403, 409, 422, 429, 500.

Open Playground