Getting Started
Spaces Guide
Tools Guide
Developer Guide
API REFERENCE
- Spaces
- Data
- Chat
- Assistants
- Documents
PULZE ACADEMY
Toggle Model By App Id
Enable or disable a model for a given app_id.
curl --request PUT \
--url https://api.pulze.ai/v1/apps/{app_id}/models/{model_id}/toggle \
--header 'Authorization: Bearer <token>'{
"success": true,
"model": {
"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": {
"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
},
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"active": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Response
The status of the update
The name of the model. Can belong to many providers
The fully qualified (namespaced) model name
The max_tokens for this model
The most recent data this model has been trained with
A description of the model
A URL to the model's page or more informatino
The provider for the model.
The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data
Extra model settings inferred from namespace
Store the name of the model the API requires
For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings
The ID of parent, in case it's not a base model
True if the model supports function/tool call
True if the model supports json-formatted responses
True if the model supports n and best_of -- i.e, multiple responses
True if the model supports frequency_penalty and presence_penalty
True if the model supports streaming responses
True if the model supports image recognition (vision)
The cost of a completion token, in USD
The cost of a prompt token, in USD
A (usually 0) cost added on top of a request. Some models charge per request, not only per token
The unit of billing for this model
tokens, characters The name of the model. Can belong to many providers
The fully qualified (namespaced) model name
The max_tokens for this model
The most recent data this model has been trained with
A description of the model
A URL to the model's page or more informatino
Whether it's rag-tuned or not
Whether it's fine-tuned or not
True if the model is open source
True if the model complies with GDPR
True if the model is of type Chat Completions, False if it's a Text Completion model.
The ID of this model
The app_id that has access to this model (if only one)
The org_id that has acccess to this model
The user (auth0_id) who created the model
When the model was added. Auto-populated in DB
When the model was updated. Auto-populated in DB
True if the model is publicly accessible to all
Test models are only used for testing and do not perform any LLM requests
Model has been created and shared by Pulze
This determines if the model will be available + pre-selected when users create new apps.
The provider for the model.
The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data
Extra model settings inferred from namespace
Store the name of the model the API requires
For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings
The ID of parent, in case it's not a base model
True if the model supports function/tool call
True if the model supports json-formatted responses
True if the model supports n and best_of -- i.e, multiple responses
True if the model supports frequency_penalty and presence_penalty
True if the model supports streaming responses
True if the model supports image recognition (vision)
The cost of a completion token, in USD
The cost of a prompt token, in USD
A (usually 0) cost added on top of a request. Some models charge per request, not only per token
The unit of billing for this model
tokens, characters The name of the model. Can belong to many providers
The fully qualified (namespaced) model name
The max_tokens for this model
The most recent data this model has been trained with
A description of the model
A URL to the model's page or more informatino
Whether it's rag-tuned or not
Whether it's fine-tuned or not
True if the model is open source
True if the model complies with GDPR
True if the model is of type Chat Completions, False if it's a Text Completion model.
The ID of this model
The app_id that has access to this model (if only one)
The org_id that has acccess to this model
The user (auth0_id) who created the model
When the model was added. Auto-populated in DB
When the model was updated. Auto-populated in DB
True if the model is publicly accessible to all
Test models are only used for testing and do not perform any LLM requests
Model has been created and shared by Pulze
This determines if the model will be available + pre-selected when users create new apps.
The provider for the model.
The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data
Extra model settings inferred from namespace
Store the name of the model the API requires
For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings
The ID of parent, in case it's not a base model
True if the model supports function/tool call
True if the model supports json-formatted responses
True if the model supports n and best_of -- i.e, multiple responses
True if the model supports frequency_penalty and presence_penalty
True if the model supports streaming responses
True if the model supports image recognition (vision)
The cost of a completion token, in USD
The cost of a prompt token, in USD
A (usually 0) cost added on top of a request. Some models charge per request, not only per token
The unit of billing for this model
tokens, characters The name of the model. Can belong to many providers
The fully qualified (namespaced) model name
The max_tokens for this model
The most recent data this model has been trained with
A description of the model
A URL to the model's page or more informatino
Whether it's rag-tuned or not
Whether it's fine-tuned or not
True if the model is open source
True if the model complies with GDPR
True if the model is of type Chat Completions, False if it's a Text Completion model.
The ID of this model
The app_id that has access to this model (if only one)
The org_id that has acccess to this model
The user (auth0_id) who created the model
When the model was added. Auto-populated in DB
When the model was updated. Auto-populated in DB
True if the model is publicly accessible to all
Test models are only used for testing and do not perform any LLM requests
Model has been created and shared by Pulze
This determines if the model will be available + pre-selected when users create new apps.
The provider for the model.
The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data
Extra model settings inferred from namespace
Store the name of the model the API requires
For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings
The ID of parent, in case it's not a base model
The ID of prompt, used for this model
The ID of prompt, used for this model
The ID of prompt, used for this model
The ID of prompt, used for this model
Was this page helpful?
curl --request PUT \
--url https://api.pulze.ai/v1/apps/{app_id}/models/{model_id}/toggle \
--header 'Authorization: Bearer <token>'{
"success": true,
"model": {
"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": {
"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
},
"prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"active": true
}