platform.getPlatformModel

GET

/v1/platform/models/{modelId}

const url = 'https://example.com/v1/platform/models/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/platform/models/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

modelId

required

string

Responses

200

Success

application/json

object

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

availability

required

Any of:

object

_tag

required

string

Allowed values: All

version

required

integer

<= 9007199254740991

createdAt

required

string

updatedAt

required

string

Example

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

400

ModelProviderAuthorizationInvalid | ModelProviderInvalid

application/json

Any of:

object
object

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

503

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}