Developers › API reference › Pipeline

GET /api/v1/pipeline/runs

Your intent-pipeline requests.

  • Scope pipeline:read
  • operationId pipelineList

The token needs the scope pipeline:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Paginated. Cursor pagination: limit (1 to 200, default 50); pass next_cursor as cursor until has_more is false. fields= returns only the named fields.

Request

GET /api/v1/pipeline/runs

Query parameters

NameRequiredDescription
limitnoPage size, 1 to 200 (default 50)
cursornoThe next_cursor of the previous page
sortno"-id" (newest first, default) or "id"
fieldsnoSparse fieldset: comma-separated field names

Headers

HeaderRequiredValue
AuthorizationyesBearer <token>: an OAuth access token (vat_…) or a personal access token (vpt_…). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/pipeline/runs" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/pipeline/runs",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/pipeline/runs", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: a page of PipelineRun. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields
FieldTypeDescription
datalist of PipelineRunThe records of this page.
data[].idid (string)The record's id (a string of digits).
data[].requeststringThe request in the user's words.
data[].statusstringinterpreted, checked, orders_created, failed or cancelled.
data[].interpreted_by_aibooleanTrue when the AI interpreted the text; false when the built-in parser did.
data[].intentanyThe structured intent the request was interpreted as (accounts, changes, constraints).
data[].stagesanyEach stage (interpret, entitlements, proposal, compliance, orders) with its outcome.
data[].created_atdate-time or nullWhen it was created.
data[].updated_atdate-time or nullWhen it last changed.
data[].notestringA reminder that nothing is executed by the pipeline.
next_cursorstring or nullPass as ?cursor= for the next page; null on the last page.
has_morebooleanTrue when another page follows.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": "1042",
            "request": "Rebalance growth accounts, no gains over $25k",
            "status": "checked",
            "interpreted_by_ai": true,
            "intent": {
                "action": "rebalance",
                "accounts": [
                    "tag:growth"
                ],
                "constraints": {
                    "max_realized_gain": "25000"
                }
            },
            "stages": [
                {
                    "stage": "entitlements",
                    "ok": true,
                    "accounts": [
                        "12",
                        "14"
                    ]
                },
                {
                    "stage": "compliance",
                    "ok": true,
                    "warnings": 1
                }
            ],
            "created_at": "2026-10-27T14:30:00Z",
            "updated_at": "2026-10-27T14:30:00Z",
            "note": "Nothing is executed: create orders, then release them."
        }
    ],
    "next_cursor": "eyJpZCI6NTI5OX0",
    "has_more": true
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

StatusWhenProblem codes
200Success
400The request is malformedinvalid_request
401No token, or it is invalid or expiredinvalid_token
403The token lacks the scope, or the person or service account behind it lacks the privilege or account permissioninsufficient_scope forbidden ip_not_allowed
429Rate limited: wait for Retry-After secondsrate_limited
{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/pipeline/runs"
}

On the screens

The same thing in the app is explained in: