Skip to main content
POST
Start a workflow execution

Authorizations

X-API-Key
string
header
required

[Production] API key for production authentication

Body

application/json

Workflow execution parameters

projectId
string
required
Example:

"507f1f77bcf86cd799439011"

userInput
string
required
Example:

"Create a weather lookup tool that fetches current weather for a given city"

workflowReferenceId
string
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Accepted

completedAt
integer
Example:

1711929610

createdAt
integer
Example:

1711929600

currentStepId
string
Example:

"extract-params"

inputPrompt
string
Example:

"Review and confirm the extracted parameters"

runId
string
Example:

"507f1f77bcf86cd799439011"

status
enum<string>
Available options:
pending,
running,
awaiting_input,
completed,
failed,
cancelled
Example:

"running"

stepResults
object[]
userInput
string
Example:

"Create a weather lookup tool"

workflowReferenceId
string
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"