Run a flow
For a Flow with inputs: send inputs keyed as the listing names them; they are validated against the Flow's inputSchema before anything runs or is charged, and the Flow runs once. Nothing is kept between calls. For a Flow with no inputs: send message and optionally conversation_id, the Agent contract. stream: true answers as Server-Sent Events with the run's event stream (opening event run_started for a form Flow, conversation_started otherwise). Runs the Flow's PUBLISHED version and spends the organization's credits. Requires the flows:execute scope.
Authorization
apiKey An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08/run" \ -H "Content-Type: application/json" \ -d '{}'{ "output": "string", "execution_id": "02ca5b65-a269-4c45-8d4a-0c74ff3ae670"}