Skip to main content

​
Endpoint

POST /v1/tools/run/{toolId}

​
Request

​
Path parameters

ParameterTypeDescription
toolIduuidThe ID of the tool to execute

​
Headers

HeaderValue
X-API-KeyYour API key
Content-Typeapplication/json

​
Body (optional)

{
  "inputField1": "value1",
  "inputField2": 42
}
The body is a free-form JSON object matching the tool’s parameter schema. If the tool has no parameters, the body can be omitted.

​
Response

{
  "success": true,
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "status": "Pending",
  "message": "Tool run started"
}

​
Errors

StatusDescription
400Invalid request or insufficient credits
401Invalid or missing API key
403API access not enabled on your plan
404Tool not found
429Rate limit exceeded

​
Example

curl -X POST https://api.flowyble.com/v1/tools/run/770e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: flw_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/data.csv", "format": "summary"}'