platform.updatePlatformModel

PATCH

/v1/platform/models/{modelId}

curl --request PATCH \
  --url https://example.com/v1/platform/models/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectedVersion": 1, "name": "example", "reasoningEfforts": [ "example" ], "serviceTiers": [ "example" ], "contextWindow": 1, "maxOutputTokens": 1, "availability": { "_tag": "All" } }'

Authorizations

• token
• session

Parameters

Path Parameters

modelId

required

string

Request Body^required

Media typeapplication/json

object

expectedVersion

required

integer

<= 9007199254740991

name

string

>= 1 characters <= 200 characters

reasoningEfforts

Array<string>

<= 50 items

serviceTiers

Array<string>

<= 50 items

contextWindow

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

maxOutputTokens

Any of:

integer

integer

> 0 <= 9007199254740991

null

null

availability

Any of:

object

object

_tag

required

string

Allowed values: All

object

object

_tag

required

string

Allowed values: None

object

object

_tag

required

string

Allowed values: Selected

organizations

required

Array<string>

<= 1000 items

Responses

200

Success

Media typeapplication/json

object

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

availability

required

Any of:

object

object

_tag

required

string

Allowed values: All

object

object

_tag

required

string

Allowed values: None

object

object

_tag

required

string

Allowed values: Selected

organizations

required

Array<string>

<= 1000 items

null

null

version

required

integer

<= 9007199254740991

createdAt

required

string

updatedAt

required

string

Example

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

400

ModelProviderAuthorizationInvalid | ModelProviderInvalid

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ModelProviderAuthorizationInvalid

message

required

string

object

object

_tag

required

string

Allowed values: ModelProviderInvalid

message

required

string

Example

{
  "_tag": "ModelProviderAuthorizationInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

ModelProviderNotFound | ModelNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ModelProviderNotFound

providerId

required

string

object

object

_tag

required

string

Allowed values: ModelNotFound

modelId

required

string

Example

{
  "_tag": "ModelProviderNotFound"
}

409

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

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ModelProviderLoginRequired

object

object

_tag

required

string

Allowed values: ModelProviderConflict

version

required

integer

<= 9007199254740991

object

object

_tag

required

string

Allowed values: ModelProviderInUse

providerId

required

string

object

object

_tag

required

string

Allowed values: ModelConflict

version

required

integer

<= 9007199254740991

object

object

_tag

required

string

Allowed values: ModelInUse

modelId

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ModelProviderLoginRequired"
}

503

PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PlatformUnavailable

object

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

object

object

_tag

required

string

Allowed values: ModelProviderOAuthUnavailable

object

object

_tag

required

string

Allowed values: ModelProvidersUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PlatformUnavailable"
}