curl --request GET \
--url "https://api.roe-ai.com/v1/workflows/runs/YOUR_RUN_ID/" \
--header "Authorization: Bearer YOUR_API_KEY"
{
"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"
}
]
}{
"detail": "<string>"
}Workflows
Retrieve Workflow Run
Get a run with its outputs once it has finished, and what each step received and returned.
GET
/
v1
/
workflows
/
runs
/
{run_id}
/
curl --request GET \
--url "https://api.roe-ai.com/v1/workflows/runs/YOUR_RUN_ID/" \
--header "Authorization: Bearer YOUR_API_KEY"
{
"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"
}
]
}{
"detail": "<string>"
}curl --request GET \
--url "https://api.roe-ai.com/v1/workflows/runs/YOUR_RUN_ID/" \
--header "Authorization: Bearer YOUR_API_KEY"
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.
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