Management APIRouting policies

Update a routing policy

Update in place; the policy id is stable across updates.

Authenticates with a management key (manage_routing scope) or any active gateway API key of the organization.

Authentication

AuthorizationBearer

A management key (prefixed mgmt_), created in the dashboard under Settings, API keys, Management keys. Distinct from a regular gateway API key, and never used to call models.

Path parameters

policy_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestringOptional<=255 characters
descriptionstringOptional
slugstringOptional

Renames the policy’s model alias. The alias never changes on a policy rename (it is a contract with your clients), so this field is the only way to change it; a name already in use returns 409. Clients still sending the old alias receive 404s.

is_defaultbooleanOptional
strategyenumOptional
allowed_providerslist of stringsOptional

INTELLIGENT only, optional. If provided, must match the providers of allowed_models (it does not filter independently); returned derived from allowed_models on reads.

allowed_modelslist of stringsOptional
priority_orderlist of objectsOptional
axisenumOptional

INTELLIGENT only. Optimization axis the router optimizes for; defaults to COST.

Response

The updated policy.
idstringOptionalformat: "uuid"
namestringOptional
descriptionstringOptional
slugstring or nullOptional

The policy’s model alias (bare name), e.g. “fast-experiment”. Null only when no alias could be minted, such as an organization at its alias cap.

modelstring or nullOptional

The ready-to-send model string for this policy, e.g. “@alias/fast-experiment”. Send it as the model in any Gateway request to route with this policy.

strategyenumOptional
allowed_providerslist of stringsOptional
allowed_modelslist of stringsOptional
priority_orderlist of objectsOptional
axisenumOptional

Optimization axis the router optimizes for (INTELLIGENT only, else null); one of COST, PERFORMANCE, CAPABILITY.

created_atdatetimeOptional
modified_atdatetimeOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error