API Reference

Authentication

All API requests require two headers:

# All requests require the X-Organization-Id header
curl https://api.aployee.com/v1/assistants \
  -H "Authorization: Bearer $APLOYEE_KEY" \
  -H "X-Organization-Id: org_xxxx"

Endpoints

Error Handling

All errors return JSON with a consistent structure:

{
  "error": {
    "code": "invalid_request",
    "message": "The assistant_id field is required",
    "details": {
      "field": "assistant_id"
    }
  }
}

Rate Limits

Default rate limits by plan:

Rate limit headers are included in every response:

• X-RateLimit-Limit - Requests allowed per window
• X-RateLimit-Remaining - Requests remaining
• X-RateLimit-Reset - Unix timestamp when window resets

OpenAPI Specification

The full OpenAPI (Swagger) specification is available at:

• Swagger UI: https://api.aployee.com/swagger
• OpenAPI JSON: https://api.aployee.com/swagger/v1/swagger.json

Use these to generate client libraries for your language of choice.