API¶
Status: Current | Last reviewed: 2026-10-09
Use this API guide when your team is integrating with TrueServe or needs the technical execution model behind the platform: pushing events into a workflow, calling conversation-api from a backend service, streaming events into a custom UI, or choosing a deployment target.
If you're a tenant user looking for "how do I run a workflow," you want the user guide instead.
Contents¶
| Doc | Purpose |
|---|---|
| Authentication | How to mint and use API tokens (tsf_*) |
| Proficiency | Separate research assessment app; cookie-authenticated HTTP inventory and shared schemas |
| ClearConnect | Isolated PSP demo; Genesys sign-in, outbound calls, case APIs and Copilot event stream |
| AI Manager integration API | Published-agent discovery and dynamic WebRTC phone-emulator sessions, with live OpenAPI spec |
| AI Manager management API | OAuth-authenticated authoring, generation, assistant, and diagnostics APIs plus MCP |
| Knowledge Management API | Evidence preparation, source-backed evaluation, publication and MCP |
| Director application API | Scene documents, owned images, durable Agent Assist captures and recorded exports |
| conversation-api | Conversation, session-context, share-code, and conversation-event streaming API, with live OpenAPI spec |
| workflows-api | Workflow event ingest, direct execution, execution inspection, and execution-event streaming API |
| Triggering workflows | End-to-end recipes: webhook, Salesforce Pub/Sub, direct workflow execution |
| Event integration patterns | Webhook vs broker vs Salesforce Pub/Sub |
Four APIs to know¶
The platform has four externally-facing HTTP APIs:
- AI Manager integration API: published-agent discovery and short-lived dynamic phone-emulator sessions for external demo applications.
- AI Manager management API: scoped agent/workflow authoring, publishing, diagnostics, Generate with AI, and Studio-assistant access over REST and MCP.
- conversation-api: voice, chat, and multimodal conversations. REST handles conversation setup, user responses, session context, share codes, and inspection. SSE streams live conversation events.
- workflows-api: workflow event ingest, direct workflow execution, execution inspection, human-in-the-loop actions, and execution SSE streams. This API is backed by the service named
async-agentinternally.
Most external integrations touch one API. Systems that push events into TrueServe use workflows-api. Systems that pull conversation state into their own UI use conversation-api. Systems that blend custom chat UI with workflow side effects may use both.
Versioning¶
Both APIs follow /api/v1/.... Breaking changes get a new major prefix; additive changes do not. Until v2 ships, anything documented here is stable.
See also¶
Performance simulations accept an idempotent batch submission and return 202.
See the agent evaluation application API for request and response contracts.
The evaluation worker guide describes
execution, progress pagination, cancellation and independent scoring retries.
Tool mock revisions use /api/tools/{id}/testing; see tool testing.