Comp AI Knowledge Base API

openapi: 3.2.0
info:
  title: Comp AI Knowledge Base API
  description: Compliance automation API for SOC 2, ISO 27001, HIPAA, GDPR, evidence collection, policy workflows, Trust Access, security questionnaires, integrations, cloud checks, and device compliance.
  version: '1.0'
  contact: {}
servers:
- url: https://api.trycomp.ai
  description: Production API Server
tags:
- name: Knowledge Base
  description: Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
paths:
  /v1/knowledge-base/documents:
    get:
      operationId: KnowledgeBaseController_listDocuments_v1
      parameters: []
      responses:
        '200':
          description: List of knowledge base documents
      security:
      - apikey: []
      summary: List knowledge base documents
      tags:
      - Knowledge Base
      description: List uploaded knowledge base documents that Comp AI can use as approved source material for answers, policies, and reviews.
      x-mint:
        metadata:
          title: List knowledge base documents | Comp AI API
          sidebarTitle: List knowledge base documents
          description: List uploaded knowledge base documents that Comp AI can use as approved source material for answers, policies, and reviews.
          og:title: List knowledge base documents | Comp AI API
          og:description: List uploaded knowledge base documents that Comp AI can use as approved source material for answers, policies, and reviews.
      x-speakeasy-mcp:
        name: list-documents
  /v1/knowledge-base/manual-answers:
    get:
      operationId: KnowledgeBaseController_listManualAnswers_v1
      parameters: []
      responses:
        '200':
          description: List of manual answers
      security:
      - apikey: []
      summary: List all manual answers for an organization
      tags:
      - Knowledge Base
      description: List all manual answers for an organization in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: List all manual answers for an organization | Comp AI API
          sidebarTitle: List all manual answers for an organization
          description: List all manual answers for an organization in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
          og:title: List all manual answers for an organization | Comp AI API
          og:description: List all manual answers for an organization in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
      x-speakeasy-mcp:
        name: list-manual-answers
    post:
      operationId: KnowledgeBaseController_saveManualAnswer_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveManualAnswerDto'
      responses:
        '200':
          description: Manual answer saved
      security:
      - apikey: []
      summary: Save reusable manual answer
      tags:
      - Knowledge Base
      description: Save or update a reusable manual answer for security questionnaires that need approved, consistent response language.
      x-mint:
        metadata:
          title: Save reusable manual answer | Comp AI API
          sidebarTitle: Save reusable manual answer
          description: Save or update a reusable manual answer for security questionnaires that need approved, consistent response language.
          og:title: Save reusable manual answer | Comp AI API
          og:description: Save or update a reusable manual answer for security questionnaires that need approved, consistent response language.
      x-speakeasy-mcp:
        name: save-manual-answer
  /v1/knowledge-base/documents/upload:
    post:
      operationId: KnowledgeBaseController_uploadDocument_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadDocumentDto'
      responses:
        '200':
          description: Document uploaded successfully
      security:
      - apikey: []
      summary: Upload knowledge base document
      tags:
      - Knowledge Base
      description: Upload supporting documentation so Comp AI can process approved source material for questionnaire answers and policy workflows.
      x-mint:
        metadata:
          title: Upload knowledge base document | Comp AI API
          sidebarTitle: Upload knowledge base document
          description: Upload supporting documentation so Comp AI can process approved source material for questionnaire answers and policy workflows.
          og:title: Upload knowledge base document | Comp AI API
          og:description: Upload supporting documentation so Comp AI can process approved source material for questionnaire answers and policy workflows.
      x-speakeasy-mcp:
        name: upload-document
  /v1/knowledge-base/documents/{documentId}/download:
    post:
      operationId: KnowledgeBaseController_getDownloadUrl_v1
      parameters:
      - name: documentId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Signed download URL generated
      security:
      - apikey: []
      summary: Get a signed download URL for a document
      tags:
      - Knowledge Base
      description: Get a signed download URL for a document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: Get a signed download URL for a document | Comp AI API
          sidebarTitle: Get a signed download URL for a document
          description: Get a signed download URL for a document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
          og:title: Get a signed download URL for a document | Comp AI API
          og:description: Get a signed download URL for a document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
      x-speakeasy-mcp:
        name: get-download-url
  /v1/knowledge-base/documents/{documentId}/view:
    post:
      operationId: KnowledgeBaseController_getViewUrl_v1
      parameters:
      - name: documentId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Signed view URL generated
      security:
      - apikey: []
      summary: Get a signed view URL for a document
      tags:
      - Knowledge Base
      description: Get a signed view URL for a document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: Get a signed view URL for a document | Comp AI API
          sidebarTitle: Get a signed view URL for a document
          description: Get a signed view URL for a document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
          og:title: Get a signed view URL for a document | Comp AI API
          og:description: Get a signed view URL for a document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
      x-speakeasy-mcp:
        name: get-view-url
  /v1/knowledge-base/documents/{documentId}/delete:
    post:
      operationId: KnowledgeBaseController_deleteDocument_v1
      parameters:
      - name: documentId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Document deleted successfully
      security:
      - apikey: []
      summary: Delete a knowledge base document
      tags:
      - Knowledge Base
      description: Delete a knowledge base document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: Delete a knowledge base document | Comp AI API
          sidebarTitle: Delete a knowledge base document
          description: Delete a knowledge base document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
          og:title: Delete a knowledge base document | Comp AI API
          og:description: Delete a knowledge base document in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
      x-speakeasy-mcp:
        name: delete-document
  /v1/knowledge-base/documents/process:
    post:
      operationId: KnowledgeBaseController_processDocuments_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessDocumentsDto'
      responses:
        '200':
          description: Document processing triggered
      security:
      - apikey: []
      summary: Process knowledge base documents
      tags:
      - Knowledge Base
      description: Start document processing so uploaded knowledge base files become searchable source material for AI-assisted compliance workflows.
      x-mint:
        metadata:
          title: Process knowledge base documents | Comp AI API
          sidebarTitle: Process knowledge base documents
          description: Start document processing so uploaded knowledge base files become searchable source material for AI-assisted compliance workflows.
          og:title: Process knowledge base documents | Comp AI API
          og:description: Start document processing so uploaded knowledge base files become searchable source material for AI-assisted compliance workflows.
      x-speakeasy-mcp:
        name: process-documents
  /v1/knowledge-base/runs/{runId}/token:
    post:
      operationId: KnowledgeBaseController_createRunToken_v1
      parameters:
      - name: runId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Public access token created
      security:
      - apikey: []
      summary: Create a public access token for a run
      tags:
      - Knowledge Base
      description: Create a public access token for a run in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: Create a public access token for a run | Comp AI API
          sidebarTitle: Create a public access token for a run
          description: Create a public access token for a run in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
          og:title: Create a public access token for a run | Comp AI API
          og:description: Create a public access token for a run in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
      x-speakeasy-mcp:
        name: create-run-token
  /v1/knowledge-base/manual-answers/{manualAnswerId}/delete:
    post:
      operationId: KnowledgeBaseController_deleteManualAnswer_v1
      parameters:
      - name: manualAnswerId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteManualAnswerDto'
      responses:
        '200':
          description: Manual answer deleted
      security:
      - apikey: []
      summary: Delete a manual answer
      tags:
      - Knowledge Base
      description: Delete a manual answer in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: Delete a manual answer | Comp AI API
          sidebarTitle: Delete a manual answer
          description: Delete a manual answer in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI.
          og:title: Delete a manual answer | Comp AI API
          og:description: Delete a manual answer in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI.
      x-speakeasy-mcp:
        name: delete-manual-answer
  /v1/knowledge-base/manual-answers/delete-all:
    post:
      operationId: KnowledgeBaseController_deleteAllManualAnswers_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAllManualAnswersDto'
      responses:
        '200':
          description: All manual answers deleted
      security:
      - apikey: []
      summary: Delete all manual answers for an organization
      tags:
      - Knowledge Base
      description: Delete all manual answers for an organization in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power questionnaires and AI policy workflows.
      x-mint:
        metadata:
          title: Delete all manual answers for an organization | Comp AI API
          sidebarTitle: Delete all manual answers for an organization
          description: Delete all manual answers for an organization in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
          og:title: Delete all manual answers for an organization | Comp AI API
          og:description: Delete all manual answers for an organization in Comp AI. Upload source documents, process them for retrieval, and manage reusable manual answers that power.
      x-speakeasy-mcp:
        name: delete-all-manual-answers
components:
  schemas:
    UploadDocumentDto:
      type: object
      properties:
        organizationId:
          type: string
          description: Organization ID that owns the document
        fileName:
          type: string
          description: File name
          example: rbac-matrix.xlsx
        fileType:
          type: string
          description: MIME type of the file
          example: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        fileData:
          type: string
          description: Base64-encoded file contents. For the web UI / direct callers. AI/MCP clients should instead upload via /v1/uploads/presign (purpose=document) and pass `s3Key` — base64 through an LLM is impractically slow and times out. Provide exactly one of fileData or s3Key.
        s3Key:
          type: string
          description: Key of a file already uploaded via /v1/uploads/presign (purpose=document). The server fetches the bytes from storage — no base64 needed. Provide exactly one of fileData or s3Key.
        description:
          type: string
          description: Optional description
      required:
      - organizationId
      - fileName
      - fileType
    DeleteAllManualAnswersDto:
      type: object
      properties: {}
    ProcessDocumentsDto:
      type: object
      properties: {}
    SaveManualAnswerDto:
      type: object
      properties: {}
    DeleteManualAnswerDto:
      type: object
      properties: {}
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000