RunsList runs

List runs

Returned newest first (started_at DESC). List shape - checks, reviews, and the decision fields are deliberately absent; list to find runs, then GET /v1/runs/{id} to read results.

status and decision are independent axes and are AND-ed together. Every pairing is legal; ?status=completed&decision=review - runs that look finished but are not - is the most useful one.

?status=failed does not return expired runs. Query both if you mean "everything that halted badly".

curl -X GET "https://api.deepvue.link/v1/runs?workflow_id=123e4567-e89b-12d3-a456-426614174000&status=in_progress&decision=review&limit=50&offset=0" \
  -H "Content-Type: application/json" \
  -H "client-id: YOUR_API_KEY" \
  -H "x-api-key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workflow_id": "123e4567-e89b-12d3-a456-426614174000",
      "reference_id": "example_string",
      "status": "in_progress",
      "started_at": "2024-12-25T10:00:00Z",
      "completed_at": "2024-12-25T10:00:00Z",
      "action_required": {
        "type": "customer_input",
        "signal_name": "selfie_captured",
        "url": "example_string"
      },
      "error": {
        "code": "CHECK_FAILED",
        "check": "example_string",
        "message": "example_string"
      }
    }
  ],
  "total": 128,
  "limit": 50,
  "offset": 0
}
GET
/v1/runs
GET
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: client-id)
client-idstring
Required

Your Deepvue client identifier.

Your Deepvue client identifier.
API Key (header: x-api-key)
x-api-keystring
Required

Your Deepvue API key. Secret - keep it server-side.

Your Deepvue API key. Secret - keep it server-side.
query
statusstring

Any one of the six run statuses.

Options: in_progress, abandoned, completed, failed, expired, cancelled
query
decisionstring

Where a human verdict stands - an axis independent of status.

Options: review, approve, reject
query
limitinteger

Page size, 1–200.

Min: 1 • Max: 200
query
offsetinteger

Number of records to skip.

Min: 0
Request Preview
Response

Response will appear here after sending the request

Authentication

header
client-idstring
Required

API Key for authentication. Your Deepvue client identifier.

header
x-api-keystring
Required

API Key for authentication. Your Deepvue API key. Secret - keep it server-side.

Query Parameters

statusstring

Any one of the six run statuses.

Allowed values:in_progressabandonedcompletedfailedexpiredcancelled
decisionstring

Where a human verdict stands - an axis independent of status.

Allowed values:reviewapprovereject
limitinteger

Page size, 1–200.

offsetinteger

Number of records to skip.

Responses

dataarray
Required
totalinteger
Required
limitinteger
Required
offsetinteger
Required