Live API testing

Paste a tq_live_… key from Settings → API Keys. Requests are sent through this docs server to /api/v1/… (no browser CORS). The key is kept in sessionStorage only.

Resource constraints

The API enforces the same safety rules as the dashboard. When a delete is blocked you receive HTTP 409 with code resource_in_use.

Agents

Action	Rule
Delete	Set `is_active` to `false` first (stop the agent).
Delete	Remove linked web channels, SIP endpoints, phone numbers, and SIP trunks before deleting the agent.
Create	Requires `system_prompt`. Voice agents require `voice_id`.

Stop an agent before delete:

PATCH /api/v1/agents/{agent_id}
{ "is_active": false }

Action	Rule
Delete	Set `is_active` to `false` before deleting the channel.
Create	`agent_id` must reference a published agent in your organization.

Tools

Action	Rule
Delete	Detach the tool from all agents (`PATCH` agent with updated `tools` array) before deleting.

Files

Action	Rule
Delete	Clear `knowledge_file` on any agent using this file before deleting.

Recommended setup order

Create agent — prompt, voice, pipeline fields
Create web channel — link agent_id, configure allowed_domains
Test — use the widget embed token from the channel response or dashboard

Use Try it live on each endpoint page after saving your API key. The playground calls /api/proxy/v1/… on this docs host, which forwards to your Taliiq backend at /api/v1/….

Constraints