Skip to content

modelProviders.listModelProviders

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

Success

Media typeapplication/json
object
items
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
endpoint
required
Any of:
string
apiKey
required
object
set
required
boolean
hint
required
Any of:
string
oauth
object
connected
required
boolean
loginRequired
required
boolean
email
string
subject
string
models
required
Array<object>
object
model
required
string
>= 1 characters <= 200 characters
modelOwner
required
string
Allowed values: platform organization
upstream
string
>= 1 characters <= 200 characters
reasoningEfforts
Array<string>
<= 50 items
serviceTiers
Array<string>
<= 50 items
contextWindow
integer
> 0 <= 9007199254740991
maxOutputTokens
integer
> 0 <= 9007199254740991
availability
required
Any of:
object
_tag
required
string
Allowed values: All
version
required
integer
<= 9007199254740991
createdAt
required
string
updatedAt
required
string

Example

{
"items": [
{
"owner": "platform",
"kind": "openai",
"models": [
{
"modelOwner": "platform"
}
],
"availability": {
"_tag": "All"
}
}
]
}

ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired

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

Example

{
"_tag": "ModelProviderAuthorizationInvalid"
}

AuthenticationRequired

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

Example

{
"_tag": "AuthenticationRequired"
}

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

ModelProviderNotFound | ModelNotFound

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

Example

{
"_tag": "ModelProviderNotFound"
}

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

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

Example

{
"_tag": "ModelProviderLoginRequired"
}

RateLimited

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

Example

{
"_tag": "RateLimited"
}

ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed

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

Example

{
"_tag": "ModelProviderOAuthUnavailable"
}