Comp AI Training API

openapi: 3.2.0
info:
  title: Comp AI Training 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: Training
  description: Record security awareness and HIPAA training completion status and generate completion certificates.
paths:
  /v1/training/completions:
    get:
      description: List security awareness and HIPAA training completion records for workforce compliance tracking and audit evidence.
      operationId: TrainingController_getCompletions_v1
      parameters: []
      responses:
        '200':
          description: List of training video completion records
      security:
      - apikey: []
      summary: List training completions
      tags:
      - Training
      x-mint:
        metadata:
          title: List training completions | Comp AI API
          sidebarTitle: List training completions
          description: List security awareness and HIPAA training completion records for workforce compliance tracking and audit evidence.
          og:title: List training completions | Comp AI API
          og:description: List security awareness and HIPAA training completion records for workforce compliance tracking and audit evidence.
      x-speakeasy-mcp:
        name: get-completions
  /v1/training/completions/{videoId}/complete:
    post:
      description: Marks a specific training video as completed for the authenticated member. Triggers completion email if all training is now done.
      operationId: TrainingController_markVideoComplete_v1
      parameters:
      - name: videoId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: The updated completion record
      security:
      - apikey: []
      summary: Mark a training video as complete
      tags:
      - Training
      x-mint:
        metadata:
          title: Mark a training video as complete | Comp AI API
          sidebarTitle: Mark a training video as complete
          description: Marks a specific training video as completed for the authenticated member. Triggers completion email if all training is now done.
          og:title: Mark a training video as complete | Comp AI API
          og:description: Marks a specific training video as completed for the authenticated member. Triggers completion email if all training is now done.
      x-speakeasy-mcp:
        name: mark-video-complete
  /v1/training/send-completion-email:
    post:
      description: Send training completion email with certificate in Comp AI. Record security awareness and HIPAA training completion status and generate completion certificates.
      operationId: TrainingController_sendTrainingCompletionEmail_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendTrainingCompletionDto'
      responses:
        '200':
          description: Email sent or reason why it was not sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendTrainingCompletionResponseDto'
      security:
      - apikey: []
      summary: Send training completion email with certificate
      tags:
      - Training
      x-mint:
        metadata:
          title: Send training completion email with | Comp AI API
          sidebarTitle: Send training completion email with certificate
          description: Send training completion email with certificate in Comp AI. Record security awareness and HIPAA training completion status and generate completion.
          og:title: Send training completion email with | Comp AI API
          og:description: Send training completion email with certificate in Comp AI. Record security awareness and HIPAA training completion status and generate completion.
      x-speakeasy-mcp:
        name: send-training-completion-email
  /v1/training/generate-certificate:
    post:
      description: Generate a training completion certificate that can be shared with auditors or attached as workforce security evidence.
      operationId: TrainingController_generateCertificate_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendTrainingCompletionDto'
      responses:
        '200':
          description: PDF certificate file
        '400':
          description: Training not complete or member not found
      security:
      - apikey: []
      summary: Generate training certificate
      tags:
      - Training
      x-mint:
        metadata:
          title: Generate training certificate | Comp AI API
          sidebarTitle: Generate training certificate
          description: Generate a training completion certificate that can be shared with auditors or attached as workforce security evidence.
          og:title: Generate training certificate | Comp AI API
          og:description: Generate a training completion certificate that can be shared with auditors or attached as workforce security evidence.
      x-speakeasy-mcp:
        name: generate-certificate
  /v1/training/generate-hipaa-certificate:
    post:
      description: Generate HIPAA training certificate PDF in Comp AI. Record security awareness and HIPAA training completion status and generate completion certificates.
      operationId: TrainingController_generateHipaaCertificate_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendTrainingCompletionDto'
      responses:
        '200':
          description: PDF certificate file
        '400':
          description: HIPAA training not complete or member not found
      security:
      - apikey: []
      summary: Generate HIPAA training certificate PDF
      tags:
      - Training
      x-mint:
        metadata:
          title: Generate HIPAA training certificate PDF | Comp AI API
          sidebarTitle: Generate HIPAA training certificate PDF
          description: Generate HIPAA training certificate PDF in Comp AI. Record security awareness and HIPAA training completion status and generate completion certificates.
          og:title: Generate HIPAA training certificate PDF | Comp AI API
          og:description: Generate HIPAA training certificate PDF in Comp AI. Record security awareness and HIPAA training completion status and generate completion certificates.
      x-speakeasy-mcp:
        name: generate-hipaa-certificate
components:
  schemas:
    SendTrainingCompletionResponseDto:
      type: object
      properties:
        sent:
          type: boolean
          description: Whether the email was sent
          example: true
        reason:
          type: string
          description: Reason if email was not sent
          example: training_not_complete
      required:
      - sent
    SendTrainingCompletionDto:
      type: object
      properties:
        memberId:
          type: string
          description: The member ID who completed training
          example: mem_abc123
        organizationId:
          type: string
          description: Organization ID (deprecated — use auth context)
          example: org_abc123
      required:
      - memberId
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
x-speakeasy-timeout: 120000