API ReferenceReferenceFlows
Run the draft
Runs the UNPUBLISHED draft once, so a change can be checked before publishing. Spends the organization's credits. Requires the flows:write scope.
Authorization
apiKey AuthorizationBearer <token>
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
flowId*string
Format
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
curl -X POST "https://example.com/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft/run" \ -H "Content-Type: application/json" \ -d '{}'{ "output": "string", "draft": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "name": "string" }, "executionId": "fc49a52d-e069-4441-83c6-8d779c937dd9", "conversationId": "string"}