Skip to main content
GET
/
workflows
/
{workflowId}
/
runs
/
{runId}
Get workflow run status
curl --request GET \
  --url https://api.usebits.com/api/public/v1/workflows/{workflowId}/runs/{runId} \
  --header 'x-api-key: <api-key>'
{
  "id": "clx123abc",
  "status": "streaming",
  "startedAt": "2024-01-01T00:00:00.000Z",
  "completedAt": "2024-01-01T00:05:00.000Z",
  "error": null,
  "liveViewUrl": "https://browser-live-view.onkernel.com/abc123",
  "model": "sonnet",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Keys start with 'bb_' prefix.

Path Parameters

​
workflowId
string
required
Example:

"clx123abc"

​
runId
string
required
Example:

"clx456def"

Response

Workflow run status

​
id
string
required
Example:

"clx123abc"

​
status
enum<string>
required

Current status of the workflow run

Available options:
streaming,
resumable,
ended
Example:

"streaming"

​
startedAt
string<date-time> | null
required

When the workflow run started

Example:

"2024-01-01T00:00:00.000Z"

​
completedAt
string<date-time> | null
required

When the workflow run completed

Example:

"2024-01-01T00:05:00.000Z"

​
error
string | null
required

Error message if the run failed

Example:

null

​
liveViewUrl
string | null
required

URL to view the browser session in real-time

Example:

"https://browser-live-view.onkernel.com/abc123"

​
model
string | null
required

AI model used for the run

Example:

"sonnet"

​
createdAt
string<date-time>
required

When the task run record was created

Example:

"2024-01-01T00:00:00.000Z"