GET `/api/v1/commands/{id}`

A command with its plan, preview and results.

Scope ai:use
operationId aiCommand

The token needs the scope ai:use, 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/commands/{id}

Path parameters

Name	Description	Example
`id`	The id of the command.	`55`

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/commands/55" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/commands/55",
    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/commands/55", {
  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: Command. 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).
`screen`	string	The screen the command is for: portfolio, blotter, monitor or wfrules.
`text`	string	The command in the user's words.
`status`	string	planned, question, previewed, executed, cancelled, stale or failed.
`planned_by_ai`	boolean	Planned by ai.
`question`	string or null	A clarifying question, when something material is ambiguous.
`message`	string	What Vestoris says about the plan.
`plan`	object	The typed actions the command was planned as.
`preview`	object or null	What would happen: each item before and after, what is left out and why.
`item_count`	integer	How many items the plan touches.
`confirm_token`	string or null	Send this in X-Vestoris-Confirm to confirm exactly what was previewed.
`typed_confirmation`	string or null	Text to send as "typed" for large or destructive plans.
`results`	list	Each item's result.
`created_at`	date-time or null	When it was created.
`previewed_at`	date-time or null	When the preview was made.
`executed_at`	date-time or null	When the plan was executed.

Example response

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

{
    "id": "1042",
    "screen": "blotter",
    "text": "Cancel all my unfilled AAPL buys",
    "status": "previewed",
    "planned_by_ai": true,
    "question": null,
    "message": "3 orders would be cancelled; 1 is left out (already filled).",
    "plan": {
        "actions": [
            {
                "type": "cancel_orders",
                "filter": {
                    "side": "buy",
                    "symbols": [
                        "AAPL"
                    ],
                    "mine": true
                }
            }
        ]
    },
    "preview": null,
    "item_count": 3,
    "confirm_token": "vcf_8a1c…",
    "typed_confirmation": "CONFIRM 3",
    "results": [],
    "created_at": "2026-10-27T14:30:00Z",
    "previewed_at": null,
    "executed_at": null
}

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/commands/55"
}

On the screens

The same thing in the app is explained in: