Skip to content
OpenBot

platform.setPlatformModelPrice

PUT
/v1/platform/model_providers/{providerId}/prices
curl --request PUT \
  --url https://example.com/v1/platform/model_providers/example/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "model": "example", "timeZone": "example", "tiers": [ { "upToInputTokens": 1, "inputUncached": 1, "inputCacheRead": 1, "inputCacheWrite": 1, "output": 1, "outputReasoning": 1 } ], "periods": [ { "name": "example", "windows": [ { "start": "example", "end": "example", "days": [ "mon" ] } ], "tiers": [ { "upToInputTokens": 1, "inputUncached": 1, "inputCacheRead": 1, "inputCacheWrite": 1, "output": 1, "outputReasoning": 1 } ] } ] }'

Sets a new price for one model of the provider. The price applies to calls from now on. Old calls keep their cost.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
providerId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
model
required
string
>= 1 characters <= 200 characters
timeZone
string
<= 64 characters
tiers
required
Array<object>
>= 1 items <= 20 items
object
upToInputTokens
required
Any of:
integer
> 0 <= 9007199254740991
inputUncached
required
integer
<= 9007199254740991
inputCacheRead
required
integer
<= 9007199254740991
inputCacheWrite
required
integer
<= 9007199254740991
output
required
integer
<= 9007199254740991
outputReasoning
required
Any of:
integer
<= 9007199254740991
periods
Array<object>
<= 20 items
object
name
required
string
>= 1 characters <= 60 characters
windows
required
Array<object>
>= 1 items <= 20 items
object
start
required
string
end
required
string
days
Array<string>
>= 1 items <= 7 items
Allowed values: mon tue wed thu fri sat sun
tiers
required
Array<object>
>= 1 items <= 20 items
object
upToInputTokens
required
Any of:
integer
> 0 <= 9007199254740991
inputUncached
required
integer
<= 9007199254740991
inputCacheRead
required
integer
<= 9007199254740991
inputCacheWrite
required
integer
<= 9007199254740991
output
required
integer
<= 9007199254740991
outputReasoning
required
Any of:
integer
<= 9007199254740991

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
model
required
string
timeZone
required
string
<= 64 characters
tiers
required
Array<object>
>= 1 items <= 20 items
object
upToInputTokens
required
Any of:
integer
> 0 <= 9007199254740991
inputUncached
required
integer
<= 9007199254740991
inputCacheRead
required
integer
<= 9007199254740991
inputCacheWrite
required
integer
<= 9007199254740991
output
required
integer
<= 9007199254740991
outputReasoning
required
Any of:
integer
<= 9007199254740991
periods
required
Array<object>
<= 20 items
object
name
required
string
>= 1 characters <= 60 characters
windows
required
Array<object>
>= 1 items <= 20 items
object
start
required
string
end
required
string
days
Array<string>
>= 1 items <= 7 items
Allowed values: mon tue wed thu fri sat sun
tiers
required
Array<object>
>= 1 items <= 20 items
object
upToInputTokens
required
Any of:
integer
> 0 <= 9007199254740991
inputUncached
required
integer
<= 9007199254740991
inputCacheRead
required
integer
<= 9007199254740991
inputCacheWrite
required
integer
<= 9007199254740991
output
required
integer
<= 9007199254740991
outputReasoning
required
Any of:
integer
<= 9007199254740991
effectiveFrom
required
string

Example 

{
  "periods": [
    {
      "windows": [
        {
          "days": [
            "mon"
          ]
        }
      ]
    }
  ]
}

400

Section titled “400”

ModelProviderInvalid

Media typeapplication/json
object
_tag
required
string
Allowed values: ModelProviderInvalid
message
required
string

Example 

{
  "_tag": "ModelProviderInvalid"
}

401

Section titled “401”

AuthenticationRequired

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

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

ModelProviderNotFound | ModelNotFound

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

Example 

{
  "_tag": "ModelProviderNotFound"
}

409

Section titled “409”

ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ModelProviderConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "ModelProviderConflict"
}

503

Section titled “503”

PlatformUnavailable | OrganizationStorageUnavailable | ModelProvidersUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "PlatformUnavailable"
}