# TaskService

> The TaskService methods and their request and response messages.

Source: https://engramsfactory.com/docs/api/task/

Generated from [`task.proto`](https://github.com/cortexapps/engrams/blob/main/crates/engram-protocol/proto/engram/app/v1/task.proto). Every method is
`POST /rpc/engram.app.v1.TaskService/<Method>` with a JSON or protobuf body and an
`x-api-key` header.

## Methods

| Method | Request | Response |
|---|---|---|
| `CreateTask` | [`CreateTaskRequest`](#createtaskrequest) | [`CreateTaskResponse`](#createtaskresponse) |
| `ListTasks` | [`ListTasksRequest`](#listtasksrequest) | [`ListTasksResponse`](#listtasksresponse) |
| `GetTask` | [`GetTaskRequest`](#gettaskrequest) | [`GetTaskResponse`](#gettaskresponse) |
| `DeleteTask` | [`DeleteTaskRequest`](#deletetaskrequest) | [`DeleteTaskResponse`](#deletetaskresponse) |
| `UpdateTask` | [`UpdateTaskRequest`](#updatetaskrequest) | [`UpdateTaskResponse`](#updatetaskresponse) |

## Messages

### CreateTaskRequest

| Field | Type |
|---|---|
| `type` | `string` |
| `prompt` | `string` (optional) |
| `title` | `string` (optional) |
| `profile_id` | `string` |
| `harness` | `string` (optional) |
| `model` | `string` (optional) |
| `effort` | `string` (optional) |
| `harness_mode` | `string` (optional) |
| `defer_initial_prompt` | `bool` |
| `model_router` | `string` (optional) |

### CreateTaskResponse

| Field | Type |
|---|---|
| `task` | [`Task`](#task) |

### DeleteTaskRequest

| Field | Type |
|---|---|
| `task_id` | `string` |

### DeleteTaskResponse

No fields.

### GetTaskRequest

| Field | Type |
|---|---|
| `task_id` | `string` |
| `session_id` | `string` |

### GetTaskResponse

| Field | Type |
|---|---|
| `task` | [`Task`](#task) |

### ListTasksRequest

| Field | Type |
|---|---|
| `scope` | `string` |
| `search` | `string` |
| `created_by_user_ids` | repeated `string` |
| `states` | repeated `string` |
| `page` | `int32` |
| `page_size` | `int32` |
| `order` | `string` |

### ListTasksResponse

| Field | Type |
|---|---|
| `tasks` | repeated [`Task`](#task) |
| `total_count` | `int32` |
| `session_state_unavailable` | `bool` |

### Task

| Field | Type |
|---|---|
| `id` | `string` |
| `type` | `string` |
| `title` | `string` (optional) |
| `status` | `string` |
| `created_by_user_id` | `string` (optional) |
| `source_json` | `string` |
| `sessions` | repeated [`TaskSessionRef`](#tasksessionref) |
| `created_at` | `string` |
| `title_is_custom` | `bool` |
| `created_by` | `User` (optional) |
| `harness` | `string` (optional) |
| `model` | `string` (optional) |
| `effort` | `string` (optional) |
| `parent_task_id` | `string` (optional) |
| `root_task_id` | `string` (optional) |
| `local_task_name` | `string` (optional) |
| `canonical_task_name` | `string` (optional) |
| `spawning_session_id` | `string` (optional) |
| `descendants` | repeated [`Task`](#task) |
| `model_router` | `string` (optional) |

### TaskSessionRef

| Field | Type |
|---|---|
| `session_id` | `string` |
| `role` | `string` (optional) |
| `session` | `Session` (optional) |
| `profile` | `ProfileSnapshot` (optional) |

### UpdateTaskRequest

| Field | Type |
|---|---|
| `task_id` | `string` |
| `title` | `string` (optional) |

### UpdateTaskResponse

| Field | Type |
|---|---|
| `task` | [`Task`](#task) |
