Skip to navigation
Management APIRouting Policies

Get Routing Policy

Return an organization routing policy. A gateway API key of the organization can also read policies, except in Merge for Workforce organizations.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Path parameters

policy_idstringRequiredformat: "uuid"

The policy’s id.

Response

The routing policy
allowed_modelslist of strings or null
INTELLIGENT only. In the order they were sent.
allowed_providerslist of strings or nullRead-only

INTELLIGENT only. The providers of allowed_models, sorted. Always rebuilt from allowed_models; never stored.

axisenum or null

INTELLIGENT only, else null. What the router optimizes for: COST, PERFORMANCE or CAPABILITY.

Allowed values:
created_atdatetimeRead-only
When the policy was created.
descriptionstring or null
What the policy is for.
idstringRead-only
The policy's id. It stays the same across updates.
is_defaultboolean
Whether this is the organization's default policy.
modelstring or nullRead-only

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

modified_atdatetimeRead-only
When the policy last changed.
namestring
The policy's name.
priority_orderlist of objects or null
PRIORITY only. Sorted by priority.
slugstring or null

The policy’s model alias as a bare name, like “fast-experiment”. Null only when no alias could be made, such as an organization at its alias limit.

strategyenum

PRIORITY tries priority_order in turn; INTELLIGENT picks among allowed_models per request, optimizing for axis.

Allowed values:

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error