Skip to main content
GET
/
api
/
v2
/
workflows
/
run
/
status
Get Workflow Run Status
curl --request GET \
  --url https://app.octavehq.com/api/v2/workflows/run/status \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "jobOId": "<string>",
    "totalCount": 123,
    "processedCount": 123,
    "successCount": 123,
    "failedCount": 123,
    "startedAt": "<string>",
    "completedAt": "<string>",
    "createdAt": "<string>",
    "workflowOId": "<string>",
    "callbackUrl": "<string>",
    "circuitBreakerReason": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api_key
string
header
required

Query Parameters

jobOId
string
required

The OId of the workflow run job to check status for

Minimum string length: 1
Example:

"bsjob_3rgkoHhR00cEdE9DjKeIK"

Response

Workflow run status

_metadata
object
required
data
object
required