modelProviders.createModel

POST

/v1/organization/models

const url = 'https://example.com/v1/organization/models';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"id":"example","type":"language","name":"example","reasoningEfforts":["example"],"serviceTiers":["example"],"contextWindow":1,"maxOutputTokens":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/organization/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 }'

Adds a model to the organization. Link it to a provider to use it.

Authorizations

token
session

Request Body^required

application/json

object

required

string

>= 1 characters <= 200 characters

type

string

Allowed values: language decision live

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

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 | OrganizationRequired

application/json

Any of:

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

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ModelProviderOAuthUnavailable

Example

{
  "_tag": "ModelProviderOAuthUnavailable"
}

modelProviders.createModel

Authorizations

Request Bodyrequired

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required