Skip to main content
POST
/
tool
/
{id}
/
test
curl --request POST \
--url https://api.iwy.ai/v1/tool/{id}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"parameters": {
"city": "Paris"
}
}'
{
"success": true,
"execution_time_ms": 1234,
"tool": {
"id": "dcfae097-1b37-4444-bb0c-1a6abb0320fd",
"name": "get_weather"
},
"request_sent": {
"url": "https://webhook.example.com/weather",
"method": "POST",
"headers": {
"Content-Type": "application/json",
"x-api-key": "[REDACTED]"
},
"payload": {
"tool_id": "dcfae097-1b37-4444-bb0c-1a6abb0320fd",
"tool_name": "get_weather",
"parameters": {
"city": "Paris"
}
}
},
"response_received": {
"status": 200,
"status_text": "OK",
"headers": {
"content-type": "application/json",
"content-length": "256"
},
"body": {
"temperature": 18,
"conditions": "Partly cloudy",
"humidity": 65
},
"content_type": "application/json"
}
}

Authorizations

Authorization
string
header
required

Your iwy Service API Key. Find it at app.iwy.ai/settings.

Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

id
string<uuid>
required

The unique identifier (UUID) of the tool

Body

application/json
parameters
object
required

Parameters to pass to the tool

Example:
{ "city": "Paris" }
validate_only
boolean
default:false

Only validate parameters without calling webhook

Response

Tool test executed successfully

success
boolean
required

Whether the test was successful

execution_time_ms
integer

Execution time in milliseconds

validation
string

Validation status (for validate_only requests)

message
string

Human-readable message

tool
object

Tool information

request_sent
object

Details of the request sent to webhook

response_received
object

Response from the webhook