Test Assistant Tool

POST 
/ai/assistants/:assistant_id/tools/:tool_id/test

Test a webhook tool for an assistant

Path Parameters

assistant_id Assistant Idrequired
tool_id Tool Idrequired

application/json

Body

arguments object

Key-value arguments to use for the webhook test

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

Response model for webhook tool test results

success Success (boolean)required

status_code Status Code (integer)required

content_type Content Type (string)required

response Response (string)required

request objectrequired

Response model for webhook tool test results

{
  "data": {
    "success": true,
    "status_code": 0,
    "content_type": "string",
    "response": "string",
    "request": {}
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id/test' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "arguments": {}
}'

Response samples

• 200
• 422

---

{
  "data": {
    "success": true,
    "status_code": 0,
    "content_type": "string",
    "response": "string",
    "request": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}