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

# Rename, move, or protect a file

> Send exactly one of `name` to rename in place, `parentId` to move, or `protected` to change whether changes to this file go to review. The id never changes, so ids held by a client stay valid; the path does. Sending two, or none, is rejected rather than resolved by a precedence rule: these are separate writes with no transaction across them, so a request doing two could apply the first and fail the second with no way to report which.



## OpenAPI

````yaml api-reference/public-api.json PATCH /v1/files/{id}
openapi: 3.0.0
info:
  title: Qontext API
  description: Read and write the knowledge a workspace has ingested.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.qontext.ai
    description: Production
security: []
tags:
  - name: Files
    description: >-
      Read and write the files in a workspace. What you read, and what an
      accepted change goes into, is the live files: the accepted state of the
      world. A change to a protected file goes to review instead of being
      accepted automatically, and stays in review until somebody accepts or
      rejects it.
  - name: Folders
    description: >-
      The tree the files sit in. A folder id survives a rename and a move, and
      so does every id below it, so ids a client holds stay valid while paths
      change.
  - name: Search
    description: >-
      Find files by meaning or by a regular expression. Both search the live
      files, both answer one page of the best matches, and both drop a file this
      key may not read.
paths:
  /v1/files/{id}:
    patch:
      tags:
        - Files
      summary: Rename, move, or protect a file
      description: >-
        Send exactly one of `name` to rename in place, `parentId` to move, or
        `protected` to change whether changes to this file go to review. The id
        never changes, so ids held by a client stay valid; the path does.
        Sending two, or none, is rejected rather than resolved by a precedence
        rule: these are separate writes with no transaction across them, so a
        request doing two could apply the first and fail the second with no way
        to report which.
      operationId: FilesController_updateFile
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            The file id, as an earlier response reported it. Always `doc_…`; a
            composite id is refused.
          schema:
            example: doc_9f2k1x8b3m7q0v
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/RenameFileRequest'
                - $ref: '#/components/schemas/MoveFileRequest'
                - $ref: '#/components/schemas/ProtectFileRequest'
      responses:
        '200':
          description: The file after the change. Its id is the one you sent to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        '400':
          description: >-
            `invalid_request`: unknown or malformed member, see `errors`; or not
            exactly one of `name`, `parentId` and `protected`. `invalid_id`: not
            a file id of the form `doc_…`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                invalid_request:
                  summary: Invalid request
                  value:
                    type: https://docs.qontext.ai/errors/invalid-request
                    title: Invalid request
                    status: 400
                    code: invalid_request
                    detail: The request could not be accepted as sent.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
                    errors:
                      - code: out_of_range
                        pointer: /limit
                        detail: limit must not be greater than 1000
                invalid_id:
                  summary: Invalid id
                  value:
                    type: https://docs.qontext.ai/errors/invalid-id
                    title: Invalid id
                    status: 400
                    code: invalid_id
                    detail: >-
                      This id is not in a form this API issues. Use one from an
                      earlier response.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
        '401':
          description: '`unauthenticated`: missing or invalid API key'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                unauthenticated:
                  summary: Unauthenticated
                  value:
                    type: https://docs.qontext.ai/errors/unauthenticated
                    title: Unauthenticated
                    status: 401
                    code: unauthenticated
                    detail: The API key is missing or not valid.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
        '403':
          description: >-
            `forbidden`: this key may not change this file, or may not
            administer it
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                forbidden:
                  summary: Not permitted
                  value:
                    type: https://docs.qontext.ai/errors/forbidden
                    title: Not permitted
                    status: 403
                    code: forbidden
                    detail: This key is not allowed to do that.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
        '404':
          description: >-
            `file_not_found`: no such file readable with this key.
            `folder_not_found`: no such destination folder readable with this
            key
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                file_not_found:
                  summary: File not found
                  value:
                    type: https://docs.qontext.ai/errors/file-not-found
                    title: File not found
                    status: 404
                    code: file_not_found
                    detail: No file with that id, or none this key is allowed to read.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
                folder_not_found:
                  summary: Folder not found
                  value:
                    type: https://docs.qontext.ai/errors/folder-not-found
                    title: Folder not found
                    status: 404
                    code: folder_not_found
                    detail: >-
                      No folder at that path, or none this key is allowed to
                      read.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
        '409':
          description: >-
            `path_already_exists`: the destination already holds a file with
            this name
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                path_already_exists:
                  summary: Path already exists
                  value:
                    type: https://docs.qontext.ai/errors/path-already-exists
                    title: Path already exists
                    status: 409
                    code: path_already_exists
                    detail: Something already exists at that path.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
        '500':
          description: '`internal_error`: unexpected failure, already reported'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                internal_error:
                  summary: Internal error
                  value:
                    type: https://docs.qontext.ai/errors/internal-error
                    title: Internal error
                    status: 500
                    code: internal_error
                    detail: An unexpected error occurred.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
        '503':
          description: >-
            `service_unavailable`: temporarily unreachable. Honour
            `Retry-After`.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                service_unavailable:
                  summary: Temporarily unavailable
                  value:
                    type: https://docs.qontext.ai/errors/service-unavailable
                    title: Temporarily unavailable
                    status: 503
                    code: service_unavailable
                    detail: This workspace is temporarily unavailable.
                    requestId: 3f9c2b7e4d1a48c0b6e5f2a19d7c3e8b
      security:
        - Authorization: []
        - X-API-Key: []
