Comp AI Task Management API

openapi: 3.2.0
info:
  title: Comp AI Task Management 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: Task Management
  description: Manage task items and attachments linked to operational entities such as risks and vendors.
paths:
  /v1/task-management/stats:
    get:
      description: Get task items statistics for an entity in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_getTaskItemsStats_v1
      parameters:
      - name: entityId
        required: true
        in: query
        description: ID of the entity to get task items stats for
        schema:
          example: vnd_abc123def456
          type: string
      - name: entityType
        required: true
        in: query
        description: Type of entity
        schema:
          enum:
          - vendor
          - risk
          type: string
      responses:
        '200':
          description: Task items statistics retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: number
                  byStatus:
                    type: object
                    properties:
                      todo:
                        type: number
                      in_progress:
                        type: number
                      in_review:
                        type: number
                      done:
                        type: number
                      canceled:
                        type: number
      security:
      - apikey: []
      summary: Get task items statistics for an entity
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Get task items statistics for an entity | Comp AI API
          sidebarTitle: Get task items statistics for an entity
          description: Get task items statistics for an entity in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Get task items statistics for an entity | Comp AI API
          og:description: Get task items statistics for an entity in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: get-task-items-stats
  /v1/task-management:
    get:
      description: Get task items for an entity in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_getTaskItems_v1
      parameters:
      - name: entityId
        required: true
        in: query
        description: ID of the entity to get task items for
        schema:
          example: vnd_abc123def456
          type: string
      - name: entityType
        required: true
        in: query
        description: Type of entity
        schema:
          example: vendor
          type: string
          enum:
          - vendor
          - risk
      - name: page
        required: false
        in: query
        description: Page number (1-indexed)
        schema:
          minimum: 1
          default: 1
          example: 1
          type: number
      - name: limit
        required: false
        in: query
        description: Number of items per page
        schema:
          minimum: 1
          maximum: 100
          default: 5
          example: 5
          type: number
      - name: status
        required: false
        in: query
        description: Filter by status
        schema:
          example: todo
          type: string
          enum:
          - todo
          - in_progress
          - in_review
          - done
          - canceled
      - name: priority
        required: false
        in: query
        description: Filter by priority
        schema:
          example: high
          type: string
          enum:
          - urgent
          - high
          - medium
          - low
      - name: assigneeId
        required: false
        in: query
        description: Filter by assignee ID
        schema:
          example: mbr_abc123def456
          type: string
      - name: sortBy
        required: false
        in: query
        description: Sort by field
        schema:
          default: createdAt
          example: createdAt
          type: string
          enum:
          - createdAt
          - updatedAt
          - title
          - status
          - priority
      - name: sortOrder
        required: false
        in: query
        description: Sort order
        schema:
          default: desc
          example: desc
          type: string
          enum:
          - asc
          - desc
      responses:
        '200':
          description: Task items retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTaskItemResponseDto'
      security:
      - apikey: []
      summary: Get task items for an entity
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Get task items for an entity | Comp AI API
          sidebarTitle: Get task items for an entity
          description: Get task items for an entity in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Get task items for an entity | Comp AI API
          og:description: Get task items for an entity in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: get-task-items
    post:
      description: Create a new task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_createTaskItem_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTaskItemDto'
      responses:
        '201':
          description: Task item created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskItemResponseDto'
      security:
      - apikey: []
      summary: Create a new task item
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Create a new task item | Comp AI API
          sidebarTitle: Create a new task item
          description: Create a new task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Create a new task item | Comp AI API
          og:description: Create a new task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: create-task-item
  /v1/task-management/{id}:
    put:
      description: Update a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_updateTaskItem_v1
      parameters:
      - name: id
        required: true
        in: path
        description: Task item ID
        schema:
          example: tski_abc123def456
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskItemDto'
      responses:
        '200':
          description: Task item updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskItemResponseDto'
      security:
      - apikey: []
      summary: Update a task item
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Update a task item | Comp AI API
          sidebarTitle: Update a task item
          description: Update a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Update a task item | Comp AI API
          og:description: Update a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: update-task-item
    delete:
      description: Delete a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_deleteTaskItem_v1
      parameters:
      - name: id
        required: true
        in: path
        description: Task item ID
        schema:
          example: tski_abc123def456
          type: string
      responses:
        '204':
          description: Task item deleted successfully
      security:
      - apikey: []
      summary: Delete a task item
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Delete a task item | Comp AI API
          sidebarTitle: Delete a task item
          description: Delete a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Delete a task item | Comp AI API
          og:description: Delete a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: delete-task-item
  /v1/task-management/attachments:
    post:
      description: 'Upload a file attachment for a task item with proper S3 path structure: org_{orgId}/attachments/task-item/{entityType}/{entityId}/files.'
      operationId: TaskManagementController_uploadTaskItemAttachment_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadTaskItemAttachmentDto'
      responses:
        '201':
          description: Attachment uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentResponseDto'
      security:
      - apikey: []
      summary: Upload attachment to task item
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Upload attachment to task item | Comp AI API
          sidebarTitle: Upload attachment to task item
          description: 'Upload a file attachment for a task item with proper S3 path structure: org_{orgId}/attachments/task-item/{entityType}/{entityId}/files.'
          og:title: Upload attachment to task item | Comp AI API
          og:description: 'Upload a file attachment for a task item with proper S3 path structure: org_{orgId}/attachments/task-item/{entityType}/{entityId}/files.'
      x-speakeasy-mcp:
        name: upload-task-item-attachment
  /v1/task-management/attachments/{attachmentId}:
    delete:
      description: Delete attachment from task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_deleteTaskItemAttachment_v1
      parameters:
      - name: attachmentId
        required: true
        in: path
        description: Attachment ID
        schema:
          example: att_abc123def456
          type: string
      responses:
        '204':
          description: Attachment deleted successfully
      security:
      - apikey: []
      summary: Delete attachment from task item
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Delete attachment from task item | Comp AI API
          sidebarTitle: Delete attachment from task item
          description: Delete attachment from task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Delete attachment from task item | Comp AI API
          og:description: Delete attachment from task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: delete-task-item-attachment
  /v1/task-management/{id}/activity:
    get:
      description: Get task item activity log in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      operationId: TaskManagementController_getTaskItemActivity_v1
      parameters:
      - name: id
        required: true
        in: path
        description: Task item ID
        schema:
          example: tski_abc123def456
          type: string
      responses:
        '200':
          description: Activity logs retrieved successfully
      security:
      - apikey: []
      summary: Get task item activity log
      tags:
      - Task Management
      x-mint:
        metadata:
          title: Get task item activity log | Comp AI API
          sidebarTitle: Get task item activity log
          description: Get task item activity log in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
          og:title: Get task item activity log | Comp AI API
          og:description: Get task item activity log in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.
      x-speakeasy-mcp:
        name: get-task-item-activity
