Skip to content

modelProviders.updateModel

PATCH
/v1/organization/models/{modelId}
curl --request PATCH \
--url https://example.com/v1/organization/models/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "expectedVersion": 1, "name": "example", "reasoningEfforts": [ "example" ], "serviceTiers": [ "example" ], "contextWindow": 1, "maxOutputTokens": 1 }'
modelId
required
string
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
> 0 <= 9007199254740991
maxOutputTokens
Any of:
integer
> 0 <= 9007199254740991

Example generated

{
"expectedVersion": 1,
"name": "example",
"reasoningEfforts": [
"example"
],
"serviceTiers": [
"example"
],
"contextWindow": 1,
"maxOutputTokens": 1
}

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
_tag
required
string
Allowed values: All
version
required
integer
<= 9007199254740991
createdAt
required
string
updatedAt
required
string

Example

{
"owner": "platform",
"type": "language",
"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"
}