Skip to main content

​
Welcome to Aya API

The Aya API is a REST API that provides access to the Aya community platform. Build integrations, manage profiles, publish stories, and interact with the community.

​
Base URL

All API requests should be made to: 
http://localhost:8080
The API uses locale-based routing. All endpoints include a {locale} parameter in the path. Supported locales: ar, de, en, es, fr, it, ja, ko, nl, pt-PT, ru, tr, zh-CN

​
Request Format

The API accepts JSON-formatted request bodies: 
curl -X POST http://localhost:8080/en/profiles/_create \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -d '{"slug": "my-profile", "kind": "individual", "title": "My Profile", "description": "Profile description"}'

​
Response Format

All responses are JSON-formatted with a consistent structure: 
{
  "data": {
    // Response data
  },
  "error": null
}

​
Pagination

List endpoints support cursor-based pagination:
​
limit
integer
default:"25"
Number of items per page (max 100)
​
offset
integer
default:"0"
Number of items to skip
​
sort
string
Sort order (varies by endpoint)

​
Rate Limiting

API requests are rate-limited to ensure fair usage. Rate limit headers are included in responses:
  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

​
SDKs and Tools

We provide official SDKs for popular programming languages:

JavaScript/TypeScript

Official Node.js and browser SDK

Go

Official Go SDK

​
API Status

Check the current API status and uptime at status.aya.is

​
Support

Need help? Join our community discussions or email [email protected]

Build docs developers (and LLMs) love

Get started for freeTalk to us