Skip to main content

Create Test Run

POST/api/v1/workflow/{workflow_id}/runs

Create a new workflow run when the user decides to execute the workflow via chat or voice Args: workflow_id: The ID of the workflow to run request: The create workflow run request user: The user to create the workflow run for

cURL example

curl -X POST \
  'http://localhost:8000/api/v1/workflow/{workflow_id}/runs' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Parameters

NameLocationTypeDescription
workflow_idrequiredpathinteger
authorizationheaderobject
X-API-Keyheaderobject

Request body

application/json
View schema
{
  "$ref": "#/components/schemas/CreateWorkflowRunRequest"
}

Responses

200Successful Response
application/json
View schema
{
  "$ref": "#/components/schemas/CreateWorkflowRunResponse"
}
404Not found
422Validation Error
application/json
View schema
{
  "$ref": "#/components/schemas/HTTPValidationError"
}