Ctrlk
<- back to nexos.ai
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Models

List available models.

List models

get

List all models available to the user.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

A list of models available to use for the current user.

application/json
objectstringRequiredExample: list
totalintegerRequiredExample: 1
get/v1/models
GET /v1/models HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "list",
  "data": [
    {
      "id": "GPT 5.6 Sol",
      "nexos_model_id": "123e4567-e89b-12d3-a456-426614174000",
      "object": "model",
      "created": "1686935002",
      "updated": "1686935002",
      "owned_by": "openai",
      "timeout_ms": 1,
      "stream_timeout_ms": 1,
      "max_tokens": 1,
      "context_length": 1,
      "pricing": {
        "input_cost_per_token": "text",
        "output_cost_per_token": "text",
        "input_cost_per_second": "text",
        "output_cost_per_second": "text",
        "cache_write_cost_per_token": "text",
        "cache_write_cost_per_token_1h_ttl": "text",
        "cache_read_cost_per_token": "text"
      },
      "endpoints": [
        "chat_completion"
      ],
      "region": "EU"
    }
  ],
  "total": 1
}

List all models

get

List all models including ones not available for the current user.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

A list all models including ones not available for the current user.

application/json
objectstringRequiredExample: list
get/v1/models/all
GET /v1/models/all HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "list",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "object": "global_model",
      "created": "1686935002",
      "updated": "1686935002",
      "owned_by": "openai",
      "name": "My favorite model",
      "timeout_ms": 1,
      "stream_timeout_ms": 1,
      "max_tokens": 1,
      "context_length": 1,
      "pricing": {
        "input_cost_per_token": "text",
        "output_cost_per_token": "text",
        "input_cost_per_second": "text",
        "output_cost_per_second": "text",
        "cache_write_cost_per_token": "text",
        "cache_write_cost_per_token_1h_ttl": "text",
        "cache_read_cost_per_token": "text"
      },
      "endpoints": [
        "chat_completion"
      ],
      "region": "EU",
      "provider": "OpenAI",
      "available": true
    }
  ]
}

Get fallbacks configuration for particular model

get

Fallback configuration for a specific model. Fallbacks are tried in the order the model IDs are provided in the list.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
modelstringRequired

The ID of the model.

Responses
200

Model fallbacks configuration found.

application/json
idstringRequired

Unique identifier for the model

Example: 123e4567-e89b-12d3-a456-426614174000
fallback_idsstring · uuid[]Optional

The ID of the model to associate with the company.

Example: 987f6543-d21c-45e7-b678-123456789abc
created_atstring · date-timeOptional

The time the model fallbacks configuration was created.

Example: 2024-11-19T10:00:00Z
updated_atstring · date-timeOptional

The time the model fallbacks configuration was last updated.

Example: 2024-11-19T12:00:00Z
get/v1/management/models/{model}/fallbacks
GET /v1/management/models/{model}/fallbacks HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fallback_ids": [
    "987f6543-d21c-45e7-b678-123456789abc"
  ],
  "created_at": "2024-11-19T10:00:00Z",
  "updated_at": "2024-11-19T12:00:00Z"
}

Add fallbacks configuration for particular model

post

Add fallback configuration for a specific model. Fallbacks are tried in the order the model IDs are provided in the list.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
modelstringRequired

The ID of the model.

Body
modelsstring · uuid[]Required

The ID of the model to associate with the company.

Example: 987f6543-d21c-45e7-b678-123456789abc
Responses
201

Model fallbacks configuration successfully created.

application/json
idstringRequired

Unique identifier for the model

Example: 123e4567-e89b-12d3-a456-426614174000
fallback_idsstring · uuid[]Optional

The ID of the model to associate with the company.

Example: 987f6543-d21c-45e7-b678-123456789abc
created_atstring · date-timeOptional

The time the model fallbacks configuration was created.

Example: 2024-11-19T10:00:00Z
updated_atstring · date-timeOptional

The time the model fallbacks configuration was last updated.

Example: 2024-11-19T12:00:00Z
post/v1/management/models/{model}/fallbacks
POST /v1/management/models/{model}/fallbacks HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "models": [
    "987f6543-d21c-45e7-b678-123456789abc"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fallback_ids": [
    "987f6543-d21c-45e7-b678-123456789abc"
  ],
  "created_at": "2024-11-19T10:00:00Z",
  "updated_at": "2024-11-19T12:00:00Z"
}

Delete model fallbacks configuration

delete

Delete model fallbacks configuration

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
modelstringRequired

The ID of the model.

Responses
204

Model fallbacks configuration deleted successfully

No content
delete/v1/management/models/{model}/fallbacks
DELETE /v1/management/models/{model}/fallbacks HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update fallbacks configuration for particular model

patch

Update the fallback configuration for a specific model. Fallbacks are tried in the order the model IDs are provided in the list.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
modelstringRequired

The ID of the model.

Body
modelsstring · uuid[]Required

The ID of the model to associate with the company.

Example: 987f6543-d21c-45e7-b678-123456789abc
Responses
200

Model fallbacks configuration successfully updated.

application/json
idstringRequired

Unique identifier for the model

Example: 123e4567-e89b-12d3-a456-426614174000
fallback_idsstring · uuid[]Optional

The ID of the model to associate with the company.

Example: 987f6543-d21c-45e7-b678-123456789abc
created_atstring · date-timeOptional

The time the model fallbacks configuration was created.

Example: 2024-11-19T10:00:00Z
updated_atstring · date-timeOptional

The time the model fallbacks configuration was last updated.

Example: 2024-11-19T12:00:00Z
patch/v1/management/models/{model}/fallbacks
PATCH /v1/management/models/{model}/fallbacks HTTP/1.1
Host: api.nexos.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "models": [
    "987f6543-d21c-45e7-b678-123456789abc"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fallback_ids": [
    "987f6543-d21c-45e7-b678-123456789abc"
  ],
  "created_at": "2024-11-19T10:00:00Z",
  "updated_at": "2024-11-19T12:00:00Z"
}
PreviousStorageNextTeam Management

Last updated