Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json
target
UpsertRouteTargetBasetenModelAPIV1 · object
required

Upstream target for the route. CONNECTION targets use the provider and credentials of a connection owned by the route's team.

Example:
team_id
string | null

Identifier of the team that owns the route.

Minimum string length: 1
Example:

"abc1234"

display_name
string | null

Display label. Omit to use the route name; null is not accepted.

Required string length: 1 - 255
Example:

"Assistant"

description
string | null

Short description of the route. Omit for no description; null is not accepted.

Maximum string length: 1000
Example:

"Assistant for code review and debugging."

Response

200 - application/json
id
string
required

Stable route identifier.

name
string
required

Name to send in the inference request's model field.

team_id
string
required

Identifier of the owning team.

team_name
string
required

Name of the owning team.

display_name
string
required

Display label, defaulting to the route name.

description
string
required

Short description of the route, empty when unset.

target
RouteTargetBasetenModelAPIV1 · object
required

Configured upstream target.

metadata
ExploreMetadataV1 · object | null
required

Resolved model metadata; for a router, the envelope of its allowed routes' metadata. Null when nothing is linked.

invoke_url
string
required

Base URL for inference requests using this route.

created_at
string<date-time>
required

Creation time, ISO 8601.