sessions.sessionModels

GET

/v1/sessions/{sessionId}/models

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

Authorizations

• token
• session

Parameters

Path Parameters

sessionId

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

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

SessionInvalidRecord | SessionModelInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: SessionInvalidRecord

message

required

string

object

object

_tag

required

string

Allowed values: SessionModelInvalid

reason

required

string

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

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "SessionInvalidRecord"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

SessionNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: SessionNotFound

session

required

string

Example

{
  "_tag": "SessionNotFound"
}

409

SessionBusy | SessionConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: SessionBusy

session

required

string

object

object

_tag

required

string

Allowed values: SessionConflict

message

required

string

Example

{
  "_tag": "SessionBusy"
}

503

SessionStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: SessionStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "SessionStorageUnavailable"
}