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

# Update workspace name/slug/settings (owner or admin only)



## OpenAPI

````yaml /openapi.json patch /api/workspaces/{id}
openapi: 3.1.0
info:
  title: Syvon API
  version: 1.0.0
  description: >-
    Two client-facing surfaces: the Portal management plane (syvon.ai/api/*,
    portal JWT) and the Brain read plane (brain.syvon.ai/v1/*, workspace key
    sk_ws_…). Schemas are generated from the @syvon/sdk TypeScript types — the
    shipped .d.ts files are the authoritative contract.
servers:
  - url: https://syvon.ai
    description: Portal (management plane)
  - url: https://brain.syvon.ai
    description: Brain (read plane)
security: []
tags:
  - name: Auth
    description: Minting the portal JWT
  - name: Portal
    description: Management plane — user-scoped (portal JWT)
  - name: Brain
    description: Published-agent read plane — workspace-scoped (sk_ws_…)
paths:
  /api/workspaces/{id}:
    patch:
      tags:
        - Portal
      summary: Update workspace name/slug/settings (owner or admin only)
      operationId: updateWorkspace
      parameters:
        - name: id
          in: path
          required: true
          description: Workspace id
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceInput'
      responses:
        '200':
          description: The updated workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    $ref: '#/components/schemas/Workspace'
                required:
                  - workspace
      security:
        - bearerAuth: []
      servers:
        - url: https://syvon.ai
components:
  schemas:
    UpdateWorkspaceInput:
      type: object
      description: ''
      properties:
        name:
          description: ''
          type: string
        slug:
          description: ''
          type: string
        listed:
          description: ''
          type: boolean
        storeConversations:
          description: ''
          type: boolean
        defaultWorkflowId:
          description: ''
          anyOf:
            - type: string
            - type: 'null'
        wrapConfig:
          description: Partial merge — only a whitelisted set of keys is accepted.
          type: object
          additionalProperties: {}
    Workspace:
      type: object
      description: ''
      properties:
        id:
          description: ''
          type: string
        name:
          description: ''
          type: string
        slug:
          description: ''
          type: string
        type:
          $ref: '#/components/schemas/WorkspaceType'
          description: ''
        origin:
          $ref: '#/components/schemas/WorkspaceOrigin'
          description: ''
        ownerId:
          description: ''
          type: string
        storageConfig:
          description: R2 prefix (`workspaces/<id>/`).
          anyOf:
            - type: object
              properties:
                type:
                  description: ''
                  type: string
                bucket:
                  description: ''
                  type: string
                prefix:
                  description: ''
                  type: string
              required:
                - type
                - bucket
                - prefix
            - type: 'null'
        wrapConfig:
          description: ''
          anyOf:
            - type: object
              additionalProperties: {}
            - type: 'null'
        defaultWorkflowId:
          description: ''
          anyOf:
            - type: string
            - type: 'null'
        defaultBrandId:
          description: ''
          anyOf:
            - type: string
            - type: 'null'
        listed:
          description: ''
          type: boolean
        storeConversations:
          description: ''
          type: boolean
        createdAt:
          description: ''
          type: string
        updatedAt:
          description: ''
          type: string
      required:
        - id
        - name
        - slug
        - type
        - origin
        - ownerId
        - createdAt
    WorkspaceType:
      type: string
    WorkspaceOrigin:
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Portal API JWT (user-scoped, ~1h)

````