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

# Update Workspace Model Access

> Replace a workspace's model subset, or clear it to inherit the org's models.

Every catalog ID must be enabled for the organization.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json put /workspaces/{workspace_id}/agent-model-access
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /workspaces/{workspace_id}/agent-model-access:
    put:
      summary: Update Workspace Model Access
      description: >-
        Replace a workspace's model subset, or clear it to inherit the org's
        models.


        Every catalog ID must be enabled for the organization.
      operationId: update_workspace_model_access
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceAgentModelAccessUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceAgentModelAccessRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    WorkspaceAgentModelAccessUpdate:
      properties:
        inherit_all:
          type: boolean
          title: Inherit All
        catalog_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Catalog Ids
      type: object
      required:
        - inherit_all
      title: WorkspaceAgentModelAccessUpdate
      description: >-
        Replace a workspace's model subset, or clear it to inherit every org
        model.
    WorkspaceAgentModelAccessRead:
      properties:
        inherit_all:
          type: boolean
          title: Inherit All
          description: >-
            True when the workspace has no subset and uses every
            organization-enabled model.
        catalog_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Catalog Ids
          description: >-
            Catalog IDs in the workspace's subset. Empty when inherit_all is
            true.
        candidates:
          items:
            $ref: '#/components/schemas/WorkspaceAgentModelCandidate'
          type: array
          title: Candidates
          description: >-
            Models enabled for the organization. Provider URLs are left out:
            they can carry credentials, and a candidate may sit outside the
            workspace's subset.
      type: object
      required:
        - inherit_all
        - catalog_ids
        - candidates
      title: WorkspaceAgentModelAccessRead
      description: A workspace's model subset and the organization models it can pick from.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkspaceAgentModelCandidate:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        custom_provider_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Custom Provider Id
        organization_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Organization Id
        model_provider:
          type: string
          title: Model Provider
        model_name:
          type: string
          title: Model Name
        model_metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Model Metadata
        custom_provider_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Custom Provider Name
      type: object
      required:
        - id
        - custom_provider_id
        - organization_id
        - model_provider
        - model_name
        - model_metadata
      title: WorkspaceAgentModelCandidate
      description: Catalog entry a workspace can pick, labelled with its custom provider.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.