SDKs
Client libraries for the AY Inbox API, and how to generate one.
AY Inbox does not publish official client libraries yet. Every surface an SDK would wrap is documented and stable: the REST API, the OAuth2 authorization flows, and the realtime gateway, all on the v1 API.
Generate a client
The REST API is described by an OpenAPI document, so a typed client for any language is one generator run away. See OpenAPI for where the document lives and how to generate from it.
Authentication
Any HTTP client works with a bearer credential, and both credential types run through the same permission gates:
- an API key for your own scripts (prefixed
aybox_) - an OAuth access token for apps acting on behalf of a workspace (prefixed
ayat_)
curl https://api.ayinbox.com/v1/campaigns \
-H "Authorization: Bearer aybox_..."For the full authorization-code and client-credentials flows (PKCE and token refresh), see OAuth. For key format, scoping, and rotation, see Authentication.
No-code and automation
Prefer a visual builder? See the Zapier and Make guides.
See also
- API overview for the base URL, versioning, and conventions
- Authentication and OAuth
- Permissions for the scopes each token can carry
- Realtime for the event gateway
Authentication
Authenticate to the AY Inbox API with an API key or OAuth token: create a key, scope its permissions, restrict it to IPs, retry safely and check who you are.
CLI
The ayinbox command line interface. Sign in once, then drive campaigns, contacts, mailboxes and the inbox from your terminal, from CI, or from an agent.