Skip to main content
Clarity has two REST APIs. Both take JSON, return JSON, and use the same organization API key.

​
Voice API conventions

  • Everything lives in a project. Paths start with /v1/projects/{projectId}. List your projects with GET /v1/projects to find the id.
  • Agents have versions. Changes go to a draft; calls use the published version. Publishing validates the whole configuration. See Agents.
  • A conversation is one customer interaction. It can span several call legs (calls), for example after a transfer. See Conversations.

​
Support API conventions

  • The organization is implicit. Your key identifies it, so no path takes an organization id.
  • Actions are POSTs. Most changes use a verb path such as /api/ticket/status_set or /api/customer/edit rather than PUT on a resource.
  • Ids are integers. Tickets, customers, and webhooks are addressed by integer id.

​
Playground

Every endpoint page has a playground. Paste your key under Authorization and the request runs against your live organization, so start with a read such as GET /v1/projects or GET /api/webhooks/list.

​
Getting started

Authentication

Get a key and send it.

Errors

What each status code means and what to do.