Skip to main content
The Decimal API puts your AI agent behind your own interface and lets you manage the data it works from. Teams use it to:
  • Answer customer questions in their own app, from your knowledge base and code
  • Hand a conversation to your helpdesk when the customer needs a person
  • List, look up, or delete tickets synced from your helpdesk
  • Search, audit, and clean up knowledge articles
  • Read audit logs, pull requests, gaps, and automations

​
Fundamentals

  • The API is REST over HTTPS. Requests and responses are JSON.
  • Every request goes to https://api.getdecimal.ai/v0/... with a Bearer token. Its scopes decide which endpoints it can call.
  • Requests are rate limited per token and per organization.
  • Errors share one response shape with a machine-readable code.
  • List endpoints use cursor pagination.
  • Endpoints that create something accept an idempotency key, so a retry never sends a message twice.
  • Every response has a Request-Id header. Include it when you email support.

​
Quickstart

Create a token under Settings → API Keys with the chat:write and chat:read scopes, then send a message:
The API answers 202 Accepted right away with a conversation_id. The agent works in the background, so poll the conversation until status is completed:
To ask a follow-up, send another message with the same conversation_id.

​
API playground

Every endpoint page has a Try it button. Paste your token into the Authorization field, fill in the parameters, and send the request against your workspace. The panel beside it shows the same request as code in several languages.
The playground calls the production API. Deleting a ticket or knowledge article from it can’t be undone.

​
API families

The Chat API sends a customer’s question to your agent and returns its answer with citations. Answers draw on your public knowledge base and code, and follow your Policies.
The Escalation API hands a conversation to your helpdesk as a ticket, with the transcript and an AI summary.
The Tickets API lists tickets synced from your helpdesk, fetches one by Decimal ID or helpdesk ID, downloads its files, and deletes a ticket by helpdesk ID.
The Knowledge API lists, searches, and deletes the articles your agent answers from.
The Audit logs API lists who did what in your organization. Requires audit logs on your plan.
The Pull requests API lists and reads pull requests from your connected repositories.
The Gaps API lists and reads the changes Decimal proposes to your knowledge base, docs, and code.
The Automations API lists and reads your automation definitions, triggers, and run history.
Check a token’s name, scopes, and organization.