Skip to content
OpenBot

modelProviders.listModels

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

Lists the models of the organization. The models that the platform shares are not in the list.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
owner
required
string
Allowed values: platform organization
type
required
string
Allowed values: language decision
name
required
string
reasoningEfforts
required
Array<string>
serviceTiers
required
Array<string>
contextWindow
integer
> 0 <= 9007199254740991
maxOutputTokens
integer
> 0 <= 9007199254740991
availability
required
Any of:
Any of:
object
_tag
required
string
Allowed values: All
version
required
integer
<= 9007199254740991
createdAt
required
string
updatedAt
required
string

Example 

{
  "items": [
    {
      "owner": "platform",
      "type": "language",
      "availability": {
        "_tag": "All"
      }
    }
  ]
}

400

Section titled “400”

ModelProviderInvalid | OrganizationRequired

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

Example 

{
  "_tag": "ModelProviderInvalid"
}

401

Section titled “401”

AuthenticationRequired

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

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
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 triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write 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 usage.read budgets.read budgets.write
resource
required
string

Example 

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

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”

ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ModelProviderConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "ModelProviderConflict"
}

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”

ModelProvidersUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "ModelProvidersUnavailable"
}