find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/comp-ai:comp-ai-comments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Comp AI Comments 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: Comments
  description: Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
paths:
  /v1/comments:
    get:
      description: Get comments for an entity in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      operationId: CommentsController_getComments_v1
      parameters:
      - name: entityId
        required: true
        in: query
        description: ID of the entity to get comments for
        schema:
          example: tsk_abc123def456
          type: string
      - name: entityType
        required: true
        in: query
        description: Type of entity
        schema:
          enum:
          - task
          - vendor
          - risk
          - policy
          - finding
          type: string
      responses:
        '200':
          description: Comments retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommentResponseDto'
      security:
      - apikey: []
      summary: Get comments for an entity
      tags:
      - Comments
      x-mint:
        metadata:
          title: Get comments for an entity | Comp AI API
          sidebarTitle: Get comments for an entity
          description: Get comments for an entity in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
          og:title: Get comments for an entity | Comp AI API
          og:description: Get comments for an entity in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      x-speakeasy-mcp:
        name: get-comments
    post:
      description: Create a new comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      operationId: CommentsController_createComment_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCommentDto'
      responses:
        '201':
          description: Comment created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentResponseDto'
      security:
      - apikey: []
      summary: Create a new comment
      tags:
      - Comments
      x-mint:
        metadata:
          title: Create a new comment | Comp AI API
          sidebarTitle: Create a new comment
          description: Create a new comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
          og:title: Create a new comment | Comp AI API
          og:description: Create a new comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      x-speakeasy-mcp:
        name: create-comment
  /v1/comments/{commentId}:
    put:
      description: Update a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      operationId: CommentsController_updateComment_v1
      parameters:
      - name: commentId
        required: true
        in: path
        description: Unique comment identifier
        schema:
          example: cmt_abc123def456
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCommentDto'
      responses:
        '200':
          description: Comment updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentResponseDto'
      security:
      - apikey: []
      summary: Update a comment
      tags:
      - Comments
      x-mint:
        metadata:
          title: Update a comment | Comp AI API
          sidebarTitle: Update a comment
          description: Update a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
          og:title: Update a comment | Comp AI API
          og:description: Update a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      x-speakeasy-mcp:
        name: update-comment
    delete:
      description: Delete a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      operationId: CommentsController_deleteComment_v1
      parameters:
      - name: commentId
        required: true
        in: path
        description: Unique comment identifier
        schema:
          example: cmt_abc123def456
          type: string
      requestBody:
        required: true
        description: Delete comment request body
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                  description: User ID of the comment author (required for API key auth, ignored for JWT auth)
                  example: usr_abc123def456
      responses:
        '200':
          description: Comment deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  deletedCommentId:
                    type: string
                    example: cmt_abc123def456
                  message:
                    type: string
                    example: Comment deleted successfully
        '401':
          description: Unauthorized - Invalid authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthorized
        '404':
          description: Comment not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Comment with ID cmt_abc123def456 not found
      security:
      - apikey: []
      summary: Delete a comment
      tags:
      - Comments
      x-mint:
        metadata:
          title: Delete a comment | Comp AI API
          sidebarTitle: Delete a comment
          description: Delete a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
          og:title: Delete a comment | Comp AI API
          og:description: Delete a comment in Comp AI. Create and manage collaboration comments on compliance entities such as tasks, policies, risks, vendors, and findings.
      x-speakeasy-mcp:
        name: delete-comment
components:
  schemas:
    CreateCommentDto:
      type: object
      properties:
        content:
          type: string
          description: Content of the comment
          example: This task needs to be completed by end of week
          maxLength: 2000
        entityId:
          type: string
          description: ID of the entity to comment on
          example: tsk_abc123def456
        entityType:
          type: string
          description: Type of entity being commented on
          enum:
          - task
          - vendor
          - risk
          - policy
          - finding
          example: task
        contextUrl:
          type: string
          description: Optional URL of the page where the comment was created, used for deep-linking in notifications
          example: https://app.trycomp.ai/org_abc123/vendors/vnd_abc123?taskItemId=tki_abc123#task-items
          maxLength: 2048
        attachments:
          description: Optional attachments to include with the comment
          type: array
          items:
            $ref: '#/components/schemas/UploadAttachmentDto'
        userId:
          type: string
          description: User ID of the comment author (required for API key auth, ignored for JWT auth)
          example: usr_abc123def456
      required:
      - content
      - entityId
      - entityType
    UploadAttachmentDto:
      type: object
      properties:
        fileName:
          type: string
          description: Name of the file
          example: document.pdf
          maxLength: 255
        fileType:
          type: string
          description: MIME type of the file
          example: application/pdf
        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=attachment) and pass `s3Key` — base64 through an LLM is impractically slow and times out. Provide exactly one of fileData or s3Key.
          example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==
        s3Key:
          type: string
          description: Key of a file already uploaded via /v1/uploads/presign (purpose=attachment). The server fetches the bytes from storage — no base64 needed. Provide exactly one of fileData or s3Key.
          example: org_abc123/uploads/attachment/1700000000000-rbac-matrix.xlsx
        description:
          type: string
          description: Description of the attachment
          example: Meeting notes from Q4 planning session
          maxLength: 500
        userId:
          type: string
          description: User ID of the user uploading the attachment (required for API key auth, ignored for JWT auth)
          example: usr_abc123def456
      required:
      - fileName
      - fileType
    AuthorResponseDto:
      type: object
      properties:
        id:
          type: string
          description: User ID
          example: usr_abc123def456
        name:
          type: string
          description: User name
          example: John Doe
        email:
          type: string
          description: User email
          example: john.doe@company.com
        image:
          type:
          - object
          - 'null'
          description: User profile image URL
          example: https://example.com/avatar.jpg
        deactivated:
          type:
          - boolean
          - 'null'
          description: Whether the user is deactivated
          example: false
      required:
      - id
      - name
      - email
      - image
      - deactivated
    CommentResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the comment
          example: cmt_abc123def456
        content:
          type: string
          description: Comment content
          example: This task needs to be completed by end of week
        author:
          description: Comment author information
          allOf:
          - $ref: '#/components/schemas/AuthorResponseDto'
        attachments:
          description: Attachment metadata (URLs generated on-demand)
          type: array
          items:
            $ref: '#/components/schemas/AttachmentMetadataDto'
        createdAt:
          format: date-time
          type: string
          description: Comment creation timestamp
          example: '2024-01-15T10:30:00Z'
      required:
      - id
      - content
      - author
      - attachments
      - createdAt
    UpdateCommentDto:
      type: object
      properties:
        content:
          type: string
          description: Updated content of the comment
          example: This task needs to be completed by end of week (updated)
          maxLength: 2000
        contextUrl:
          type: string
          description: Optional URL of the page where the comment was updated, used for deep-linking in notifications
          example: https://app.trycomp.ai/org_abc123/risk/rsk_abc123?taskItemId=tki_abc123#task-items
          maxLength: 2048
        userId:
          type: string
          description: User ID of the comment author (required for API key auth, ignored for JWT auth)
          example: usr_abc123def456
      required:
      - content
    AttachmentMetadataDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the attachment
          example: att_abc123def456
        name:
          type: string
          description: Original filename
          example: document.pdf
        type:
          type: string
          description: File type/MIME type
          example: application/pdf
        createdAt:
          format: date-time
          type: string
          description: Upload timestamp
          example: '2024-01-15T10:30:00Z'
      required:
      - id
      - name
      - type
      - createdAt
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000