---
title: "Disable a model"
method: POST
path: "/v1/workspaces/{workspaceId}/models/{id}:disable"
tags: ["ModelService", "Models"]
---

# Disable a model

`POST /v1/workspaces/{workspaceId}/models/{id}:disable`

Transitions a model to STATE_DISABLED. Fails while agent variations are still provisioned on the model; use :swapModelOnVariations to move them first.

## Path parameters

- `workspaceId` string, required
- `id` string, required

## Request body

- DisableModelRequest — Disable model request
  - `workspaceId` string — Workspace ID.
  - `id` string — Model ID

## Response `200`

OK

- Model
  - `metadata` ResourceMetadata, required — Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
    - `id` string, required — Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")
    - `accountId` string, required — Account this resource belongs to for multi-tenant isolation (prefixed ULID)
    - `workspaceId` string, required — Workspace this resource belongs to for organizational grouping (prefixed ULID)
    - `name` string, required — Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly
    - `externalId` string — External ID for the resource (e.g., a workflow ID from an external system)
    - `labels` object — Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}
    - `profileId` string, required — ID of the actor (user or service account) that created this resource
    - `createdAt` string, date-time, required — Timestamp when this resource was created
    - `bundleKey` string — Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.
    - `updatedAt` string, date-time — Timestamp when this resource was last updated
  - `spec` ModelSpec, required
    - `provider` string — The model provider (e.g., "anthropic", "openai", "google")
    - `family` string — The model family (e.g., "claude-sonnet-4.6", "gpt-5.4", "gemini-2.5-flash")
    - `maxInputTokens` integer — Maximum number of input tokens the model supports
    - `maxOutputTokens` integer — Maximum number of output tokens the model can generate
    - `inputPricePerMillionTokens` string — Cost per million input tokens in cents (e.g., 300 = $3.00)
    - `outputPricePerMillionTokens` string — Cost per million output tokens in cents (e.g., 1500 = $15.00)
  - `info` ModelInfo — ModelInfo carries server-derived, read-only details about a model.
    - `aiProviderKey` AIProviderKey — AIProviderKey is a credential for an AI provider, scoped to a workspace. Most keys are customer-provided (BYOK); Cadenya also provisions promotional keys (see AIProviderKeyInfo.is_promotional), which cannot be modified or deleted by account administrators. The secret value is never returned in responses.
      - `metadata` ResourceMetadata, required — Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
        - `id` string, required — Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")
        - `accountId` string, required — Account this resource belongs to for multi-tenant isolation (prefixed ULID)
        - `workspaceId` string, required — Workspace this resource belongs to for organizational grouping (prefixed ULID)
        - `name` string, required — Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly
        - `externalId` string — External ID for the resource (e.g., a workflow ID from an external system)
        - `labels` object — Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}
        - `profileId` string, required — ID of the actor (user or service account) that created this resource
        - `createdAt` string, date-time, required — Timestamp when this resource was created
        - `bundleKey` string — Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.
        - `updatedAt` string, date-time — Timestamp when this resource was last updated
      - `spec` AIProviderKeySpec, required
        - `apiKey` string — The provider credential. Accepted on create/update; never populated in responses (the server returns an empty value to avoid leaking it).
        - `provider` 'AI_PROVIDER_UNSPECIFIED' | 'AI_PROVIDER_OPENROUTER', enum — The AI provider this key authenticates against.
        - `openrouter` OpenRouterConfig — OpenRouterConfig holds OpenRouter-specific settings. Empty for now; it exists as the oneof seam so provider-specific options (region, base URL, etc.) can be added later without restructuring the spec.
      - `info` AIProviderKeyInfo — AIProviderKeyInfo carries server-derived, read-only details about a key, for AI provider management UIs.
        - `enabledModelCount` integer — Number of enabled models provisioned on this key.
        - `disabledModelCount` integer — Number of disabled models provisioned on this key.
        - `isPromotional` boolean — Cadenya includes promotional keys (one for onboarding, and potentially more in the future). These are not added or maintained by account administrators.
    - `agentVariationCount` integer — Number of agent variations currently provisioned on this model. Useful for previewing how many variations a swap would affect.
    - `lastUsedAt` string, date-time — Represents the last time this model was used in an agent objective
  - `state` 'STATE_UNSPECIFIED' | 'STATE_ENABLED' | 'STATE_DISABLED', enum, required — Whether the model is usable in this workspace. Output only. Use the :enable and :disable actions to transition.

## Other responses

- `default` — Default error response

## Changes

- **2026-06-12** `ea07a25ab5da` — 1 warning, 3 info
  - removed the optional property `info/allOf[#/components/schemas/ModelInfo]/provider` from the response with the `200` status
  - added the optional property `info/allOf[#/components/schemas/ModelInfo]/lastUsedAt` to the response with the `200` status
  - added `#/components/schemas/AIProviderKey` to the `info/allOf[#/components/schemas/ModelInfo]/aiProviderKey` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/ResourceMetadata` from the `info/allOf[#/components/schemas/ModelInfo]/aiProviderKey` response property `allOf` list for the response status `200`
- **2026-06-09** `13d98d37dd96` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cadenya/apis/cadenya-api/changes/v1/workspaces/:workspaceId/models/:id:disable/post.md)

---

[API](https://skmtc.dev/cadenya/apis/cadenya-api.md) · [All operations](https://skmtc.dev/cadenya/apis/cadenya-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cadenya/cadenya-api/revisions/ea07a25ab5da/schema)