DevelopersEssentials
Versioning and changelog
The API version is part of the path: every endpoint is under /v1. Within a version, changes are backwards compatible, so code written today keeps working.
Changes that can happen within v1
These ship without a new version or notice. Write your code so they don't break it:
- New endpoints, and new optional query parameters or body fields.
- New fields in responses and in webhook payloads. Ignore fields you don't know; don't fail on them.
- New values in fields that list kinds of things (a call's
category, an appointment'ssource) and new webhook event types. Handle values you don't recognize gracefully. - New error codes within the existing error types. Branch on
typefor anything you don't handle specifically. - New scopes. Existing keys keep exactly the scopes they had.
- Changes to
messagetexts, ordering of JSON keys, and the format of ids, cursors and request ids (treat them as opaque strings).
Breaking changes
Removing or renaming a field or endpoint, changing a field's type or meaning, making an optional parameter required, or changing how authentication works would break existing code, so those only come with a new version (/v2). We'll announce it here and email the owners of accounts with active keys before anything changes for /v1.
Endpoints that are being replaced are marked Deprecated in the reference while they keep working.
The OpenAPI document
The current description of v1 is served at https://api.assistcall.ai/v1/openapi.json (OpenAPI 3.1.0, version 1.0.0, 47 operations). This reference is generated from the same document, so they always match.
Changelog
The AssistCall API v1
- OAuth 2.0 client-credentials keys, created on the Developers page of the dashboard and the API page of the partner portal, with scopes and optional IP allowlists.
- Calls and transcripts, messages, appointments, contacts, intake forms and their answers, knowledge (packages and articles), AI Employees, phone numbers, usage and webhook endpoints.
- The partner API: clients, packages and per-client usage, and the AssistCall-Account header for working on one client.
- Read-only sandbox accounts for a demo client and a demo reseller (credentials on request), and a Try it console in the reference that uses the key you enter.
- The OpenAPI 3.1 document at /v1/openapi.json.