Test Agent | BookedIn Documentation

Test an agent’s responses without sending real messages. Useful for validating prompt configuration and tool behavior before deployment. Use the same session_id across requests to maintain conversation context.

Authentication

X-API-Keystring

Your API key from Dashboard → Settings → API Keys

Your API key from [Dashboard → Settings → API Keys](https://dashboard.bookedin.ai/settings)

Path parameters

agent_idstringRequired

Agent ID to test

Request

This endpoint expects an object.

messagestringRequired

The test message to send to the agent

channelenumOptionalDefaults to sms

Channel to simulate. Determines which channel profile's configuration and tools are used.

session_idstringOptionalformat: "uuid"

Session ID for conversation continuity. Omit to start a new conversation, provide to continue an existing one.

Response

Agent response

responsestring or null

The agent's generated response

session_idstring or null

Session ID for this conversation. Use in subsequent requests to maintain context.

conversation_historylist of objects or null

Full conversation history for this session

tool_callslist of objects or null

Tools called by the agent during response generation

usageobject or null

Token usage statistics

1	curl -X POST https://api.bookedin.ai/api/v1/agents/agent_id/test \
2	-H "X-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"message": "What are your pricing options?",
6	"channel": "sms",
7	"session_id": "550e8400-e29b-41d4-a716-446655440000"
8	}'

1	{
2	"response": "string",
3	"session_id": "string",
4	"conversation_history": [
5	{
6	"role": "user",
7	"content": "string",
8	"timestamp": 1.1,
9	"tool_calls": [
10	{}
11	]
12	}
13	],
14	"tool_calls": [
15	{
16	"function": {
17	"name": "string",
18	"arguments": "string"
19	}
20	}
21	],
22	"usage": {
23	"prompt_tokens": 1,
24	"completion_tokens": 1,
25	"total_tokens": 1
26	}
27	}

Authentication

Path parameters

Request

Response

Errors