Overview
This API lets another system, usually a CRM, keep its own copy of the calls, appointments and contacts a Talki phone agent handles, and make a narrow set of changes, under its own credential rather than a user’s session.
You do not need a Talki customer to start. Registering an app issues a sandbox: a real Talki account, with a real business in it, that you own and can reset.
Capabilities
Section titled “Capabilities”| Capability | Surface | Status |
|---|---|---|
| Validate a key and identify its account | GET /v1/account |
Private beta |
| Configure the assistant: its settings, voice, weekly hours, closures and special openings | /v1/account, /v1/voices, /v1/working_hours, /v1/closures |
Private beta |
| Read the business’s locations, and filter, configure and book by location | GET /v1/locations, ?location_id= |
Private beta |
| Set up call forwarding and finish onboarding | /v1/account, /v1/forwarding_check, POST /v1/account/complete_onboarding |
Private beta |
| Read the talk time used and left, and the talk time of past months | GET /v1/usage, GET /v1/usage/history |
Private beta |
| Read and search calls or resume a call change feed; mark them read and archive them; delete a call for good | /v1/calls, POST /v1/calls/mark_all_read |
Private beta |
| Count calls, read call statistics, export calls as PDF or Excel | /v1/calls/count, /v1/calls/stats, /v1/calls/export, /v1/calls/{call_id}/export |
Private beta |
| Read the calls Talki refused before answering | /v1/refused_calls |
Private beta |
| Sync, create, reschedule, cancel and restore appointments | /v1/appointments |
Private beta |
| Sync, find, upsert and delete curated contacts | /v1/contacts |
Private beta |
| Approve or discard the names the assistant heard | /v1/pending_contacts |
Private beta |
| Label contacts with tags | /v1/tags |
Private beta |
| Manage VIP and blocked numbers, and read the calls the block refused | /v1/caller_rules |
Private beta |
| Sync, create, update and delete services | /v1/services |
Private beta |
| Sync capacity, create shared resources, adjust what is safe to adjust, and delete resources | /v1/resources |
Private beta |
| Follow, resolve and dismiss questions the assistant could not answer, and record the answer given | /v1/unresolved_requests |
Private beta |
| Teach the assistant the answer to a resolved question | POST /v1/unresolved_requests/{request_id}/teach |
Private beta |
| Read and write the assistant’s knowledge base: text notes, uploaded files and imported websites | /v1/documents |
Private beta |
| Find advisory bookable windows | GET /v1/availability |
Private beta |
| Receive call, appointment, contact, pending-contact, tag, caller-rule, unresolved-request, document, account, hours, closure, service, resource, location and usage events | Signed webhooks | Available from Pro |
| Let many Talki customers connect your platform | OAuth | Private beta |
| Pay for your customers’ Talki subscriptions and manage their plans | Managed billing | Private beta |
| Learn when an account installs, disconnects or loses access | App events | Private beta |
| Build against a Talki account of your own | /v1/sandbox |
Private beta |
The generated API reference is the complete REST contract. An operation absent from it is not a public endpoint.
What is not exposed
Section titled “What is not exposed”- Call audio.
- Token counts and model costs.
- Scheduling rules and internal state — service exclusions, external-calendar sync state, unit assignments, the assistant’s conversation state. Capacity is the exception, published as resources.
- Webhook endpoint management. Endpoints are created in the Talki app only.
The REST API is a Business plan feature. A valid credential on a lower plan
fails with plan_upgrade_required, so an integration can ask the account owner
to upgrade rather than report a generic permission failure.
Webhooks are available from Pro upward. Reading the REST API — change feeds and fetching an object by ID — requires Business.
An account whose subscription your app pays for reaches /v1 through your app on
every plan; see Managed billing.
Base URL
Section titled “Base URL”https://api.talki.it/v1JSON over HTTPS. Paths in the reference already include /v1.