Comp AI Frameworks API

openapi: 3.2.0
info:
  title: Comp AI Frameworks 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: Frameworks
  description: Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
paths:
  /v1/frameworks:
    get:
      operationId: FrameworksController_findAll_v1
      parameters:
      - name: includeControls
        required: false
        in: query
        schema:
          type: boolean
      - name: includeScores
        required: false
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List compliance frameworks
      tags:
      - Frameworks
      description: List active SOC 2, ISO 27001, HIPAA, GDPR, and custom compliance frameworks with implementation status and progress data.
      x-mint:
        metadata:
          title: List compliance frameworks | Comp AI API
          sidebarTitle: List compliance frameworks
          description: List active SOC 2, ISO 27001, HIPAA, GDPR, and custom compliance frameworks with implementation status and progress data.
          og:title: List compliance frameworks | Comp AI API
          og:description: List active SOC 2, ISO 27001, HIPAA, GDPR, and custom compliance frameworks with implementation status and progress data.
      x-speakeasy-mcp:
        name: frameworks-find-all
    post:
      operationId: FrameworksController_addFrameworks_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddFrameworksDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Add compliance frameworks
      tags:
      - Frameworks
      description: Add one or more compliance frameworks to an organization so tasks, controls, evidence, and readiness tracking can be generated.
      x-mint:
        metadata:
          title: Add compliance frameworks | Comp AI API
          sidebarTitle: Add compliance frameworks
          description: Add one or more compliance frameworks to an organization so tasks, controls, evidence, and readiness tracking can be generated.
          og:title: Add compliance frameworks | Comp AI API
          og:description: Add one or more compliance frameworks to an organization so tasks, controls, evidence, and readiness tracking can be generated.
      x-speakeasy-mcp:
        name: add-frameworks
  /v1/frameworks/available:
    get:
      operationId: FrameworksController_findAvailable_v1
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: List available frameworks
      tags:
      - Frameworks
      description: List frameworks available for activation before starting a new compliance program or expanding into another standard.
      x-mint:
        metadata:
          title: List available frameworks | Comp AI API
          sidebarTitle: List available frameworks
          description: List frameworks available for activation before starting a new compliance program or expanding into another standard.
          og:title: List available frameworks | Comp AI API
          og:description: List frameworks available for activation before starting a new compliance program or expanding into another standard.
      x-speakeasy-mcp:
        name: find-available
  /v1/frameworks/scores:
    get:
      operationId: FrameworksController_getScores_v1
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get framework readiness scores
      tags:
      - Frameworks
      description: Retrieve framework readiness scores so teams can report progress toward audit readiness across active compliance standards.
      x-mint:
        metadata:
          title: Get framework readiness scores | Comp AI API
          sidebarTitle: Get framework readiness scores
          description: Retrieve framework readiness scores so teams can report progress toward audit readiness across active compliance standards.
          og:title: Get framework readiness scores | Comp AI API
          og:description: Retrieve framework readiness scores so teams can report progress toward audit readiness across active compliance standards.
      x-speakeasy-mcp:
        name: get-scores
  /v1/frameworks/update-statuses:
    get:
      operationId: FrameworksController_getAllUpdateStatuses_v1
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get update statuses for all framework instances
      tags:
      - Frameworks
      description: Get update statuses for all framework instances in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Get update statuses for all framework | Comp AI API
          sidebarTitle: Get update statuses for all framework instances
          description: Get update statuses for all framework instances in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Get update statuses for all framework | Comp AI API
          og:description: Get update statuses for all framework instances in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: get-all-update-statuses
  /v1/frameworks/{id}:
    get:
      operationId: FrameworksController_findOne_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get a single framework instance with full detail
      tags:
      - Frameworks
      description: Get a single framework instance with full detail in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Get a single framework instance with full | Comp AI API
          sidebarTitle: Get a single framework instance with full detail
          description: Get a single framework instance with full detail in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Get a single framework instance with full | Comp AI API
          og:description: Get a single framework instance with full detail in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: frameworks-find-one
    delete:
      operationId: FrameworksController_delete_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Delete a framework instance
      tags:
      - Frameworks
      description: Delete a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Delete a framework instance | Comp AI API
          sidebarTitle: Delete a framework instance
          description: Delete a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
          og:title: Delete a framework instance | Comp AI API
          og:description: Delete a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-speakeasy-mcp:
        name: delete
  /v1/frameworks/{id}/requirements/{requirementKey}:
    get:
      operationId: FrameworksController_findRequirement_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: requirementKey
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get a specific requirement with related controls
      tags:
      - Frameworks
      description: Get a specific requirement with related controls in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Get a specific requirement with related | Comp AI API
          sidebarTitle: Get a specific requirement with related controls
          description: Get a specific requirement with related controls in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Get a specific requirement with related | Comp AI API
          og:description: Get a specific requirement with related controls in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: find-requirement
  /v1/frameworks/custom:
    post:
      operationId: FrameworksController_createCustom_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomFrameworkDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Create a custom framework for this organization
      tags:
      - Frameworks
      description: Create a custom framework for this organization in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Create a custom framework for this | Comp AI API
          sidebarTitle: Create a custom framework for this organization
          description: Create a custom framework for this organization in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Create a custom framework for this | Comp AI API
          og:description: Create a custom framework for this organization in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: create-custom
  /v1/frameworks/{id}/custom:
    patch:
      description: Update the name and/or description of an organization's custom framework. Only custom frameworks are editable; platform frameworks return 400.
      operationId: FrameworksController_updateCustom_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomFrameworkDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Update a custom framework
      tags:
      - Frameworks
      x-mint:
        metadata:
          title: Update a custom framework | Comp AI API
          sidebarTitle: Update a custom framework
          description: Update the name and/or description of an organization's custom framework. Only custom frameworks are editable; platform frameworks return 400.
          og:title: Update a custom framework | Comp AI API
          og:description: Update the name and/or description of an organization's custom framework. Only custom frameworks are editable; platform frameworks return 400.
      x-speakeasy-mcp:
        name: update-custom
  /v1/frameworks/{id}/requirements:
    post:
      operationId: FrameworksController_createRequirement_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomRequirementDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Add a custom requirement to a framework instance
      tags:
      - Frameworks
      description: Add a custom requirement to a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Add a custom requirement to a framework | Comp AI API
          sidebarTitle: Add a custom requirement to a framework instance
          description: Add a custom requirement to a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Add a custom requirement to a framework | Comp AI API
          og:description: Add a custom requirement to a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: create-requirement
  /v1/frameworks/{id}/requirements/link:
    post:
      operationId: FrameworksController_linkRequirements_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkRequirementsDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Link (clone) existing requirements from another framework into this one
      tags:
      - Frameworks
      description: Link (clone) existing requirements from another framework into this one in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Link (clone) existing requirements from | Comp AI API
          sidebarTitle: Link (clone) existing requirements from another framework into this one
          description: Link (clone) existing requirements from another framework into this one in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances.
          og:title: Link (clone) existing requirements from | Comp AI API
          og:description: Link (clone) existing requirements from another framework into this one in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances.
      x-speakeasy-mcp:
        name: link-requirements
  /v1/frameworks/{id}/requirements/{requirementKey}/controls/link:
    post:
      operationId: FrameworksController_linkControls_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: requirementKey
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkControlsDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Link existing org controls to a requirement
      tags:
      - Frameworks
      description: Link existing org controls to a requirement in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Link existing org controls to a requirement | Comp AI API
          sidebarTitle: Link existing org controls to a requirement
          description: Link existing org controls to a requirement in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync.
          og:title: Link existing org controls to a requirement | Comp AI API
          og:description: Link existing org controls to a requirement in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync.
      x-speakeasy-mcp:
        name: link-controls
  /v1/frameworks/{id}/update-status:
    get:
      operationId: FrameworksController_getUpdateStatus_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get the update status for a framework instance
      tags:
      - Frameworks
      description: Get the update status for a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Get the update status for a framework instance | Comp AI API
          sidebarTitle: Get the update status for a framework instance
          description: Get the update status for a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Get the update status for a framework instance | Comp AI API
          og:description: Get the update status for a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: get-update-status
  /v1/frameworks/{id}/update-preview:
    get:
      operationId: FrameworksController_getUpdatePreview_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Preview changes from updating a framework instance
      tags:
      - Frameworks
      description: Preview changes from updating a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Preview changes from updating a framework | Comp AI API
          sidebarTitle: Preview changes from updating a framework instance
          description: Preview changes from updating a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
          og:title: Preview changes from updating a framework | Comp AI API
          og:description: Preview changes from updating a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores.
      x-speakeasy-mcp:
        name: get-update-preview
  /v1/frameworks/{id}/sync:
    post:
      operationId: FrameworksController_syncFramework_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncFrameworkDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Sync framework requirements
      tags:
      - Frameworks
      description: Sync framework requirements, controls, and tasks after framework content changes so compliance tracking remains current.
      x-mint:
        metadata:
          title: Sync framework requirements | Comp AI API
          sidebarTitle: Sync framework requirements
          description: Sync framework requirements, controls, and tasks after framework content changes so compliance tracking remains current.
          og:title: Sync framework requirements | Comp AI API
          og:description: Sync framework requirements, controls, and tasks after framework content changes so compliance tracking remains current.
      x-speakeasy-mcp:
        name: sync-framework
  /v1/frameworks/{id}/rollback:
    post:
      operationId: FrameworksController_rollbackFramework_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RollbackFrameworkDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Roll back a framework sync operation
      tags:
      - Frameworks
      description: Roll back a framework sync operation in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Roll back a framework sync operation | Comp AI API
          sidebarTitle: Roll back a framework sync operation
          description: Roll back a framework sync operation in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
          og:title: Roll back a framework sync operation | Comp AI API
          og:description: Roll back a framework sync operation in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-speakeasy-mcp:
        name: rollback-framework
  /v1/frameworks/{id}/sync-history:
    get:
      operationId: FrameworksController_getSyncHistory_v1
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Get sync history for a framework instance
      tags:
      - Frameworks
      description: Get sync history for a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync history.
      x-mint:
        metadata:
          title: Get sync history for a framework instance | Comp AI API
          sidebarTitle: Get sync history for a framework instance
          description: Get sync history for a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync.
          og:title: Get sync history for a framework instance | Comp AI API
          og:description: Get sync history for a framework instance in Comp AI. Manage SOC 2, ISO 27001, HIPAA, GDPR, and custom framework instances, requirements, scores, and sync.
      x-speakeasy-mcp:
        name: get-sync-history
