Skip to main content

​
Endpoint

POST /v1/agents/run/{agentId}

​
Request

​
Path parameters

ParameterTypeDescription
agentIduuidThe ID of the agent to execute

​
Headers

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

​
Body

{
  "userMessage": "Summarize the Q4 sales report"
}
FieldTypeRequiredDescription
userMessagestringYesThe message to send to the agent

​
Response

{
  "success": true,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Pending",
  "message": "Agent run started"
}
FieldTypeDescription
successbooleanWhether the request was accepted
iduuidThe agent run ID — use this to poll for results
statusstringInitial run status (Pending)
messagestringHuman-readable status message

​
Errors

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

​
Example

curl -X POST https://api.flowyble.com/v1/agents/run/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: flw_key_abc123" \
  -H "Content-Type: application/json" \
  -d '{"userMessage": "Summarize the Q4 sales report"}'