Skip to content

API Reference

Base URL: https://api.auteryn.ai

The Auteryn REST API lets you integrate AI agents directly into your applications.


Endpoints

POST /api/run

Run an agent — streaming SSE or synchronous JSON. Reference →

GET/POST /api/tasks

List, get, and delete tasks and runs. Reference →

GET /api/messages

Retrieve message history for a task. Reference →

GET/POST/DELETE /api/memory

Read and manage agent memory entries. Reference →

POST /api/v1/widget/run

Widget gateway for embedded chat. Reference →


Authentication

All requests require:

Authorization: Bearer afk_your_api_key
X-Agent-Id: your-agent-id
Content-Type: application/json

See Authentication → for full details.


Rate limits

PlanRequests per minute
Free10
Starter60
Pro300
EnterpriseCustom

Rate limit headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset


Error responses

{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}
StatusCodeMeaning
401unauthorizedMissing or invalid API key
402insufficient_creditsNot enough credits to run
403forbiddenKey valid but no access to this resource
404agent_not_foundAgent ID not found
429rate_limitedToo many requests
500internal_errorUnexpected server error