curl --request POST \
--url "https://api.roe-ai.com/v1/workflows/YOUR_WORKFLOW_ID/runs/" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"inputs": {"customer_id": "c_123"},
"wait": true
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"inputs": "<unknown>",
"outputs": [
"<unknown>"
],
"steps": [
{
"step_id": "<string>",
"execution_path": "<unknown>",
"status": "succeeded",
"child_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cached": true,
"input": null,
"output": null,
"error": "<string>",
"delivery": "sending",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
]
}[
"<string>"
]{
"detail": "<string>"
}{
"detail": "<string>"
}Workflows
Run Workflow
Start a run of the current version, or of version_id. With wait, the response comes when the run finishes or after 60 seconds, whichever is first.
POST
/
v1
/
workflows
/
{workflow_id}
/
runs
/
curl --request POST \
--url "https://api.roe-ai.com/v1/workflows/YOUR_WORKFLOW_ID/runs/" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"inputs": {"customer_id": "c_123"},
"wait": true
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"inputs": "<unknown>",
"outputs": [
"<unknown>"
],
"steps": [
{
"step_id": "<string>",
"execution_path": "<unknown>",
"status": "succeeded",
"child_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cached": true,
"input": null,
"output": null,
"error": "<string>",
"delivery": "sending",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z"
}
]
}[
"<string>"
]{
"detail": "<string>"
}{
"detail": "<string>"
}curl --request POST \
--url "https://api.roe-ai.com/v1/workflows/YOUR_WORKFLOW_ID/runs/" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"inputs": {"customer_id": "c_123"},
"wait": true
}'
Authorizations
Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.
Path Parameters
Query Parameters
Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.
Body
application/json
Values for the workflow's inputs, keyed by input. A file input takes a file id or URL, or the file itself in a multipart request.
The version to run. Defaults to the current one.
Wait up to 60 seconds for the run to finish, then return it as it stands.
Response
pending- pendingrunning- runningsucceeded- succeededfailed- failedcancelled- cancelled
Available options:
pending, running, succeeded, failed, cancelled The result step's output, once the run has finished.
Show child attributes
Show child attributes