Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Comp AI Task Automations 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 Automations
description: Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
paths:
/v1/tasks/{taskId}/automations:
get:
description: Get all automations for a task in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_getTaskAutomations_v1
parameters:
- name: taskId
required: true
in: path
description: Unique task identifier
schema:
example: tsk_abc123def456
type: string
responses:
'200':
description: Automations retrieved successfully
security:
- apikey: []
summary: Get all automations for a task
tags:
- Task Automations
x-mint:
metadata:
title: Get all automations for a task | Comp AI API
sidebarTitle: Get all automations for a task
description: Get all automations for a task in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Get all automations for a task | Comp AI API
og:description: Get all automations for a task in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: get-task-automations
post:
description: Create an automated evidence workflow attached to a task so Comp AI can collect recurring proof from connected systems.
operationId: AutomationsController_createAutomation_v1
parameters:
- name: taskId
required: true
in: path
description: Unique task identifier
schema:
example: tsk_abc123def456
type: string
responses:
'201':
description: Automation created successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
automation:
type: object
properties:
id:
type: string
example: auto_abc123def456
name:
type: string
example: Task Name - Evidence Collection
'400':
description: Bad request - Invalid task ID or organization ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Invalid task ID or organization ID
'401':
description: Unauthorized - Invalid authentication
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Unauthorized
'404':
description: Task not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Task not found
security:
- apikey: []
summary: Create evidence automation
tags:
- Task Automations
x-mint:
metadata:
title: Create evidence automation | Comp AI API
sidebarTitle: Create evidence automation
description: Create an automated evidence workflow attached to a task so Comp AI can collect recurring proof from connected systems.
og:title: Create evidence automation | Comp AI API
og:description: Create an automated evidence workflow attached to a task so Comp AI can collect recurring proof from connected systems.
x-speakeasy-mcp:
name: create-automation
/v1/tasks/{taskId}/automations/{automationId}:
get:
description: Get automation details in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_getAutomation_v1
parameters:
- name: taskId
required: true
in: path
description: Unique task identifier
schema:
example: tsk_abc123def456
type: string
- name: automationId
required: true
in: path
description: Unique automation identifier
schema:
example: auto_abc123def456
type: string
responses:
'200':
description: Automation details retrieved successfully
security:
- apikey: []
summary: Get automation details
tags:
- Task Automations
x-mint:
metadata:
title: Get automation details | Comp AI API
sidebarTitle: Get automation details
description: Get automation details in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Get automation details | Comp AI API
og:description: Get automation details in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: get-automation
patch:
description: Update an existing automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_updateAutomation_v1
parameters:
- name: taskId
required: true
in: path
description: Unique task identifier
schema:
example: tsk_abc123def456
type: string
- name: automationId
required: true
in: path
description: Unique automation identifier
schema:
example: auto_abc123def456
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAutomationDto'
responses:
'200':
description: Automation updated successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
automation:
type: object
properties:
id:
type: string
example: auto_abc123def456
name:
type: string
example: Updated Automation Name
description:
type: string
example: Updated description
'400':
description: Bad request - Invalid automation ID or data
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Invalid automation data
'401':
description: Unauthorized - Invalid authentication
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Unauthorized
'404':
description: Automation not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Automation not found
security:
- apikey: []
summary: Update an existing automation
tags:
- Task Automations
x-mint:
metadata:
title: Update an existing automation | Comp AI API
sidebarTitle: Update an existing automation
description: Update an existing automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Update an existing automation | Comp AI API
og:description: Update an existing automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: update-automation
delete:
description: Delete an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_deleteAutomation_v1
parameters:
- name: taskId
required: true
in: path
description: Unique task identifier
schema:
example: tsk_abc123def456
type: string
- name: automationId
required: true
in: path
description: Unique automation identifier
schema:
example: auto_abc123def456
type: string
responses:
'200':
description: Automation deleted successfully
security:
- apikey: []
summary: Delete an automation
tags:
- Task Automations
x-mint:
metadata:
title: Delete an automation | Comp AI API
sidebarTitle: Delete an automation
description: Delete an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Delete an automation | Comp AI API
og:description: Delete an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: delete-automation
/v1/tasks/{taskId}/automations/{automationId}/runs:
get:
description: Get all runs for a specific automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_getAutomationRuns_v1
parameters:
- name: taskId
required: true
in: path
description: Task ID
schema:
type: string
- name: automationId
required: true
in: path
description: Automation ID
schema:
type: string
responses:
'200':
description: Runs retrieved successfully
security:
- apikey: []
summary: Get all runs for a specific automation
tags:
- Task Automations
x-mint:
metadata:
title: Get all runs for a specific automation | Comp AI API
sidebarTitle: Get all runs for a specific automation
description: Get all runs for a specific automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Get all runs for a specific automation | Comp AI API
og:description: Get all runs for a specific automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: get-automation-runs
/v1/tasks/{taskId}/automations/{automationId}/versions:
get:
description: Get all versions for an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_getAutomationVersions_v1
parameters:
- name: taskId
required: true
in: path
description: Task ID
schema:
type: string
- name: automationId
required: true
in: path
description: Automation ID
schema:
type: string
- name: limit
required: true
in: query
schema:
type: string
- name: offset
required: true
in: query
schema:
type: string
responses:
'200':
description: Versions retrieved successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
versions:
type: array
items:
type: object
properties:
id:
type: string
version:
type: number
scriptKey:
type: string
changelog:
type:
- string
- 'null'
publishedBy:
type:
- string
- 'null'
createdAt:
type: string
format: date-time
security:
- apikey: []
summary: Get all versions for an automation
tags:
- Task Automations
x-mint:
metadata:
title: Get all versions for an automation | Comp AI API
sidebarTitle: Get all versions for an automation
description: Get all versions for an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Get all versions for an automation | Comp AI API
og:description: Get all versions for an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: get-automation-versions
post:
operationId: AutomationsController_createVersion_v1
parameters:
- name: taskId
required: true
in: path
description: Task ID
schema:
type: string
- name: automationId
required: true
in: path
description: Automation ID
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVersionDto'
responses:
'201':
description: ''
security:
- apikey: []
summary: Create a published version record for an automation
tags:
- Task Automations
description: Create a published version record for an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-mint:
metadata:
title: Create a published version record for an | Comp AI API
sidebarTitle: Create a published version record for an automation
description: Create a published version record for an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached.
og:title: Create a published version record for an | Comp AI API
og:description: Create a published version record for an automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached.
x-speakeasy-mcp:
name: create-version
/v1/tasks/{taskId}/automations/runs:
get:
description: Get all automation runs for a task in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
operationId: AutomationsController_getTaskAutomationRuns_v1
parameters:
- name: taskId
required: true
in: path
description: Task ID
schema:
example: tsk_abc123def456
type: string
responses:
'200':
description: Automation runs retrieved successfully
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
example: ear_abc123def456
status:
type: string
enum:
- PENDING
- RUNNING
- COMPLETED
- FAILED
trigger:
type: string
enum:
- MANUAL
- SCHEDULED
- EVENT
createdAt:
type: string
format: date-time
completedAt:
type:
- string
- 'null'
format: date-time
error:
type:
- object
- 'null'
security:
- apikey: []
summary: Get all automation runs for a task
tags:
- Task Automations
x-mint:
metadata:
title: Get all automation runs for a task | Comp AI API
sidebarTitle: Get all automation runs for a task
description: Get all automation runs for a task in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
og:title: Get all automation runs for a task | Comp AI API
og:description: Get all automation runs for a task in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.
x-speakeasy-mcp:
name: get-task-automation-runs
components:
schemas:
CreateVersionDto:
type: object
properties:
version:
type: number
description: Version number for this published script
example: 1
scriptKey:
type: string
description: S3 key of the already-generated & published automation script (returned by the publish step).
example: org_abc123/tsk_abc123/aut_abc123.v1.js
changelog:
type: string
description: Optional changelog describing this version
required:
- version
- scriptKey
UpdateAutomationDto:
type: object
properties:
name:
type: string
description: Automation name
example: GitHub Security Check - Evidence Collection
description:
type: string
description: Automation description
example: Collects evidence about GitHub repository security settings
isEnabled:
type: boolean
description: Whether the automation is enabled
evaluationCriteria:
type: string
description: Evaluation criteria for the automation
scheduleFrequency:
type: string
enum:
- daily
- weekly
- monthly
- quarterly
- yearly
description: Automation schedule cadence
securitySchemes:
apikey:
type: apiKey
in: header
name: X-API-Key
description: API key for authentication
x-speakeasy-timeout: 120000