Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

route_id
string
required

Body

application/json
description
string | null

New description. Omit to keep the current description; use an empty string to clear it. Null is not accepted.

Maximum string length: 1000
Example:

"Assistant for code review and debugging."

display_name
string | null

New display label. Omit to keep the current label; null is not accepted.

Required string length: 1 - 255
Example:

"Assistant"

Response

200 - application/json
id
string
required

Stable route identifier.

name
string
required

Name to send in the inference request's model field. Unique within the team; immutable.

display_name
string
required

Display label, defaulting to the route's name.

team_id
string
required

Identifier of the owning team.

team_name
string
required

Name of the owning team.

description
string
required

Short description of the route, empty when unset.

target
GridRouteTargetBasetenModelAPIV1 · object
required

Configured upstream target.

metadata
GridRouteMetadataV1 · object | null
required

Resolved model metadata; for an intelligent route, the envelope of its servable models' metadata. Null when nothing is linked or the metadata has no supported API formats.

invoke_url
string
required

Base URL for inference requests using this route.

created_at
string<date-time>
required

Creation time, ISO 8601.

aliases
GridRouteAliasV1 · object[]

The route's other names, one per purpose. Empty for routes created before aliases existed.