Run AI Flow

Execute an AI Flow asynchronously and receive a Job UUID to track execution.

POST/api/v1/workspaces/{workspace_uuid}/prompts/{flow_uuid}/run

Execute an AI Flow asynchronously.

This endpoint immediately starts execution of the specified AI Flow and returns a unique job_uuid. The flow continues running in the background, allowing your application to continue without waiting for the execution to finish.

Use the returned job_uuid to monitor the execution status or retrieve the final result.

*Required field

Headers

Header	Type	Description
`Authorization`	`string`	Bearer token in the format Bearer <your_api_token>. Required if the token is not provided as a query parameter.

Parameters

Parameter	Type	Description
`workspace_uuid`*	`string`	Unique identifier of the workspace.
`flow_uuid`*	`string`	Unique identifier of the AI Flow.
`token`	`string`	API token supplied as a query parameter instead of the Authorization header.

Request Body

Field	Type	Description
`host`	`string`	Value for the 'host' placeholder defined in the AI Flow.
`service`	`string`	Value for the 'service' placeholder defined in the AI Flow.

Response Status Codes

200Flow execution started successfully.

400Invalid request body.

401Unauthorized. Invalid or missing API token.

404AI Flow not found.

curl -X POST \
  https://{your_domain}/api/v1/workspaces/{workspace_uuid}/prompts/{flow_uuid}/run \
  -H "Authorization: Bearer <your_api_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "example.com",
    "service": "Customer Support"
  }'

Response 200JSON

{
  "meta": {
    "job_uuid": "job-...",
    "message": "Your job has been started successfully. Use Job UUID to track the execution status.",
    "start_at": 1779705146409,
    "status": "SUBMITTED"
  }
}