Playground API

Test an agent before it goes live. Run one real turn, streamed exactly as the widget streams it, file the lead form against a test contact, and list, read or clear the test conversations, each with what it cost. Test conversations are kept apart from real ones.

On this page

Endpoints
Authentication
Objects returned

Endpoints#

6 operations, each with its parameters, schemas and an example request on its own page.

postPlayground chat/api/agents/{agent_id}/playground/chatOne real turn, streamed with exactly the widget's frames.
postPlayground lead/api/agents/{agent_id}/playground/leadThe widget's lead form, filed on the test contact.
getPlayground sessions/api/agents/{agent_id}/playground/sessionsThis agent's test conversations, newest first, with what each cost.
deleteClear playground/api/agents/{agent_id}/playground/sessionsEvery test conversation this agent has, gone. Credits already drawn stay drawn.
getPlayground session/api/agents/{agent_id}/playground/sessions/{conversation_id}One test conversation, message by message, as the owner saw it.
deleteDelete playground session/api/agents/{agent_id}/playground/sessions/{conversation_id}

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

Message2 fields

messagestringrequired
okboolean
Default: true

Something unclear or missing? Tell us and we’ll fix it.