API Reference
Authentication

Authentication

Every Aila API request needs an organization API key, sent as a Bearer token. Each key has explicit permissions (scopes) that you choose when you create it.


Create an API key

Only organization Owners and Admins can create and manage keys.

  1. In Aila, go to Settings > Connections and open API Keys.
  2. Click Create API key.
  3. Enter a name (for example, Production Integration).
  4. Select at least one permission (see below).
  5. Optionally set an expiration date.
  6. Copy the key. Aila shows the full key only once.

Keys look like ak_ followed by 64 hex characters.


Use the key

curl https://app.aila.fyi/api/v1/auth/verify \
  -H "Authorization: Bearer ak_your_key_here"

GET /auth/verify returns the key's ID and permissions, so it's a good first call.


Permissions

Permission (UI)ScopeAllows
Read Callscalls:readList calls, read details and transcripts.
Write Callscalls:writeUpload (batch), update, and delete calls.
Read Contactscontacts:readList and read contacts.
Write Contactscontacts:writeCreate and update contacts.
Read Loan Filesloan-files:readRead loan files and export MISMO 3.4.
Write Loan Filesloan-files:writeUpdate loan files.
Read Insightsinsights:readRead call insights.
Read Metricsmetrics:readRead team metrics.
Read Organizationorganizations:readRead organization details.

Give each integration only the scopes it needs.


Delete a key

In Settings > Connections > API Keys, click Delete next to the key. Requests with that key start failing within about a minute.


Errors

StatuscodeFix
401UNAUTHORIZED / INVALID_API_KEYCheck the header format and that the key exists and hasn't expired.
403INSUFFICIENT_PERMISSIONSCreate a key with the required scope.
429RATE_LIMITEDSlow down. See Rate limits.