Skip to content
OpenBot

platform.createPlatformModel

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

Adds a model of the platform. availability says which organizations can use it. A provider must link it before anyone can call it.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
string
>= 1 characters <= 200 characters
type
string
Allowed values: language decision
name
required
string
>= 1 characters <= 200 characters
reasoningEfforts
required
Array<string>
<= 50 items
serviceTiers
required
Array<string>
<= 50 items
contextWindow
integer
> 0 <= 9007199254740991
maxOutputTokens
integer
> 0 <= 9007199254740991
availability
required
Any of:
object
_tag
required
string
Allowed values: All

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
id
required
string
owner
required
string
Allowed values: platform organization
type
required
string
Allowed values: language decision
name
required
string
reasoningEfforts
required
Array<string>
serviceTiers
required
Array<string>
contextWindow
integer
> 0 <= 9007199254740991
maxOutputTokens
integer
> 0 <= 9007199254740991
availability
required
Any of:
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

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