> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Workspace AI Mode

> Set a workspace's AI mode (managed or BYOK).

Accepts `mode` — `"managed"`, `"byok"`, or `null` to clear the per-workspace override and fall back to your account default. Provider and model are account-level; set them with [Update AI Defaults](/api-reference/ai/update-defaults). For BYOK, supply your provider key to the workspace as an environment variable (e.g. `ANTHROPIC_API_KEY`).


## OpenAPI

````yaml PUT /api/v1/workspaces/{id}/mode
openapi: 3.1.0
info:
  title: Rigbox Public API
  description: >-
    Gateway-owned public API for Rigbox. The gateway composes its local
    lifecycle API with service-owned exported specs.
  contact:
    name: Rigbox
    url: https://rigbox.dev
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.rigbox.dev
    description: Production gateway
security: []
tags:
  - name: Workspaces
  - name: CLI
  - name: Observability
  - name: Auth
  - name: API Keys
  - name: Access Control
  - name: Apps
  - name: App Catalog
  - name: Logs
  - name: AI
  - name: Tools
  - name: Snapshots
  - name: SSH Keys
  - name: Templates
  - name: Setup Scripts
  - name: Service Specs
  - name: Deploy
  - name: Community
  - name: User Settings
  - name: Roadmap
  - name: System
paths:
  /api/v1/workspaces/{id}/mode:
    put:
      tags:
        - AI
      summary: Set or clear the per-workspace AI mode override.
      description: >-
        Set or clear the per-workspace AI mode override, hot-reloading when
        running.
      operationId: update_workspace_ai_mode
      parameters:
        - name: id
          in: path
          description: Workspace ID
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceAiModeRequest'
        required: true
      responses:
        '200':
          description: Updated AI mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceAiModeResponse'
      security:
        - bearer: []
components:
  schemas:
    UpdateWorkspaceAiModeRequest:
      type: object
      properties:
        mode:
          type:
            - string
            - 'null'
          description: >-
            `"managed"`, `"byok"`, or `null` to clear the per-workspace
            override.
    WorkspaceAiModeResponse:
      type: object
      required:
        - mode
        - source
      properties:
        mode:
          type: string
          description: Effective AI mode after resolving overrides.
        source:
          $ref: '#/components/schemas/WorkspaceAiModeSource'
    WorkspaceAiModeSource:
      type: string
      description: Source of the effective AI mode for a workspace.
      enum:
        - workspace
        - user_default
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````