GET `/api/v1/pipeline/runs/{id}`

A request with its stages.

Scope pipeline:read
operationId pipelineGet

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.

Request

GET /api/v1/pipeline/runs/{id}

Path parameters

Name	Description	Example
`id`	The id of the run.	`27`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <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/27" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/pipeline/runs/27",
    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/27", {
  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: PipelineRun. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`request`	string	The request in the user's words.
`status`	string	interpreted, checked, orders_created, failed or cancelled.
`interpreted_by_ai`	boolean	True when the AI interpreted the text; false when the built-in parser did.
`intent`	any	The structured intent the request was interpreted as (accounts, changes, constraints).
`stages`	any	Each stage (interpret, entitlements, proposal, compliance, orders) with its outcome.
`created_at`	date-time or null	When it was created.
`updated_at`	date-time or null	When it last changed.
`note`	string	A reminder that nothing is executed by the pipeline.

Example response

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

{
    "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."
}

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.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
429	Rate limited: wait for Retry-After seconds	`rate_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/27"
}

On the screens

The same thing in the app is explained in:

The Intent Pipeline