API

Create or revise a model candidate pool

Generated from the checked-in source. Do not edit this reference by hand.

PUT /api/v1/pools

Platform administration required: installation credentials or an explicitly authorized platform administrator. Ordinary company/workspace ownership does not grant this access. Revisions start at zero for creation. Ownership is immutable. Candidate aliases identify existing credential/model mappings, not nested pools. Personal pools require all candidates owned by that organization; shared pools require nonpersonal priced mappings. Video mappings are rejected. Ordered routing rules evaluate first-match AND conditions before falling back to default_action. Highest eligible priority wins, with weighted selection within that tier. Billing mode selects either unified pool pricing (pool_tariff) or pass-through candidate pricing (candidate_tariff). Chat pools permit at most one successor after a qualified OpenRouter authentication rejection; other failures and uncertain or streamed outcomes do not trigger automatic failover. See the Chat completion contract for exact eligibility and deadline constraints.

Operation: setModelRoutePool.

Authentication

Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.

[
  {
    "bearerAuth": []
  }
]

HTTP request

Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.

curl --fail-with-body -X PUT "$NIU_ORIGIN/api/v1/pools" \
  -H "Authorization: Bearer $NIU_BEARER_TOKEN" \
  -H 'Content-Type: application/json' \
  --data @request.json

Parameters

No path, query, or header parameters are declared.

Request body

application/json

Required.

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "alias",
    "organization_id",
    "enabled",
    "expected_revision",
    "candidates"
  ],
  "properties": {
    "alias": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[!-~]+$"
    },
    "organization_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "project_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "display_name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 200
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 4000
    },
    "slug": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "public_catalog": {
      "type": "boolean"
    },
    "billing_mode": {
      "type": "string",
      "enum": [
        "pool_tariff",
        "candidate_tariff"
      ]
    },
    "enabled": {
      "type": "boolean"
    },
    "expected_revision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740990
    },
    "candidates": {
      "type": "array",
      "minItems": 1,
      "maxItems": 64,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "alias",
          "priority",
          "weight",
          "enabled"
        ],
        "properties": {
          "alias": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "priority": {
            "type": "integer",
            "minimum": -1000,
            "maximum": 1000
          },
          "weight": {
            "type": "integer",
            "minimum": 1,
            "maximum": 10000
          },
          "enabled": {
            "type": "boolean"
          }
        }
      }
    },
    "rules": {
      "type": "array",
      "maxItems": 32,
      "items": {
        "type": "object"
      }
    },
    "default_action": {
      "type": "string",
      "enum": [
        "candidates",
        "reject"
      ]
    }
  }
}

Responses

HTTP 200

Saved revision; changes apply to later admission and stale snapshots reject before dispatch

Content type: application/json.

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "revision"
      ],
      "properties": {
        "revision": {
          "type": "integer",
          "minimum": 1,
          "maximum": 9007199254740991
        }
      }
    }
  }
}

HTTP 400

Invalid candidates, bounds, ownership, reserved alias or unsupported mapping

HTTP 401

Authentication required

HTTP 403

Platform administration required

HTTP 409

Stale revision or attempted ownership change

HTTP 422

Malformed body schema or unknown fields; framework rejection may use plain text.

Behavior and supported scope

Supported scope: implemented