Skip to main content
The ResponseCX public API builds and operates customer-experience agents: their rules, their tools, the knowledge they answer from, and the record of what they actually said.
This reference is generated from that document, so it matches the running service rather than a copy kept beside it. Every page names the scope a key needs and the endpoint’s per-minute rate limit, both of which come from the spec.

​
Where to start

Workspace

One call that reports what exists and suggests a next action. Start here rather than guessing at the shape of an empty account.

Provision an agent

Settings, rules, functions and knowledge in a single atomic call.

Read real conversations

What customers asked and how the agent answered — read these before changing an agent, and after, to check the change held.

Close the loop

Record what the agent should have said. An eval becomes a regression case rather than a note.

​
Your first call

Orientation before anything else — workspace reports what exists and what to do next, so you are not guessing at the shape of an account you have not seen.
cURL
Creating an agent takes an idempotency key, so a retry after a timeout returns the first result rather than a second agent:
cURL

​
The build → verify loop

The API is shaped around one cycle, and the endpoints are most useful in this order:
  1. Orient — GET /workspace reports what is configured and what is missing.
  2. Build — POST /agents/provision, or the individual rule, function and knowledge endpoints.
  3. Verify — POST /agents/{id}/evals/run replays the suite against a change.
  4. Observe — GET /conversations and GET /analytics/agents show what happened in production.
  5. Correct — POST /evals records the reply that should have been sent, which feeds step 3.
The six endpoints that create something — an agent, a provisioned agent, a rule, a function, an eval, a knowledge document — take an Idempotency-Key header. Retrying with the same key returns the original result rather than creating a second one. Updates and runs do not take it.

​
Scopes

Every endpoint declares the scope its key must carry. Across the 38: