Skip to main content
POST
/
workflows
/
run
A valid request URL is required to generate request examples
{
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "created_at": 123,
    "finished_at": 123,
    "outputs": {},
    "error": "<string>",
    "elapsed_time": 123,
    "total_tokens": 123,
    "total_steps": 0
  }
}

Authorizations

​
Authorization
string
header
required

API Key authentication.

Body

application/json
​
inputs
object
required

Key/value pairs for workflow variables. Value for a file array type variable should be a list of InputFileObjectWorkflow.

Example:
{
  "user_query": "Translate this for me.",
  "target_language": "French"
}
​
response_mode
enum<string>
required

Response mode. Cloudflare timeout is 100s for blocking.

Available options:
streaming,
blocking
​
user
string
required

User identifier.

Response

Successful workflow execution. Structure depends on response_mode.

  • blocking: application/json with WorkflowCompletionResponse.
  • streaming: text/event-stream with ChunkWorkflowEvent stream.

Response for blocking mode workflow execution.

​
workflow_run_id
string<uuid>
​
task_id
string<uuid>
​
data
object