Skip to main content
cURL
curl --request GET \
  --url https://api.simplex.sh/run_workflow_status \
  --header 'X-API-Key: <api-key>'
{
  "succeeded": true,
  "completed": true,
  "results": [
    {
      "action": "<string>",
      "params": {},
      "result": {},
      "timestamp": "<string>"
    }
  ],
  "total_actions": 123,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "completed_at": "<string>"
}
Gets the status of a running workflow.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Query Parameters

​
session_id
string<uuid>
required

The ID of the session to check the status of.

Response

Workflow status response

​
succeeded
boolean
required

Whether the request succeeded.

​
completed
boolean

Whether the workflow has completed.

​
results
object[]

Action results from the workflow execution.

​
total_actions
integer

Total number of actions in the workflow.

​
session_id
string<uuid>

The session ID.

​
completed_at
string

When the workflow completed.

⌘I