components:
  schemas:
    CreateCustomFrameworkDto:
      type: object
      properties:
        name:
          type: string
          description: Framework name
          example: Internal Controls
        description:
          type: string
          description: Framework description
        version:
          type: string
          description: Version
          example: '1.0'
      required:
      - name
      - description
    SyncFrameworkDto:
      type: object
      properties: {}
    AddFrameworksDto:
      type: object
      properties:
        frameworkIds:
          description: Array of framework editor framework IDs to add
          minItems: 1
          type: array
          items:
            type: string
      required:
      - frameworkIds
    LinkControlsDto:
      type: object
      properties:
        controlIds:
          description: Existing org Control IDs to map to the requirement on this framework instance
          type: array
          items:
            type: string
      required:
      - controlIds
    LinkRequirementsDto:
      type: object
      properties:
        requirementIds:
          description: IDs of existing FrameworkEditorRequirement rows to clone into this framework
          type: array
          items:
            type: string
      required:
      - requirementIds
    CreateCustomRequirementDto:
      type: object
      properties:
        name:
          type: string
          description: Requirement name
          example: Access Review
        identifier:
          type: string
          description: Identifier
          example: '10.3'
        description:
          type: string
          description: Description
      required:
      - name
      - identifier
      - description
    UpdateCustomFrameworkDto:
      type: object
      properties:
        name:
          type: string
          description: Framework name
          example: Internal Controls
        description:
          type: string
          description: Framework description
    RollbackFrameworkDto:
      type: object
      properties: {}
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000