BEbetagouv
Admin

Create Router

Changed on
post/v1/admin/routers

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namestring required

Name of the model router.

type'automatic-speech-recognition' | 'image-to-text' | 'text-classification' | 'text-embeddings-inference' | 'text-generation' required
aliasesstring[]

Aliases of the model. It will be used to identify the model by users.

load_balancing_strategy'shuffle' | 'least_busy'
cost_prompt_tokensnumber

Cost of a million prompt tokens (decrease user budget)

cost_completion_tokensnumber

Cost of a million completion tokens (decrease user budget)

Example request

{
  "name": "model-router-1",
  "aliases": [
    "model-alias",
    "model-alias-2"
  ]
}

Response

Successful Response

object'router'

Type of the object.

idinteger required

ID of the router.

namestring required

Name of the router.

user_idinteger required

ID of the user that owns the router.

type'automatic-speech-recognition' | 'image-to-text' | 'text-classification' | 'text-embeddings-inference' | 'text-generation' required
aliasesstring[] required

Aliases of the model. It will be used to identify the model by users.

load_balancing_strategy'shuffle' | 'least_busy' required
cost_prompt_tokensnumber required

Cost of a million prompt tokens (decrease user budget)

cost_completion_tokensnumber required

Cost of a million completion tokens (decrease user budget)

providersinteger

Number of providers in the router.

createdinteger required

Time of creation, as Unix timestamp.

updatedinteger required

Time of last update, as Unix timestamp.

Example response

{
  "aliases": [
    "model-alias",
    "model-alias-2"
  ]
}

Changes