REST API Reference

Complete reference documentation for the Aku REST API.

Authentication

The Aku API uses API keys for authentication. You can obtain an API key from your dashboard.

All API requests must include your API key in the Authorization header:

bash

curl -X GET \
  https://api.aku-ai.com/v1/agents \
  -H "Authorization: Bearer your_api_key"

Base URL

All API requests should be made to:

text

https://api.aku-ai.com/v1

Agents

Agents are specialized AI assistants designed for specific real estate tasks.

List Agents

Returns a list of all available agents.

GET

/agents

bash

curl -X GET \
  https://api.aku-ai.com/v1/agents \
  -H "Authorization: Bearer your_api_key"

Generate with Agent

Generate content using a specific agent.

POST

/agents/{agent_id}/generate

Path Parameters:

agent_id - The ID of the agent to use

Request Body:

json

{
  "model": "gpt-4",
  "property": {
    "type": "apartment",
    "bedrooms": 2,
    "bathrooms": 1,
    "sqft": 1200,
    "features": ["hardwood floors", "updated kitchen", "balcony"],
    "neighborhood": "downtown",
    "city": "Seattle",
    "state": "WA"
  }
}

bash

curl -X POST \
  https://api.aku-ai.com/v1/agents/property-description/generate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key" \
  -d '{
    "model": "gpt-4",
    "property": {
      "type": "apartment",
      "bedrooms": 2,
      "bathrooms": 1,
      "sqft": 1200,
      "features": ["hardwood floors", "updated kitchen", "balcony"],
      "neighborhood": "downtown",
      "city": "Seattle",
      "state": "WA"
    }
  }'

Prompts

Prompts are pre-defined templates for generating specific types of content.

List Prompts

Returns a list of all available prompts.

GET

/prompts

bash

curl -X GET \
  https://api.aku-ai.com/v1/prompts \
  -H "Authorization: Bearer your_api_key"

Errors

The Aku API uses conventional HTTP response codes to indicate the success or failure of an API request.

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	The API key doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist.
429 - Too Many Requests	Too many requests hit the API too quickly.
500 - Server Error	Something went wrong on Aku's end.

Rate Limits

The Aku API implements rate limiting to ensure the stability and availability of the service for all users. Rate limits vary based on your subscription plan.

Plan	Rate Limit
Starter	10 requests per minute
Professional	60 requests per minute
Enterprise	Custom limits based on your needs

Rate limit headers are included in all API responses:

X-RateLimit-Limit: The maximum number of requests you're permitted to make per minute.
X-RateLimit-Remaining: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset: The time at which the current rate limit window resets in UTC epoch seconds.