Add Model Internal

POST

internal

models

curl --request POST \
  --url https://api.pulze.ai/v1/internal/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "is_public": true,
  "default_active": true,
  "context_window": 123,
  "url": "<string>",
  "description": "<string>",
  "until": "<string>",
  "owner": "<string>",
  "model": "<string>",
  "at": "<string>",
  "provider": "<string>",
  "prompt_token_cost": "<string>",
  "completion_token_cost": "<string>",
  "base_cost": "<string>",
  "deprecated_on": "2023-11-07T05:31:56Z",
  "app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_chat": true,
  "is_gdpr": true,
  "is_open_source": true,
  "supports_functions": true,
  "supports_penalties": true,
  "supports_n": true,
  "supports_stream": true,
  "supports_json": true
}'

{
  "supports_functions": true,
  "supports_json": true,
  "supports_n": true,
  "supports_penalties": true,
  "supports_stream": true,
  "supports_vision": true,
  "completion_token_cost": 123,
  "prompt_token_cost": 123,
  "base_cost": 123,
  "price_unit": "tokens",
  "model": "<string>",
  "provider": "<string>",
  "owner": "<string>",
  "namespace": "<string>",
  "at": "<string>",
  "context_window": 123,
  "until": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "url": "<string>",
  "api_target": "",
  "deprecated_on": "2023-11-07T05:31:56Z",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent": {},
  "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_rag": true,
  "is_ft": true,
  "is_open_source": true,
  "is_gdpr": true,
  "is_chat": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "added_by": "<string>",
  "added_on": "2023-11-07T05:31:56Z",
  "modified_on": "2023-11-07T05:31:56Z",
  "is_public": true,
  "is_test_model": true,
  "is_pulze_owner": true,
  "default_active": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

is_public

boolean | null

default_active

boolean | null

context_window

integer | null

url

string | null

description

string | null

until

string | null

owner

string | null

model

string | null

provider

string | null

prompt_token_cost

string | null

completion_token_cost

string | null

base_cost

string | null

default:0

deprecated_on

app_id

string | null

org_id

string | null

is_chat

boolean | null

is_open_source

boolean | null

supports_functions

boolean | null

default:false

supports_penalties

boolean | null

default:false

supports_n

boolean | null

default:false

supports_stream

boolean | null

default:false

supports_json

boolean | null

default:false

Response

200

application/json

Successful Response

supports_functions

boolean

required

True if the model supports function/tool call

supports_json

boolean

required

True if the model supports json-formatted responses

supports_n

boolean

required

True if the model supports n and best_of -- i.e, multiple responses

supports_penalties

boolean

required

True if the model supports frequency_penalty and presence_penalty

supports_stream

boolean

required

True if the model supports streaming responses

supports_vision

boolean

required

True if the model supports image recognition (vision)

completion_token_cost

number

required

The cost of a completion token, in USD

prompt_token_cost

number

required

The cost of a prompt token, in USD

base_cost

number

required

A (usually 0) cost added on top of a request. Some models charge per request, not only per token

price_unit

enum<string>

required

The unit of billing for this model

Available options:

tokens,

characters

model

string

required

The name of the model. Can belong to many providers

namespace

string

required

The fully qualified (namespaced) model name

context_window

integer

required

The max_tokens for this model

until

string | null

required

The most recent data this model has been trained with

description

string

required

A description of the model

url

string

required

A URL to the model's page or more informatino

is_rag

boolean

required

Whether it's rag-tuned or not

is_ft

boolean

required

Whether it's fine-tuned or not

is_open_source

boolean

required

True if the model is open source

True if the model complies with GDPR

is_chat

boolean

required

True if the model is of type Chat Completions, False if it's a Text Completion model.

string | null

required

The ID of this model

app_id

string | null

required

The app_id that has access to this model (if only one)

org_id

string | null

required

The org_id that has acccess to this model

added_by

string | null

required

The user (auth0_id) who created the model

added_on

string | null

required

When the model was added. Auto-populated in DB

modified_on

string | null

required

When the model was updated. Auto-populated in DB

is_public

boolean

required

True if the model is publicly accessible to all

is_test_model

boolean

required

Test models are only used for testing and do not perform any LLM requests

is_pulze_owner

boolean

required

Model has been created and shared by Pulze

default_active

boolean

required

This determines if the model will be available + pre-selected when users create new apps.

provider

string | null

The provider for the model.

owner

string | null

The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data

string | null

Extra model settings inferred from namespace

api_target

string

default:

Store the name of the model the API requires

deprecated_on

string | null

For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings

parent_id

string | null

The ID of parent, in case it's not a base model

parent

object | null

parent.supports_functions

boolean

required

True if the model supports function/tool call

parent.supports_json

boolean

required

True if the model supports json-formatted responses

parent.supports_n

boolean

required

True if the model supports n and best_of -- i.e, multiple responses

parent.supports_penalties

boolean

required

True if the model supports frequency_penalty and presence_penalty

parent.supports_stream

boolean

required

True if the model supports streaming responses

parent.supports_vision

boolean

required

True if the model supports image recognition (vision)

parent.completion_token_cost

number

required

The cost of a completion token, in USD

parent.prompt_token_cost

number

required

The cost of a prompt token, in USD

parent.base_cost

number

required

A (usually 0) cost added on top of a request. Some models charge per request, not only per token

parent.price_unit

enum<string>

required

The unit of billing for this model

Available options:

tokens,

characters

parent.model

string

required

The name of the model. Can belong to many providers

parent.namespace

string

required

The fully qualified (namespaced) model name

parent.context_window

integer

required

The max_tokens for this model

parent.until

string | null

required

The most recent data this model has been trained with

parent.description

string

required

A description of the model

parent.url

string

required

A URL to the model's page or more informatino

parent.is_rag

boolean

required

Whether it's rag-tuned or not

parent.is_ft

boolean

required

Whether it's fine-tuned or not

parent.is_open_source

boolean

required

True if the model is open source

True if the model complies with GDPR

parent.is_chat

boolean

required

True if the model is of type Chat Completions, False if it's a Text Completion model.

parent.id

string | null

required

The ID of this model

parent.app_id

string | null

required

The app_id that has access to this model (if only one)

parent.org_id

string | null

required

The org_id that has acccess to this model

parent.added_by

string | null

required

The user (auth0_id) who created the model

parent.added_on

string | null

required

When the model was added. Auto-populated in DB

parent.modified_on

string | null

required

When the model was updated. Auto-populated in DB

parent.is_public

boolean

required

True if the model is publicly accessible to all

parent.is_test_model

boolean

required

Test models are only used for testing and do not perform any LLM requests

parent.is_pulze_owner

boolean

required

Model has been created and shared by Pulze

parent.default_active

boolean

required

This determines if the model will be available + pre-selected when users create new apps.

parent.provider

string | null

The provider for the model.

parent.owner

string | null

The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data

parent.at

string | null

Extra model settings inferred from namespace

parent.api_target

string

default:

Store the name of the model the API requires

parent.deprecated_on

string | null

For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings

parent.parent_id

string | null

The ID of parent, in case it's not a base model

parent.parent

object | null

parent.parent.supports_functions

boolean

required

True if the model supports function/tool call

parent.parent.supports_json

boolean

required

True if the model supports json-formatted responses

parent.parent.supports_n

boolean

required

True if the model supports n and best_of -- i.e, multiple responses

parent.parent.supports_penalties

boolean

required

True if the model supports frequency_penalty and presence_penalty

parent.parent.supports_stream

boolean

required

True if the model supports streaming responses

parent.parent.supports_vision

boolean

required

True if the model supports image recognition (vision)

parent.parent.completion_token_cost

number

required

The cost of a completion token, in USD

parent.parent.prompt_token_cost

number

required

The cost of a prompt token, in USD

parent.parent.base_cost

number

required

A (usually 0) cost added on top of a request. Some models charge per request, not only per token

parent.parent.price_unit

enum<string>

required

The unit of billing for this model

Available options:

tokens,

characters

parent.parent.model

string

required

The name of the model. Can belong to many providers

parent.parent.namespace

string

required

The fully qualified (namespaced) model name

parent.parent.context_window

integer

required

The max_tokens for this model

parent.parent.until

string | null

required

The most recent data this model has been trained with

parent.parent.description

string

required

A description of the model

parent.parent.url

string

required

A URL to the model's page or more informatino

parent.parent.is_rag

boolean

required

Whether it's rag-tuned or not

parent.parent.is_ft

boolean

required

Whether it's fine-tuned or not

parent.parent.is_open_source

boolean

required

True if the model is open source

True if the model complies with GDPR

parent.parent.is_chat

boolean

required

True if the model is of type Chat Completions, False if it's a Text Completion model.

parent.parent.id

string | null

required

The ID of this model

parent.parent.app_id

string | null

required

The app_id that has access to this model (if only one)

parent.parent.org_id

string | null

required

The org_id that has acccess to this model

parent.parent.added_by

string | null

required

The user (auth0_id) who created the model

parent.parent.added_on

string | null

required

When the model was added. Auto-populated in DB

parent.parent.modified_on

string | null

required

When the model was updated. Auto-populated in DB

parent.parent.is_public

boolean

required

True if the model is publicly accessible to all

parent.parent.is_test_model

boolean

required

Test models are only used for testing and do not perform any LLM requests

parent.parent.is_pulze_owner

boolean

required

Model has been created and shared by Pulze

parent.parent.default_active

boolean

required

This determines if the model will be available + pre-selected when users create new apps.

parent.parent.provider

string | null

The provider for the model.

parent.parent.owner

string | null

The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data

parent.parent.at

string | null

Extra model settings inferred from namespace

parent.parent.api_target

string

default:

Store the name of the model the API requires

parent.parent.deprecated_on

string | null

For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings

parent.parent.parent_id

string | null

The ID of parent, in case it's not a base model

parent.parent.parent

object | null

parent.parent.parent.supports_functions

boolean

required

True if the model supports function/tool call

parent.parent.parent.supports_json

boolean

required

True if the model supports json-formatted responses

parent.parent.parent.supports_n

boolean

required

True if the model supports n and best_of -- i.e, multiple responses

parent.parent.parent.supports_penalties

boolean

required

True if the model supports frequency_penalty and presence_penalty

parent.parent.parent.supports_stream

boolean

required

True if the model supports streaming responses

parent.parent.parent.supports_vision

boolean

required

True if the model supports image recognition (vision)

parent.parent.parent.completion_token_cost

number

required

The cost of a completion token, in USD

parent.parent.parent.prompt_token_cost

number

required

The cost of a prompt token, in USD

parent.parent.parent.base_cost

number

required

A (usually 0) cost added on top of a request. Some models charge per request, not only per token

parent.parent.parent.price_unit

enum<string>

required

The unit of billing for this model

Available options:

tokens,

characters

parent.parent.parent.model

string

required

The name of the model. Can belong to many providers

parent.parent.parent.namespace

string

required

The fully qualified (namespaced) model name

parent.parent.parent.context_window

integer

required

The max_tokens for this model

parent.parent.parent.until

string | null

required

The most recent data this model has been trained with

parent.parent.parent.description

string

required

A description of the model

parent.parent.parent.url

string

required

A URL to the model's page or more informatino

parent.parent.parent.is_rag

boolean

required

Whether it's rag-tuned or not

parent.parent.parent.is_ft

boolean

required

Whether it's fine-tuned or not

parent.parent.parent.is_open_source

boolean

required

True if the model is open source

True if the model complies with GDPR

parent.parent.parent.is_chat

boolean

required

True if the model is of type Chat Completions, False if it's a Text Completion model.

parent.parent.parent.id

string | null

required

The ID of this model

parent.parent.parent.app_id

string | null

required

The app_id that has access to this model (if only one)

parent.parent.parent.org_id

string | null

required

The org_id that has acccess to this model

parent.parent.parent.added_by

string | null

required

The user (auth0_id) who created the model

parent.parent.parent.added_on

string | null

required

When the model was added. Auto-populated in DB

parent.parent.parent.modified_on

string | null

required

When the model was updated. Auto-populated in DB

parent.parent.parent.is_public

boolean

required

True if the model is publicly accessible to all

parent.parent.parent.is_test_model

boolean

required

Test models are only used for testing and do not perform any LLM requests

parent.parent.parent.is_pulze_owner

boolean

required

Model has been created and shared by Pulze

parent.parent.parent.default_active

boolean

required

This determines if the model will be available + pre-selected when users create new apps.

parent.parent.parent.provider

string | null

The provider for the model.

parent.parent.parent.owner

string | null

The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data

parent.parent.parent.at

string | null

Extra model settings inferred from namespace

parent.parent.parent.api_target

string

default:

Store the name of the model the API requires

parent.parent.parent.deprecated_on

string | null

For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings

parent.parent.parent.parent_id

string | null

The ID of parent, in case it's not a base model

parent.parent.parent.parent

object | null

parent.parent.parent.parent.supports_functions

boolean

required

True if the model supports function/tool call

parent.parent.parent.parent.supports_json

boolean

required

True if the model supports json-formatted responses

parent.parent.parent.parent.supports_n

boolean

required

True if the model supports n and best_of -- i.e, multiple responses

parent.parent.parent.parent.supports_penalties

boolean

required

True if the model supports frequency_penalty and presence_penalty

parent.parent.parent.parent.supports_stream

boolean

required

True if the model supports streaming responses

parent.parent.parent.parent.supports_vision

boolean

required

True if the model supports image recognition (vision)

parent.parent.parent.parent.completion_token_cost

number

required

The cost of a completion token, in USD

parent.parent.parent.parent.prompt_token_cost

number

required

The cost of a prompt token, in USD

parent.parent.parent.parent.base_cost

number

required

A (usually 0) cost added on top of a request. Some models charge per request, not only per token

parent.parent.parent.parent.price_unit

enum<string>

required

The unit of billing for this model

Available options:

tokens,

characters

parent.parent.parent.parent.model

string

required

The name of the model. Can belong to many providers

parent.parent.parent.parent.namespace

string

required

The fully qualified (namespaced) model name

parent.parent.parent.parent.context_window

integer

required

The max_tokens for this model

parent.parent.parent.parent.until

string | null

required

The most recent data this model has been trained with

parent.parent.parent.parent.description

string

required

A description of the model

parent.parent.parent.parent.url

string

required

A URL to the model's page or more informatino

parent.parent.parent.parent.is_rag

boolean

required

Whether it's rag-tuned or not

parent.parent.parent.parent.is_ft

boolean

required

Whether it's fine-tuned or not

parent.parent.parent.parent.is_open_source

boolean

required

True if the model is open source

True if the model complies with GDPR

parent.parent.parent.parent.is_chat

boolean

required

True if the model is of type Chat Completions, False if it's a Text Completion model.

parent.parent.parent.parent.id

string | null

required

The ID of this model

parent.parent.parent.parent.app_id

string | null

required

The app_id that has access to this model (if only one)

parent.parent.parent.parent.org_id

string | null

required

The org_id that has acccess to this model

parent.parent.parent.parent.added_by

string | null

required

The user (auth0_id) who created the model

parent.parent.parent.parent.added_on

string | null

required

When the model was added. Auto-populated in DB

parent.parent.parent.parent.modified_on

string | null

required

When the model was updated. Auto-populated in DB

parent.parent.parent.parent.is_public

boolean

required

True if the model is publicly accessible to all

parent.parent.parent.parent.is_test_model

boolean

required

Test models are only used for testing and do not perform any LLM requests

parent.parent.parent.parent.is_pulze_owner

boolean

required

Model has been created and shared by Pulze

parent.parent.parent.parent.default_active

boolean

required

This determines if the model will be available + pre-selected when users create new apps.

parent.parent.parent.parent.provider

string | null

The provider for the model.

parent.parent.parent.parent.owner

string | null

The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data

parent.parent.parent.parent.at

string | null

Extra model settings inferred from namespace

parent.parent.parent.parent.api_target

string

default:

Store the name of the model the API requires

parent.parent.parent.parent.deprecated_on

string | null

For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings

parent.parent.parent.parent.parent_id

string | null

The ID of parent, in case it's not a base model

parent.parent.parent.parent.parent

object | null

parent.parent.parent.parent.prompt_id

string | null

The ID of prompt, used for this model

parent.parent.parent.prompt_id

string | null

The ID of prompt, used for this model

parent.parent.prompt_id

string | null

The ID of prompt, used for this model

parent.prompt_id

string | null

The ID of prompt, used for this model

prompt_id

string | null

The ID of prompt, used for this model

Was this page helpful?

Raise issue

curl --request POST \
  --url https://api.pulze.ai/v1/internal/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "is_public": true,
  "default_active": true,
  "context_window": 123,
  "url": "<string>",
  "description": "<string>",
  "until": "<string>",
  "owner": "<string>",
  "model": "<string>",
  "at": "<string>",
  "provider": "<string>",
  "prompt_token_cost": "<string>",
  "completion_token_cost": "<string>",
  "base_cost": "<string>",
  "deprecated_on": "2023-11-07T05:31:56Z",
  "app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_chat": true,
  "is_gdpr": true,
  "is_open_source": true,
  "supports_functions": true,
  "supports_penalties": true,
  "supports_n": true,
  "supports_stream": true,
  "supports_json": true
}'

{
  "supports_functions": true,
  "supports_json": true,
  "supports_n": true,
  "supports_penalties": true,
  "supports_stream": true,
  "supports_vision": true,
  "completion_token_cost": 123,
  "prompt_token_cost": 123,
  "base_cost": 123,
  "price_unit": "tokens",
  "model": "<string>",
  "provider": "<string>",
  "owner": "<string>",
  "namespace": "<string>",
  "at": "<string>",
  "context_window": 123,
  "until": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "url": "<string>",
  "api_target": "",
  "deprecated_on": "2023-11-07T05:31:56Z",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent": {},
  "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_rag": true,
  "is_ft": true,
  "is_open_source": true,
  "is_gdpr": true,
  "is_chat": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "added_by": "<string>",
  "added_on": "2023-11-07T05:31:56Z",
  "modified_on": "2023-11-07T05:31:56Z",
  "is_public": true,
  "is_test_model": true,
  "is_pulze_owner": true,
  "default_active": true
}

Getting Started

Spaces Guide

Tools Guide

Developer Guide

API REFERENCE

COMMUNITY

PULZE ACADEMY

Add Model Internal

Authorizations

Body

Response