chats.chatModels

GET

/v1/chats/{chatId}/models

curl --request GET \
  --url https://example.com/v1/chats/example/models \
  --header 'Authorization: Bearer <token>'

Authorizations

• token
• session

Parameters

Path Parameters

chatId

required

string

>= 1 characters

Responses

200

Success

Media typeapplication/json

object

selected

object

_tag

required

string

Allowed values: Config.Selection

provider

required

string

model

required

string

reasoningEffort

Any of:

string

string

null

null

serviceTier

Any of:

string

string

null

null

providers

required

Array<object>

object

id

required

string

name

required

string

endpoint

Any of:

string

string

null

null

models

required

Array<object>

object

_tag

required

string

Allowed values: Config.Model

provider

required

string

id

required

string

name

required

string

description

Any of:

string

string

null

null

visibility

Any of:

string

string

Allowed values: list hide none

null

null

priority

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

defaultReasoningLevel

Any of:

string

string

>= 1 characters

null

null

reasoningLevels

Any of:

Array<object>

Array<object>

object

effort

required

string

>= 1 characters

description

required

string

null

null

defaultServiceTier

Any of:

string

string

>= 1 characters

null

null

serviceTierOptions

Any of:

Array<object>

Array<object>

object

id

required

string

>= 1 characters

name

required

string

description

required

string

null

null

maxContextWindow

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

effectiveContextWindowPercent

Any of:

integer

integer

>= 1 <= 100

null

null

effectiveContextWindow

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

instructionsTemplate

Any of:

string

string

null

null

supportVerbosity

Any of:

boolean

boolean

null

null

defaultVerbosity

Any of:

string

string

Allowed values: low medium high

null

null

supportsReasoningSummaryParameter

Any of:

boolean

boolean

null

null

defaultReasoningSummary

Any of:

string

string

Allowed values: auto concise detailed none

null

null

reasoningEfforts

required

Array<string>

serviceTiers

required

Array<string>

maxInputTokens

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

maxOutputTokensLimit

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

maxOutputTokens

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

temperature

Any of:

number

number

null

null

topP

Any of:

number

number

null

null

tokenCounting

Any of:

string

string

Allowed values: native estimate

null

null

contextWindow

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

compaction

Any of:

object

object

_tag

required

string

Allowed values: Native

object

object

_tag

required

string

Allowed values: NonNative

model

Any of:

object

object

_tag

required

string

Allowed values: Config.Selection

provider

required

string

model

required

string

reasoningEffort

Any of:

string

string

null

null

serviceTier

Any of:

string

string

null

null

null

null

keepRecentMessages

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

null

null

autoCompactTokenLimit

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

Example

{
  "selected": {
    "_tag": "Config.Selection"
  },
  "models": [
    {
      "_tag": "Config.Model",
      "visibility": "list",
      "defaultVerbosity": "low",
      "defaultReasoningSummary": "auto",
      "tokenCounting": "native",
      "compaction": {
        "_tag": "Native"
      }
    }
  ]
}

400

ChatModelInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChatModelInvalid

reason

required

string

Allowed values: provider-not-found model-not-found unsupported-option missing

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ChatModelInvalid",
  "reason": "provider-not-found"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

ChatNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: ChatNotFound

chat

required

string

Example

{
  "_tag": "ChatNotFound"
}

409

ChatConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChatConflict

message

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ChatConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChatStorageUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ChatStorageUnavailable"
}