v1

latestOpenAPI 3.1.02026-08-06213193627.0 KB
internal
internal_models

Add Model Internal

post/v1/internal/models

Request body

is_publicboolean nullable
default_activeboolean nullable
context_windowinteger nullable
urlstring nullable
descriptionstring nullable
untilstring nullable
ownerstring nullable
modelstring nullable
atstring nullable
providerstring nullable
prompt_token_coststring nullable
completion_token_coststring nullable
base_coststring nullable
app_idstring uuid nullable
org_idstring uuid nullable
is_chatboolean nullable
is_gdprboolean nullable
is_open_sourceboolean nullable
supports_functionsboolean nullable
supports_penaltiesboolean nullable
supports_nboolean nullable
supports_streamboolean nullable
supports_jsonboolean nullable

Response

Successful Response

supports_functionsboolean required

True if the model supports function/tool call

supports_jsonboolean required

True if the model supports json-formatted responses

supports_nboolean required

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

supports_penaltiesboolean required

True if the model supports frequency_penalty and presence_penalty

supports_streamboolean required

True if the model supports streaming responses

supports_visionboolean required

True if the model supports image recognition (vision)

completion_token_costnumber required

The cost of a completion token, in USD

prompt_token_costnumber required

The cost of a prompt token, in USD

base_costnumber required

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

price_unit'tokens' | 'characters' required

The unit of billing for this model

modelstring required

The name of the model. Can belong to many providers

providerstring nullable

The provider for the model.

ownerstring nullable

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

namespacestring required

The fully qualified (namespaced) model name

atstring nullable

Extra model settings inferred from namespace

context_windowinteger required

The max_tokens for this model

untilstring date-time nullable required

The most recent data this model has been trained with

descriptionstring required

A description of the model

urlstring required

A URL to the model's page or more informatino

api_targetstring

Store the name of the model the API requires

deprecated_onstring date-time nullable

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

parent_idstring uuid nullable

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

prompt_idstring uuid nullable

The ID of prompt, used for this model

is_ragboolean required

Whether it's rag-tuned or not

is_ftboolean required

Whether it's fine-tuned or not

is_open_sourceboolean required

True if the model is open source

is_gdprboolean required

True if the model complies with GDPR

is_chatboolean required

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

idstring uuid nullable required

The ID of this model

app_idstring uuid nullable required

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

org_idstring uuid nullable required

The org_id that has acccess to this model

added_bystring nullable required

The user (auth0_id) who created the model

added_onstring date-time nullable required

When the model was added. Auto-populated in DB

modified_onstring date-time nullable required

When the model was updated. Auto-populated in DB

is_publicboolean required

True if the model is publicly accessible to all

is_test_modelboolean required

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

is_pulze_ownerboolean required

Model has been created and shared by Pulze

default_activeboolean required

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