Qubrid AI RAG API — Documents

naftiko: 1.0.0-alpha2
info:
  label: Qubrid AI RAG API — Documents
  description: 'Qubrid AI RAG API — Documents. 3 operations. Lead operation: List documents in a knowledge base. Self-contained
    Naftiko capability covering one Qubrid Ai business surface.'
  tags:
  - Qubrid Ai
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    QUBRID_AI_API_KEY: QUBRID_AI_API_KEY
capability:
  consumes:
  - type: http
    namespace: rag-documents
    baseUri: https://platform.qubrid.com/api/v1
    description: Qubrid AI RAG API — Documents business capability. Self-contained, no shared references.
    resources:
    - name: rag-knowledge-bases-knowledge_base_id-documents
      path: /rag/knowledge-bases/{knowledge_base_id}/documents
      operations:
      - name: listdocuments
        method: GET
        description: List documents in a knowledge base
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: uploaddocument
        method: POST
        description: Upload a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rag-knowledge-bases-knowledge_base_id-documents-document_id
      path: /rag/knowledge-bases/{knowledge_base_id}/documents/{document_id}
      operations:
      - name: deletedocument
        method: DELETE
        description: Delete a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.QUBRID_AI_API_KEY}}'
  exposes:
  - type: rest
    namespace: rag-documents-rest
    port: 8080
    description: REST adapter for Qubrid AI RAG API — Documents. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/rag/knowledge-bases/{knowledge-base-id}/documents
      name: rag-knowledge-bases-knowledge-base-id-documents
      description: REST surface for rag-knowledge-bases-knowledge_base_id-documents.
      operations:
      - method: GET
        name: listdocuments
        description: List documents in a knowledge base
        call: rag-documents.listdocuments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: uploaddocument
        description: Upload a document
        call: rag-documents.uploaddocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rag/knowledge-bases/{knowledge-base-id}/documents/{document-id}
      name: rag-knowledge-bases-knowledge-base-id-documents-document-id
      description: REST surface for rag-knowledge-bases-knowledge_base_id-documents-document_id.
      operations:
      - method: DELETE
        name: deletedocument
        description: Delete a document
        call: rag-documents.deletedocument
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rag-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Qubrid AI RAG API — Documents. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-documents-knowledge-base
      description: List documents in a knowledge base
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rag-documents.listdocuments
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-document
      description: Upload a document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rag-documents.uploaddocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-document
      description: Delete a document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rag-documents.deletedocument
      outputParameters:
      - type: object
        mapping: $.