modelProviders.getModelProvider

GET

/v1/organization/model_providers/{providerId}

const url = 'https://example.com/v1/organization/model_providers/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

token
session

Parameters

Path Parameters

providerId

required

string

Responses

200

Success

application/json

object

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
null

string

apiKey

required

object

set

required

boolean

hint

required

Any of:

string
null

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

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

400

ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired

application/json

Any of:

object

_tag

required

string

Allowed values: ModelProviderAuthorizationInvalid

message

required

string

Example

{
  "_tag": "ModelProviderAuthorizationInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

ModelProviderNotFound | ModelNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ModelProviderNotFound

providerId

required

string

Example

{
  "_tag": "ModelProviderNotFound"
}

409

application/json

Any of:

object

_tag

required

string

Allowed values: ModelProviderLoginRequired

Example

{
  "_tag": "ModelProviderLoginRequired"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ModelProviderOAuthUnavailable

Example

{
  "_tag": "ModelProviderOAuthUnavailable"
}