Skip to content

Tasks

Tasks are actionable items that users commit to completing within a session.

Base URL: https://api.deepworkzone.aiAuth: Authorization: Bearer YOUR_MULTIPLAI_ACCESS_TOKEN

Task Ownership

The owner of a task is automatically set to the currently authenticated user resolved from the Multiplai access token. You do not need to pass an owner field when creating tasks.


List Tasks

http
GET /api/v1/tasks

Returns all tasks belonging to the authenticated user.

json
{
  "data": [
    {
      "id": "101",
      "context": "Finish Q2 report draft",
      "is_completed": false,
      "owner": "john.doe",
      "source": null,
      "source_id": null
    }
  ]
}

Create Task

http
POST /api/v1/tasks

Creates a single new task.

json
{
  "context": "Finish Q2 report draft",
  "session_id": 5
}

Bulk Create Tasks

http
POST /api/v1/tasks/bulk

Creates multiple tasks in a single request. Typically used when importing tasks from an external source such as OKRx. If a task with the same source + source_id already exists, its context is updated instead of creating a duplicate.

json
{
  "tasks": [
    { "context": "Write unit tests", "source": "okrx", "source_id": 99 },
    { "context": "Deploy hotfix", "source": "okrx", "source_id": 100 }
  ],
  "session_id": 5
}

Update Task

http
PUT /api/v1/tasks/:id

Updates a task's content or completion status.

ParameterTypeDescription
idnumberThe task ID

Delete Task

http
DELETE /api/v1/tasks/:id

Permanently deletes a task.

ParameterTypeDescription
idnumberThe task ID

Built with VitePress