Skip to main content

API Reference

Build integrations with the Iverton AI API.

Base URL​

https://api.ivertonai.com/v1

Authentication​

All API requests require authentication via API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.ivertonai.com/v1/clients

See Authentication for details.

Response Format​

All responses are JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100
  }
}

Error Response​

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email format",
    "details": { ... }
  }
}

HTTP Status Codes​

CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Server Error

Rate Limits​

PlanRequests/minute
Starter60
Professional300
Enterprise1000

Rate limit headers:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1640995200

Pagination​

List endpoints support pagination:

GET /v1/contacts?page=2&limit=50

Response includes meta:

{
  "meta": {
    "page": 2,
    "limit": 50,
    "total": 500,
    "pages": 10
  }
}

API Sections​

SDKs & Libraries​

Official SDKs:

  • JavaScript/TypeScript: npm install @ivertonai/sdk
  • Python: pip install ivertonai

Support​