Skip to content
OpenBot

modelProviders.getModelCatalog

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

Lists the models that the caller may use now, for each provider that offers them.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
providers
required
Array<object>
object
id
required
string
owner
required
string
Allowed values: platform organization
kind
required
string
Allowed values: openai chatgpt anthropic openai-compat typesafe
name
required
string
models
required
Array<object>
object
provider
required
string
id
required
string
owner
required
string
Allowed values: platform organization
type
required
string
Allowed values: language decision live
name
required
string
reasoningEfforts
required
Array<string>
serviceTiers
required
Array<string>
contextWindow
integer
> 0 <= 9007199254740991
maxOutputTokens
integer
> 0 <= 9007199254740991
price
object
model
required
string
timeZone
required
string
<= 64 characters
tiers
required
Array<object>
>= 1 items <= 20 items
object
upToInputTokens
required
Any of:
integer
> 0 <= 9007199254740991
inputUncached
required
integer
<= 9007199254740991
inputCacheRead
required
integer
<= 9007199254740991
inputCacheWrite
required
integer
<= 9007199254740991
output
required
integer
<= 9007199254740991
outputReasoning
required
Any of:
integer
<= 9007199254740991
periods
required
Array<object>
<= 20 items
object
name
required
string
>= 1 characters <= 60 characters
windows
required
Array<object>
>= 1 items <= 20 items
object
start
required
string
end
required
string
days
Array<string>
>= 1 items <= 7 items
Allowed values: mon tue wed thu fri sat sun
tiers
required
Array<object>
>= 1 items <= 20 items
object
upToInputTokens
required
Any of:
integer
> 0 <= 9007199254740991
inputUncached
required
integer
<= 9007199254740991
inputCacheRead
required
integer
<= 9007199254740991
inputCacheWrite
required
integer
<= 9007199254740991
output
required
integer
<= 9007199254740991
outputReasoning
required
Any of:
integer
<= 9007199254740991
effectiveFrom
required
string

Example 

{
  "providers": [
    {
      "owner": "platform",
      "kind": "openai"
    }
  ],
  "models": [
    {
      "owner": "platform",
      "type": "language",
      "price": {
        "periods": [
          {
            "windows": [
              {
                "days": [
                  "mon"
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

400

Section titled “400”

ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired

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"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed

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

Example 

{
  "_tag": "ModelProviderOAuthUnavailable"
}