TRtrycompai
Task Management

Create a new task item

Changed on

Create a new task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.

post/v1/task-management

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Request body

titlestring required

Task title

descriptionstring

Task description

status'todo' | 'in_progress' | 'in_review' | 'done' | 'canceled'

Task status

priority'urgent' | 'high' | 'medium' | 'low'

Task priority

entityIdstring required

ID of the entity this task belongs to

entityType'vendor' | 'risk' required

Type of entity

assigneeIdstring

Assignee member ID

Example request

{
  "title": "Review vendor contract",
  "entityType": "vendor"
}

Response

Task item created successfully

idstring required

Task item ID

titlestring required

Task title

descriptionobject nullable required

Task description

status'todo' | 'in_progress' | 'in_review' | 'done' | 'canceled' required

Task status

priority'urgent' | 'high' | 'medium' | 'low' required

Task priority

entityIdstring required

ID of the entity this task belongs to

entityType'vendor' | 'risk' required

Type of entity

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "id": "tski_abc123def456",
  "title": "Review vendor contract"
}

Changes