API Reference

The API Reference documents every endpoint of the Arcalotl public REST API, grouped by resource, with request and response schemas and copy-paste code samples. It is generated from the published OpenAPI 3.1 spec, so it never drifts from the API.

Before you start

The conceptual guide in the Documentation tab covers the cross-cutting rules these endpoints share:

• Authentication and scopes: send Authorization: Bearer arclt_live_..., and match each endpoint's required scope.
• Pagination: opaque cursor plus limit, with a next_cursor on each page.
• Errors: RFC 9457 application/problem+json with a stable code.
• Rate limits: the RateLimit-* response headers and Retry-After on 429.
• Idempotency: the Idempotency-Key header on writes.

Base URL

https://api.arcalotl.com/v1

Every resource is scoped to the community that owns the API key. An id owned by another community answers 404.

Related guides

• Webhook Events: every event type's delivery, headers, and payload schema.
• Webhooks: the event envelope and signature verification.
• Events: polling the events feed for reconciliation.
• Checkout links: sell a plan from your own systems.
• MCP: connect an AI agent to the same API.

The raw spec is published at arcalotl-public-api.yaml.