openapi: 3.1.0
info:
  title: Fini AI Agents Knowledge Folders API
  version: v2
  description: Public REST API for Fini AI, the self-improving AI agent for enterprise customer support. Manage agents, conversations, knowledge (sources, articles, folders), rules, tags, and prompts, and drive the agent loop via Generate Answer. Structure captured by API Evangelist from the published Fini API reference; not an official Fini-published OpenAPI.
  contact:
    name: Fini AI
    url: https://docs.usefini.com/en/api-reference/authentication
  x-apis-json-generated: true
servers:
- url: https://api-prod.usefini.com/v2
  description: Production
security:
- bearerAuth: []
tags:
- name: Knowledge Folders
paths:
  /hc-folders/public:
    post:
      operationId: createKnowledgeFolder
      summary: Create a folder in the knowledge tree.
      tags:
      - Knowledge Folders
      description: Create a folder in the knowledge tree. Requires the `write` scope.
      externalDocs:
        url: https://docs.usefini.com/en/api-reference/create-knowledge-folder
      responses:
        '200':
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
        description: See the Fini API reference for the request body schema.
    get:
      operationId: getKnowledgeFolders
      summary: Return the current knowledge-tree snapshot, optionally scoped to one agent.
      tags:
      - Knowledge Folders
      description: Return the current knowledge-tree snapshot, optionally scoped to one agent. Requires the `read` scope.
      externalDocs:
        url: https://docs.usefini.com/en/api-reference/get-knowledge-folders
      responses:
        '200':
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
  /hc-folders/{id}/public:
    delete:
      operationId: deleteKnowledgeFolder
      summary: Delete a folder from the knowledge tree.
      tags:
      - Knowledge Folders
      description: Delete a folder from the knowledge tree. Requires the `write` scope.
      externalDocs:
        url: https://docs.usefini.com/en/api-reference/delete-knowledge-folder
      responses:
        '200':
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
        '404':
          $ref: '#/components/responses/NotFound'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The id path parameter.
    put:
      operationId: updateKnowledgeFolder
      summary: Update a folder's title, description, or active state.
      tags:
      - Knowledge Folders
      description: Update a folder's title, description, or active state. Requires the `write` scope.
      externalDocs:
        url: https://docs.usefini.com/en/api-reference/update-knowledge-folder
      responses:
        '200':
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
        '404':
          $ref: '#/components/responses/NotFound'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The id path parameter.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
        description: See the Fini API reference for the request body schema.
  /hc-folders/{id}/move/public:
    put:
      operationId: moveKnowledgeFolder
      summary: Move a folder under a different parent in the knowledge tree.
      tags:
      - Knowledge Folders
      description: Move a folder under a different parent in the knowledge tree. Requires the `write` scope.
      externalDocs:
        url: https://docs.usefini.com/en/api-reference/move-knowledge-folder
      responses:
        '200':
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
        '404':
          $ref: '#/components/responses/NotFound'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The id path parameter.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
        description: See the Fini API reference for the request body schema.
  /hc-bot-folder-junctions/public:
    post:
      operationId: assignKnowledgeToAgents
      summary: Assign or unassign folders to agents in bulk.
      tags:
      - Knowledge Folders
      description: Assign or unassign folders to agents in bulk. Requires the `write` scope.
      externalDocs:
        url: https://docs.usefini.com/en/api-reference/assign-knowledge-to-agents
      responses:
        '200':
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
        description: See the Fini API reference for the request body schema.
components:
  responses:
    Forbidden:
      description: API key lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 403
            message: API key does not have the required scope for this operation
            error: Forbidden
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 401
            message: Unauthorized
            error: Unauthorized
    ServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 500
            message: Internal Server Error
            error: Internal Server Error
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 404
            message: Not Found
            error: Not Found
  schemas:
    Error:
      type: object
      description: Standard Fini error envelope.
      properties:
        statusCode:
          type: integer
          example: 403
        message:
          type: string
          example: API key does not have the required scope for this operation
        error:
          type: string
          example: Forbidden
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: fini_ API key
      description: 'Bearer token containing your Fini workspace API key. Format: `Bearer fini_...`. The key carries `read` and/or `write` scope; write routes require the `write` scope.'