components:
  schemas:
    RenameFileRequest:
      type: object
      properties:
        name:
          type: string
          example: returns.md
          description: >-
            New file name, including its extension. Renames the file in place.
            Send instead of `parentId`, never with it.
      title: Rename
      description: Rename the file in place. The id and the folder do not change.
      additionalProperties: false
      required:
        - name
    MoveFileRequest:
      type: object
      properties:
        parentId:
          type: string
          example: dir_9f2k1x8b3m7q0v
          nullable: true
          description: >-
            Folder to move this file into, keeping its id and its name. `null`
            moves it to the root. The file object answers the same `parentId`,
            so a read gives you what a move needs. Send instead of `name`, never
            with it.
      title: Move
      description: Move the file into another folder. The id and the name do not change.
      additionalProperties: false
      required:
        - parentId
    ProtectFileRequest:
      type: object
      properties:
        protected:
          type: boolean
          example: true
          description: >-
            Whether a change touching this file goes to review instead of being
            accepted automatically. Send instead of `name` or `parentId`, never
            with either.
      title: Protect
      description: Route changes to this file through review, or stop doing so.
      additionalProperties: false
      required:
        - protected
    File:
      type: object
      properties:
        object:
          type: string
          enum:
            - file
          description: Type discriminator. Always `file`.
        id:
          type: string
          example: doc_9f2k1x8b3m7q0v
          description: Stable id. Survives a rename or a move.
        path:
          type: string
          example: /support/policies/refunds.md
          description: Live file location. Changes when the file moves.
        name:
          type: string
          example: refunds.md
          description: Leaf name, including its extension, without any part of the path.
        parentId:
          type: string
          example: dir_4k1n8p2v5m7q0x
          nullable: true
          description: >-
            The containing folder, or `null` when the file sits at the root.
            Send it back to move a file.
        parentPath:
          type: string
          example: /support/policies
          description: Path of the containing folder. `/` at the root.
        protected:
          type: boolean
          description: >-
            When true, a change to this file goes to review instead of being
            accepted automatically.
        lastChangeId:
          type: string
          example: chg_7t4p2w9c1n6s8k
          description: >-
            The last content change to this file. A rename or a move does not
            advance it. Pass it back as `baseChangeId` on a write.
        createdAt:
          type: string
          format: date-time
          example: '2026-07-01T09:12:00.000Z'
          description: When the file was created.
        updatedAt:
          type: string
          format: date-time
          example: '2026-08-01T14:03:00.000Z'
          description: When the file last changed, including a rename or a move.
      required:
        - object
        - id
        - path
        - name
        - parentId
        - parentPath
        - protected
        - lastChangeId
        - createdAt
        - updatedAt
    Problem:
      type: object
      properties:
        type:
          type: string
          example: https://docs.qontext.ai/errors/file-not-found
          description: >-
            Stable URI for this kind of failure. Branch on this or on `code`,
            never on `title` or `detail`.
        title:
          type: string
          example: File not found
          description: Human label. Not for branching on.
        status:
          type: number
          example: 404
          description: Matches the HTTP status.
        code:
          type: string
          example: file_not_found
          description: Stable machine code. This is what a client branches on.
        detail:
          type: string
          description: >-
            Human explanation, safe to display. Never a stack trace or engine
            detail.
        requestId:
          type: string
          description: >-
            Echoes the `X-Request-Id` response header. One string locates the
            log line for this call.
        errors:
          description: Present when the failure is attributable to specific inputs.
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
      required:
        - type
        - title
        - status
        - code
        - detail
        - requestId
    FieldError:
      type: object
      properties:
        code:
          type: string
          example: out_of_range
          description: Stable machine token for what was wrong with this field.
        pointer:
          type: string
          example: /limit
          description: JSON Pointer to the offending member.
        detail:
          type: string
          example: limit must not be greater than 1000
          description: >-
            Human explanation for this field alone. Branch on `code`, not on
            this.
      required:
        - code
        - pointer
        - detail
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: >-
        Workspace-scoped API key, sent as a bearer token. The recommended
        header. The workspace is implicit in the key and never appears in a URL.
    X-API-Key:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        The same workspace-scoped API key under its original header. Still
        supported, and still enough on its own. Prefer `Authorization: Bearer`
        for a new client.

````