Skip to content
OpenBot

platform.getPlatformProviderAvailableModels

GET
/v1/platform/model_providers/{providerId}/available_models
curl --request GET \
  --url https://example.com/v1/platform/model_providers/example/available_models \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
providerId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
name
required
string
reasoningEfforts
required
Array<string>
serviceTiers
required
Array<string>
contextWindow
integer
>= -9007199254740991 <= 9007199254740991

Example generated

{
  "items": [
    {
      "id": "example",
      "name": "example",
      "reasoningEfforts": [
        "example"
      ],
      "serviceTiers": [
        "example"
      ],
      "contextWindow": 1
    }
  ]
}

400

Section titled “400”

ModelProviderAuthorizationInvalid | ModelProviderInvalid

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ModelProviderAuthorizationInvalid
message
required
string

Example 

{
  "_tag": "ModelProviderAuthorizationInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

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

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

404

Section titled “404”

ModelProviderNotFound | ModelNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ModelProviderNotFound
providerId
required
string

Example 

{
  "_tag": "ModelProviderNotFound"
}

409

Section titled “409”

ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ModelProviderLoginRequired

Example 

{
  "_tag": "ModelProviderLoginRequired"
}

503

Section titled “503”

PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PlatformUnavailable

Example 

{
  "_tag": "PlatformUnavailable"
}