components:
  schemas:
    AttachmentResponseDto:
      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
        size:
          type: number
          description: File size in bytes
          example: 1024000
        downloadUrl:
          type: string
          description: Signed URL for downloading the file (temporary)
          example: https://bucket.s3.amazonaws.com/path/to/file.pdf?signature=...
        createdAt:
          format: date-time
          type: string
          description: Upload timestamp
          example: '2024-01-15T10:30:00Z'
      required:
      - id
      - name
      - type
      - size
      - downloadUrl
      - createdAt
    TaskItemAssigneeDto:
      type: object
      properties:
        id:
          type: string
          description: Member ID
        user:
          type: object
          description: User information
      required:
      - id
      - user
    TaskItemResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Task item ID
          example: tski_abc123def456
        title:
          type: string
          description: Task title
          example: Review vendor contract
        description:
          type:
          - object
          - 'null'
          description: Task description
        status:
          type: string
          description: Task status
          enum:
          - todo
          - in_progress
          - in_review
          - done
          - canceled
        priority:
          type: string
          description: Task priority
          enum:
          - urgent
          - high
          - medium
          - low
        entityId:
          type: string
          description: ID of the entity this task belongs to
        entityType:
          type: string
          description: Type of entity
          enum:
          - vendor
          - risk
        assignee:
          description: Assignee information
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/TaskItemAssigneeDto'
        createdBy:
          description: Creator information
          allOf:
          - $ref: '#/components/schemas/TaskItemCreatorDto'
        updatedBy:
          description: Last updater information
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/TaskItemUpdaterDto'
        createdAt:
          format: date-time
          type: string
          description: Creation timestamp
        updatedAt:
          format: date-time
          type: string
          description: Last update timestamp
      required:
      - id
      - title
      - description
      - status
      - priority
      - entityId
      - entityType
      - assignee
      - createdBy
      - updatedBy
      - createdAt
      - updatedAt
    TaskItemCreatorDto:
      type: object
      properties:
        id:
          type: string
          description: Member ID
        user:
          type: object
          description: User information
      required:
      - id
      - user
    CreateTaskItemDto:
      type: object
      properties:
        title:
          type: string
          description: Task title
          example: Review vendor contract
        description:
          type: string
          description: Task description
        status:
          type: string
          description: Task status
          enum:
          - todo
          - in_progress
          - in_review
          - done
          - canceled
          default: todo
        priority:
          type: string
          description: Task priority
          enum:
          - urgent
          - high
          - medium
          - low
          default: medium
        entityId:
          type: string
          description: ID of the entity this task belongs to
        entityType:
          type: string
          description: Type of entity
          enum:
          - vendor
          - risk
          example: vendor
        assigneeId:
          type: string
          description: Assignee member ID
      required:
      - title
      - entityId
      - entityType
    UpdateTaskItemDto:
      type: object
      properties:
        title:
          type: string
          description: Task title
        description:
          type: string
          description: Task description
        status:
          type: string
          description: Task status
          enum:
          - todo
          - in_progress
          - in_review
          - done
          - canceled
        priority:
          type: string
          description: Task priority
          enum:
          - urgent
          - high
          - medium
          - low
        assigneeId:
          type:
          - object
          - 'null'
          description: Assignee member ID (set to null to unassign)
    UploadTaskItemAttachmentDto:
      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 data
          example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==
        entityType:
          type: string
          description: Type of entity this task item belongs to (vendor or risk)
          enum:
          - vendor
          - risk
          example: vendor
        entityId:
          type: string
          description: ID of the entity this task item belongs to
          example: vnd_abc123def456
      required:
      - fileName
      - fileType
      - fileData
      - entityType
      - entityId
    TaskItemUpdaterDto:
      type: object
      properties:
        id:
          type: string
          description: Member ID
        user:
          type: object
          description: User information
      required:
      - id
      - user
    PaginatedTaskItemResponseDto:
      type: object
      properties:
        data:
          description: Array of task items
          type: array
          items:
            $ref: '#/components/schemas/TaskItemResponseDto'
        meta:
          description: Pagination metadata
          allOf:
          - $ref: '#/components/schemas/PaginationMetaDto'
      required:
      - data
      - meta
    PaginationMetaDto:
      type: object
      properties:
        page:
          type: number
          description: Current page number
        limit:
          type: number
          description: Number of items per page
        total:
          type: number
          description: Total number of items
        totalPages:
          type: number
          description: Total number of pages
        hasNextPage:
          type: boolean
          description: Whether there are more pages
        hasPrevPage:
          type: boolean
          description: Whether there are previous pages
      required:
      - page
      - limit
      - total
      - totalPages
      - hasNextPage
      - hasPrevPage
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000