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

# Change a knowledge base

> Changes a knowledge base's name, description (null clears it) or whether Stella searches it. Writes go into a knowledge base this API made or one that takes uploads in the app (`writable`); a connector's is a 409. A digital worker's own key can't write.



## OpenAPI

````yaml /api/statisfy-api.openapi.json patch /v1/knowledge_bases/{knowledge_base_id}
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/knowledge_bases/{knowledge_base_id}:
    patch:
      tags:
        - knowledge_bases
      summary: Change a knowledge base
      description: >-
        Changes a knowledge base's name, description (null clears it) or whether
        Stella searches it. Writes go into a knowledge base this API made or one
        that takes uploads in the app (`writable`); a connector's is a 409. A
        digital worker's own key can't write.
      operationId: knowledge_bases_update
      parameters:
        - description: The knowledge base's id, from GET /v1/knowledge_bases
          in: path
          name: knowledge_base_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                description:
                  anyOf:
                    - maxLength: 2000
                      type: string
                    - type: 'null'
                  default: null
                  description: null clears it
                  title: Description
                name:
                  anyOf:
                    - maxLength: 200
                      minLength: 1
                      type: string
                    - type: 'null'
                  default: null
                  title: Name
                stella:
                  anyOf:
                    - type: boolean
                    - type: 'null'
                  default: null
                  title: Stella
              type: object
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KnowledgeBase'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    KnowledgeBase:
      properties:
        created_at:
          description: ISO 8601 UTC
          title: Created At
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        documents:
          $ref: '#/components/schemas/DocumentCounts'
          description: Its documents, by indexing status
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        source:
          description: >-
            Where its documents come from: api (pushed through this API), upload
            (files uploaded in the app), team_answers (articles the team
            approved in the app), or the connector that syncs it (intercom,
            zendesk, notion, google_drive, sharepoint, website)
          title: Source
          type: string
        stella:
          description: Whether Stella, the assistant in the app, searches it
          title: Stella
          type: boolean
        updated_at:
          description: 'ISO 8601 UTC: when the knowledge base itself last changed'
          title: Updated At
          type: string
        workers:
          description: >-
            The digital workers set to search it when they answer, whatever
            their status
          items:
            $ref: '#/components/schemas/KnowledgeBaseWorker'
          title: Workers
          type: array
        writable:
          description: >-
            Whether this API may add, change and delete its documents: true for
            api and upload knowledge bases, false for a connector's (its sync
            overwrites an edit and never removes a document)
          title: Writable
          type: boolean
      required:
        - id
        - name
        - source
        - writable
        - stella
        - workers
        - documents
        - created_at
        - updated_at
      title: KnowledgeBase
      type: object
    DocumentCounts:
      properties:
        failed:
          title: Failed
          type: integer
        indexing:
          title: Indexing
          type: integer
        queued:
          title: Queued
          type: integer
        ready:
          title: Ready
          type: integer
        total:
          title: Total
          type: integer
      required:
        - total
        - queued
        - indexing
        - ready
        - failed
      title: DocumentCounts
      type: object
    KnowledgeBaseWorker:
      properties:
        id:
          description: The digital worker, from GET /v1/digital_workers
          title: Id
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        status:
          description: 'active, draft or archived: only an active worker answers'
          title: Status
          type: string
      required:
        - id
        - status
      title: KnowledgeBaseWorker
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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