Documentation/API Reference

API Reference

The Engrami API is organized around REST principles. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Base URL

All API requests should be made to the following base URL:

https://api.engrami.com/v1

Authentication

The Engrami API uses API keys to authenticate requests. You can create and manage your API keys in your profile settings.

Include your API key in the Authorization header of all requests:

curl https://api.engrami.com/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Secure Your API Keys

Your API keys carry significant privileges. Do not share your API keys in publicly accessible areas such as GitHub, client-side code, or public forums.

Rate Limits

API requests are rate-limited to ensure fair usage and system stability. Rate limits vary by plan:

Plan	Requests/Minute	Requests/Day
Free	60	1,000
Pro	600	50,000
Enterprise	Custom	Unlimited

Rate limit information is included in the response headers:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 599
X-RateLimit-Reset: 1640995200

Response Format

All responses are returned in JSON format with the following structure:

Successful Response

{
  "success": true,
  "data": {
    "id": "agent_abc123",
    "name": "Customer Support Agent",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "The agent name is required",
    "details": {
      "field": "name",
      "reason": "missing_required_field"
    }
  }
}