---
title: "Toggle Model By App Id"
method: PUT
path: "/v1/apps/{app_id}/models/{model_id}/toggle"
tags: ["apps"]
---

# Toggle Model By App Id

`PUT /v1/apps/{app_id}/models/{model_id}/toggle`

Enable or disable a model for a given app_id.

## Path parameters

- `app_id` string, uuid, required
- `model_id` string, uuid, required

## Query parameters

- `enable` boolean, required

## Response `200`

Successful Response

- PulzeToggleModelResponse
  - `success` boolean, required — The status of the update
  - `model` PulzeDefaultModelData
    - `model` string, required — The name of the model. Can belong to many providers
    - `provider` string, nullable — The provider for the model.
    - `owner` string, nullable — The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data
    - `namespace` string, required — The fully qualified (namespaced) model name
    - `at` string, nullable — Extra model settings inferred from namespace
    - `context_window` integer, required — The max_tokens for this model
    - `until` string, date-time, nullable, 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
    - `api_target` string — Store the name of the model the API requires
    - `deprecated_on` string, date-time, nullable — For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings
    - `parent_id` string, uuid, nullable — The ID of parent, in case it's not a base model
    - `parent` ModelData
      - `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` 'tokens' | 'characters', required — The unit of billing for this model
      - `model` string, required — The name of the model. Can belong to many providers
      - `provider` string, nullable — The provider for the model.
      - `owner` string, nullable — The owner of the model. Sometimes, for a provider/model combination, many instances exist, trained on different data
      - `namespace` string, required — The fully qualified (namespaced) model name
      - `at` string, nullable — Extra model settings inferred from namespace
      - `context_window` integer, required — The max_tokens for this model
      - `until` string, date-time, nullable, 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
      - `api_target` string — Store the name of the model the API requires
      - `deprecated_on` string, date-time, nullable — For models whose deprecation date is known (past or future), to show errors and deny service, or show warnings
      - `parent_id` string, uuid, nullable — The ID of parent, in case it's not a base model
      - `parent` ModelData — recursive
      - `prompt_id` string, uuid, nullable — The ID of prompt, used for this model
      - `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
      - `is_gdpr` boolean, required — 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.
      - `id` string, uuid, nullable, required — The ID of this model
      - `app_id` string, uuid, nullable, required — The app_id that has access to this model (if only one)
      - `org_id` string, uuid, nullable, required — The org_id that has acccess to this model
      - `added_by` string, nullable, required — The user (auth0_id) who created the model
      - `added_on` string, date-time, nullable, required — When the model was added. Auto-populated in DB
      - `modified_on` string, date-time, nullable, 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.
    - `prompt_id` string, uuid, nullable — The ID of prompt, used for this model
  - `active` boolean, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/pulze/apis/pulze-ai-api.md) · [All operations](https://skmtc.net/pulze/apis/pulze-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pulze/pulze-ai-api/versions/a5e0b539abc5/schema)