API access

REST, messaging API, and the transcription API. Keys live in the workspace. Included on Lite, Growth, and Business.

How to get a key

auth

Sign in at app.avaga.io. Owners and admins open Developers, create a workspace key, and copy the header the app shows. Use the key on a server. Do not put it in a browser bundle or a public repo. Rotate it the same way you rotate a leaked forms.js workspace key.

Google Sign-in and 2FA are on every plan. Turn 2FA on before you provision numbers. A stolen owner login is a stolen DID and a stolen API key.

curl.example

# Copy the live base URL and header from Developers in the workspace.
# Resource names below match the floor. Paths are shown in the app.

export AVAGA_KEY="YOUR_WORKSPACE_KEY"
export AVAGA_API="$YOUR_BASE_URL"

curl "$AVAGA_API/contacts" \
  -H "Authorization: Bearer $AVAGA_KEY" \
  -H "Accept: application/json"

Resources on the floor

objects

An integration should assign the contact, not the channel. Dana owns the account, so Dana sees the WhatsApp photo and the call recording. Do not model a second person per channel.

Resource	What it holds
`contacts`	One person across voice, SMS, WhatsApp, Messenger, and Instagram.
`calls`	History, DID, queue, recording flag, pause and resume.
`messages`	SMS, MMS, and chat threads in the shared inbox.
`leads`	Meta, Google Ads, LinkedIn forms, and avaga-forms.js submissions.
`recordings`	Archive audio. Who can play is a role, not a courtesy.
`transcripts`	Call and voicemail transcription. Summaries ride Assist Pro.

Workspace API

CRUD-style access to the floor objects above. On every plan.

Messaging API

Send and read inbox messages on the channels you connected. On every plan.

AI and Transcription API

Transcripts, summaries, topics, scoring. Assist Pro, included.

Example: log a CRM note after a call

POST

Map six fields once: source, seats, region, stage, next step, sentiment. If those are empty after a call, fix Studio before you buy another dashboard. AI CRM logging can write the note. The API is for the system of record you already run.

json.example

{
  "contact_id": "ct_YOUR_ID",
  "source": "google_ads",
  "seats": 12,
  "region": "US-CA",
  "stage": "qualified",
  "next_step": "demo",
  "sentiment": "positive"
}

Limits and support

ops

API access and developer support are included on Lite, Growth, and Business. Do not scan, scrape, or load-test production without written permission. Custom reports are on Business. Custom connectors that the public API cannot cover are Enterprise.

Create a key Webhooks Acceptable Use