Skip to content
Talki DevelopersBeta

Overview

Sync calls, contacts, services and appointments with Talki.

Talki API 2026-10-01

Section titled “Talki API 2026-10-01”

The private-beta Talki REST API. Read change feeds, check availability, and make narrowly scoped writes with an account API key or an OAuth access token. API access requires a Business plan.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/v1/account
PATCH
/v1/account
POST
/v1/account/complete_onboarding
GET
/v1/forwarding_check
POST
/v1/forwarding_check
GET
/v1/locations
POST
/v1/agent_test
DELETE
/v1/agent_test/{session_id}
GET
/v1/usage
GET
/v1/usage/history
GET
/v1/voices
GET
/v1/voices/{voice_id}/preview
GET
/v1/working_hours
PUT
/v1/working_hours
GET
/v1/closures
POST
/v1/closures
DELETE
/v1/closures/{closure_id}
PATCH
/v1/closures/{closure_id}
GET
/v1/calls/stats
GET
/v1/calls/count
GET
/v1/calls/export
GET
/v1/calls/{call_id}/export
GET
/v1/refused_calls
GET
/v1/refused_calls/count
GET
/v1/refused_calls/summary
GET
/v1/calls
GET
/v1/calls/{call_id}
DELETE
/v1/calls/{call_id}
PATCH
/v1/calls/{call_id}
GET
/v1/calls/{call_id}/transcript
POST
/v1/calls/mark_all_read
GET
/v1/appointments
POST
/v1/appointments
GET
/v1/appointments/{appointment_id}
DELETE
/v1/appointments/{appointment_id}
PATCH
/v1/appointments/{appointment_id}
POST
/v1/appointments/{appointment_id}/restore
GET
/v1/contacts
PUT
/v1/contacts
GET
/v1/contacts/{contact_id}
DELETE
/v1/contacts/{contact_id}
GET
/v1/pending_contacts
POST
/v1/pending_contacts/{pending_id}/approve
DELETE
/v1/pending_contacts/{pending_id}
GET
/v1/tags
POST
/v1/tags
DELETE
/v1/tags/{tag_id}
PATCH
/v1/tags/{tag_id}
PUT
/v1/tags/{tag_id}/contacts/{contact_id}
DELETE
/v1/tags/{tag_id}/contacts/{contact_id}
GET
/v1/caller_rules
POST
/v1/caller_rules
GET
/v1/caller_rules/blocked_attempts
DELETE
/v1/caller_rules/{rule_id}
PATCH
/v1/caller_rules/{rule_id}
GET
/v1/services
POST
/v1/services
GET
/v1/services/{service_id}
DELETE
/v1/services/{service_id}
PATCH
/v1/services/{service_id}
GET
/v1/resources
POST
/v1/resources
GET
/v1/resources/{resource_id}
DELETE
/v1/resources/{resource_id}
PATCH
/v1/resources/{resource_id}
GET
/v1/unresolved_requests
GET
/v1/unresolved_requests/{request_id}
PATCH
/v1/unresolved_requests/{request_id}
POST
/v1/unresolved_requests/{request_id}/teach
GET
/v1/documents
POST
/v1/documents
GET
/v1/documents/{document_id}
PUT
/v1/documents/{document_id}
DELETE
/v1/documents/{document_id}
PATCH
/v1/documents/{document_id}
GET
/v1/documents/{document_id}/text
GET
/v1/documents/{document_id}/pages
GET
/v1/documents/{document_id}/file
POST
/v1/documents/discover
DELETE
/v1/documents/{document_id}/pages/{page_id}
GET
/v1/availability
GET
/v1/sandbox/scenarios
POST
/v1/sandbox/calls
POST
/v1/sandbox/reset
POST
call.ringing WEBHOOK
POST
call.ended WEBHOOK
POST
call.transferred WEBHOOK
POST
call.updated WEBHOOK
POST
call.deleted WEBHOOK
POST
appointment.created WEBHOOK
POST
appointment.updated WEBHOOK
POST
appointment.cancelled WEBHOOK
POST
contact.created WEBHOOK
POST
contact.updated WEBHOOK
POST
contact.deleted WEBHOOK
POST
pending_contact.created WEBHOOK
POST
pending_contact.updated WEBHOOK
POST
pending_contact.deleted WEBHOOK
POST
tag.created WEBHOOK
POST
tag.updated WEBHOOK
POST
tag.deleted WEBHOOK
POST
caller_rule.created WEBHOOK
POST
caller_rule.updated WEBHOOK
POST
caller_rule.deleted WEBHOOK
POST
account.updated WEBHOOK
POST
working_hours.updated WEBHOOK
POST
closure.created WEBHOOK
POST
closure.updated WEBHOOK
POST
closure.deleted WEBHOOK
POST
location.created WEBHOOK
POST
location.updated WEBHOOK
POST
location.deactivated WEBHOOK
POST
location.reactivated WEBHOOK
POST
location.settings_updated WEBHOOK
POST
location.working_hours_updated WEBHOOK
POST
service.created WEBHOOK
POST
service.updated WEBHOOK
POST
service.deleted WEBHOOK
POST
resource.created WEBHOOK
POST
resource.updated WEBHOOK
POST
resource.deleted WEBHOOK
POST
document.created WEBHOOK
POST
document.updated WEBHOOK
POST
document.deleted WEBHOOK
POST
unresolved_request.updated WEBHOOK
POST
usage.threshold_reached WEBHOOK
POST
usage.extra_credits_low WEBHOOK
POST
ping WEBHOOK
POST
installation.created WEBHOOK
POST
installation.scopes_changed WEBHOOK
POST
installation.revoked WEBHOOK
POST
installation.access_suspended WEBHOOK
POST
installation.access_restored WEBHOOK

Authentication

Section titled “ Authentication ”

ApiKeyAuth

Section titled “ApiKeyAuth”

A scoped account API key (talki_live_…, talki_test_…) or an OAuth access token (talki_at_…).

Security scheme type: http