API reference · Tools

Test a tool

POSThttps://goblins-call-api.onrender.com/v1/tools/:id/test

Runs the tool once against your endpoint with the arguments you give, and returns what came back. The request carries X-Goblin-Test-Call: true so your endpoint can tell it is not a real caller.

Needs a workspace API key.

Path parameters

idstringRequired

The tool’s ID, such as tool_5d2e8a41c07b.

Body

paramsobjectOptional

Argument values by name, as the model would supply them. Keys and values are strings.

Response

successboolean

Whether your endpoint answered with a 2xx status.

statusinteger

Your endpoint’s HTTP status; 504 when it timed out.

dataany

The response body, parsed as JSON when it is JSON.

errorstring

Set when the request failed.

Errors

404

No tool in your workspace has that ID.

Every request can also answer 401, 429 and 500: see Errors.

Notes

  • The answer is 200 even when your endpoint failed; read success.
curl -X POST "https://goblins-call-api.onrender.com/v1/tools/tool_5d2e8a41c07b/test" \
  -H "Authorization: Bearer $CRACKLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": {
    "order_id": "A-1042"
  }
}'
Response · 200 OK
{
  "success": true,
  "status": 200,
  "latencyMs": 184,
  "data": { "status": "out for delivery", "eta": "today, 4 to 6 pm" },
  "headers": { "content-type": "application/json" }
}