Developers › API reference › AI

POST /api/v1/commands/{id}/execute

Execute the previewed plan (X-Vestoris-Confirm: the preview token; "typed" for large or destructive plans).

• Scope commands:execute
• Idempotency-Key
• Confirmation
• operationId aiExecute

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

Request

POST /api/v1/commands/{id}/execute

Path parameters

Headers

Body: CommandExecute

No fields.

Other fields of the resource are accepted too; unknown fields are reported by a validation problem, never ignored silently.

Decimals (money, prices, quantities, percentages) are sent as strings, ids as strings, times as ISO 8601 UTC.

Examples

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

curl -X POST "https://vestoris.com/api/v1/commands/55/execute" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H 'X-Vestoris-Confirm: vcf_c41e…; typed="CONFIRM 3"' \
  -H "Content-Type: application/json" \
  -d '{}'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/commands/55/execute",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
        "X-Vestoris-Confirm": "vcf_c41e…; typed=\"CONFIRM 3\"",
    },
    json={},
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

const res = await fetch("https://vestoris.com/api/v1/commands/55/execute", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "X-Vestoris-Confirm": "vcf_c41e…; typed=\"CONFIRM 3\"",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
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.

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.

{
    "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/execute"
}

On the screens

The same thing in the app is explained in:

• Portfolio Center commands
• Trade blotter commands
• Workflow monitor commands
• How the AI is used, and its guardrails