Test Agent

POST

/api/v1/admin/projects/{project_id}/test

Run one test message through the agent without sending to a real channel.

Parameters

Path Parameters

project_id

required

Project Id

string format: uuid

Header Parameters

X-Admin-Key

Any of:

string

string

null

null

X-Admin-API-Key

Any of:

string

string

null

null

X-Project-ID

Any of:

string

string

null

null

Request Body ^required

AgentTestRequest

Payload for testing an agent without a live channel.

object

channel

Channel

string

default: sms /^(whatsapp|sms|ios|telegram)$/

message

required

Message

string

>= 1 characters

phone_e164

Phone E164

string

default: +15550000000 /^\+[1-9]\d{1,14}$/

Responses

200

Successful Response

AgentTestResponse

Agent test endpoint response.

object

cost_usd

Cost Usd

number

0

details

Any of:

string

string

null

null

error

Any of:

string

string

null

null

metadata

Metadata

object

key

additional properties

any

model_used

Any of:

string

string

null

null

response

Any of:

string

string

null

null

response_text

Response Text

string

""

suggestion

Any of:

string

string

null

null

warnings

Warnings

Array<string>

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string