Developers › API reference › Portfolio Center

POST /api/v1/models

Create a model.

• Scope reference:write
• Idempotency-Key
• operationId portfolioCreateModel

The token needs the scope reference:write, 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/models

Headers

Body: ModelIn

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/models" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H "Content-Type: application/json" \
  -d '{"name":"Dividend Growth","description":"Dividend payers","cash_target_pct":"2","drift_tolerance_pct":"1.5","targets":[{"symbol":"JNJ","target_pct":"10"},{"symbol":"KO","target_pct":"10"},{"symbol":"PEP","target_pct":"10"},{"symbol":"PG","target_pct":"10"}]}'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/models",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    json={
        "name": "Dividend Growth",
        "description": "Dividend payers",
        "cash_target_pct": "2",
        "drift_tolerance_pct": "1.5",
        "targets": [
            {
                "symbol": "JNJ",
                "target_pct": "10"
            },
            {
                "symbol": "KO",
                "target_pct": "10"
            },
            {
                "symbol": "PEP",
                "target_pct": "10"
            },
            {
                "symbol": "PG",
                "target_pct": "10"
            }
        ]
    },
    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/models", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "name": "Dividend Growth",
      "description": "Dividend payers",
      "cash_target_pct": "2",
      "drift_tolerance_pct": "1.5",
      "targets": [
          {
              "symbol": "JNJ",
              "target_pct": "10"
          },
          {
              "symbol": "KO",
              "target_pct": "10"
          },
          {
              "symbol": "PEP",
              "target_pct": "10"
          },
          {
              "symbol": "PG",
              "target_pct": "10"
          }
      ]
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

201 Created, application/json: Model. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": "1042",
    "name": "Core Growth",
    "description": "Large-cap growth equities",
    "cash_target_pct": "2.00",
    "drift_tolerance_pct": "1.50",
    "targets": [
        {
            "symbol": "AAPL",
            "target_pct": "6.00"
        }
    ],
    "accounts": 1,
    "updated_at": "2026-10-27T14:30:00Z"
}

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/models"
}

On the screens

The same thing in the app is explained in:

• Model portfolios