Integrate Alayn AI with point-of-sale hardware, third-party delivery platforms, custom mobile apps, and accounting ERPs with 100% typed schema precision.
The official command-line interface lets developers, agents, and DevOps pipelines script restaurant workflows, sync menus, and tail live KDS orders without building HTTP clients from scratch.
# Install globally via npm
npm install -g @alayn/cli
# Authenticate your terminal
alayn auth login --api-key <YOUR_API_KEY>
# Stream live kitchen orders in real-time
alayn orders stream --outlet 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
All production API requests must authenticate via Bearer JWT and specify the targeted outlet UUID via the x-outlet-id header.
Base URL: https://api.alaynai.com/v1
Authorization: Bearer <jwt_access_token>
x-outlet-id: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
Alayn AI returns standard RFC rate-limiting headers on all API responses so autonomous agents and integrations can self-throttle in real time:
All 4xx and 5xx responses conform to the application/problem+json specification, providing machine-readable error codes and structured invalid parameter details:
{
"type": "https://alaynai.com/errors/validation",
"title": "Validation Failed",
"status": 422,
"detail": "Quantity for item must be greater than zero.",
"code": "ERR_PAYLOAD_VALIDATION",
"invalidParams": [
{ "name": "items[0].quantity", "reason": "Must be >= 1" }
]
}Alayn AI maintains a minimum 12-month sunset window for deprecated API operations. When an endpoint or property is flagged for deprecation:
Deprecation: @<unix_timestamp> header is attached to responses.Sunset: <http_date> header announces the exact termination date.