@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/work.md

@@ -0,0 +1,3096 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.work`: Work
+
+59 operations (27 read, 25 write, 5 destructive, 2 billable).
+
+No hand-written client covers this area. Call it through `g8.api.work.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [work.d.ts](work.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`addWorkCustomEmoji`](#op-addworkcustomemoji) | `POST /api/v1/work/custom-emoji` | write | `work:write` | Add Work Custom Emoji |
+| [`addWorkPulseNote`](#op-addworkpulsenote) | `POST /api/v1/work/pulse` | write | `work:write` | Add Work Pulse Note |
+| [`archiveWorkAgent`](#op-archiveworkagent) | `DELETE /api/v1/work/agents/{agent_id}` | destructive | `work:delete` | Archive Work Agent |
+| [`createWorkAgent`](#op-createworkagent) | `POST /api/v1/work/agents` | write | `work:write` | Create Work Agent |
+| [`createWorkChannel`](#op-createworkchannel) | `POST /api/v1/work/channels` | write | `work:write` | Create Work Channel |
+| [`createWorkMessage`](#op-createworkmessage) | `POST /api/v1/work/messages` | write | `work:write` | Create Work Message |
+| [`createWorkProject`](#op-createworkproject) | `POST /api/v1/work/projects` | write | `work:write` | Create Work Project |
+| [`createWorkRoutine`](#op-createworkroutine) | `POST /api/v1/work/routines` | write | `work:write` | Create Work Routine |
+| [`deleteWorkChannel`](#op-deleteworkchannel) | `DELETE /api/v1/work/channels/{channel_id}` | destructive | `work:delete` | Delete Work Channel |
+| [`deleteWorkMessage`](#op-deleteworkmessage) | `DELETE /api/v1/work/messages/{message_id}` | destructive | `work:delete` | Delete Work Message |
+| [`deleteWorkProject`](#op-deleteworkproject) | `DELETE /api/v1/work/projects/{project_id}` | destructive | `work:delete` | Delete Work Project |
+| [`deleteWorkRoutine`](#op-deleteworkroutine) | `DELETE /api/v1/work/routines/{routine_id}` | destructive | `work:delete` | Delete Work Routine |
+| [`editWorkMemory`](#op-editworkmemory) | `PUT /api/v1/work/memory` | write | `work:write` | Edit Work Memory |
+| [`editWorkMessage`](#op-editworkmessage) | `PATCH /api/v1/work/messages/{message_id}` | write | `work:write` | Edit Work Message |
+| [`forwardWorkMessage`](#op-forwardworkmessage) | `POST /api/v1/work/messages/{message_id}/forward` | write | `work:write` | Forward Work Message |
+| [`getWorkAgent`](#op-getworkagent) | `GET /api/v1/work/agents/{agent_id}` | read | `work:read` | Get Work Agent |
+| [`getWorkAgentPolicy`](#op-getworkagentpolicy) | `GET /api/v1/work/agents/policy` | read | `work:read` | Get Work Agent Policy |
+| [`getWorkAttachmentLink`](#op-getworkattachmentlink) | `GET /api/v1/work/attachments/{attachment_id}` | read | `work:read` | Get Work Attachment Link |
+| [`getWorkChannelCanvas`](#op-getworkchannelcanvas) | `GET /api/v1/work/channels/{channel_id}/canvas` | read | `work:read` | Get Work Channel Canvas |
+| [`getWorkDailyBrief`](#op-getworkdailybrief) | `GET /api/v1/work/preferences/daily-brief` | read | `work:read` | Get Work Daily Brief |
+| [`getWorkInboxDispositions`](#op-getworkinboxdispositions) | `GET /api/v1/work/inbox-dispositions` | read | `work:read` | Get Work Inbox Dispositions |
+| [`getWorkMemory`](#op-getworkmemory) | `GET /api/v1/work/memory` | read | `work:read` | Get Work Memory |
+| [`getWorkMessage`](#op-getworkmessage) | `GET /api/v1/work/messages/{message_id}` | read | `work:read` | Get Work Message |
+| [`getWorkOversight`](#op-getworkoversight) | `GET /api/v1/work/oversight` | read | `work:read` | Get Work Oversight |
+| [`getWorkReadMarkers`](#op-getworkreadmarkers) | `GET /api/v1/work/read-markers` | read | `work:read` | Get Work Read Markers |
+| [`getWorkRoom`](#op-getworkroom) | `GET /api/v1/work/room` | read | `work:read` | Get Work Room |
+| [`getWorkTeamHistory`](#op-getworkteamhistory) | `GET /api/v1/work/team-hq/history` | read | `work:read` | Get Work Team History |
+| [`getWorkTeamLeaderboard`](#op-getworkteamleaderboard) | `GET /api/v1/work/team-hq/leaderboard` | read | `work:read` | Get Work Team Leaderboard |
+| [`listAvailableWorkChannels`](#op-listavailableworkchannels) | `GET /api/v1/work/channels/available` | read | `work:read` | List Available Work Channels |
+| [`listWorkActivity`](#op-listworkactivity) | `GET /api/v1/work/activity` | read | `work:read` | List Work Activity |
+| [`listWorkAgentExecutionIdentities`](#op-listworkagentexecutionidentities) | `GET /api/v1/work/agents/execution-identities` | read | `work:read` | List Work Agent Execution Identities |
+| [`listWorkAgents`](#op-listworkagents) | `GET /api/v1/work/agents` | read | `work:read` | List Work Agents |
+| [`listWorkChannels`](#op-listworkchannels) | `GET /api/v1/work/channels` | read | `work:read` | List Work Channels |
+| [`listWorkConversationEvents`](#op-listworkconversationevents) | `GET /api/v1/work/conversations/{conversation_id}/events` | read | `work:read` | List Work Conversation Events |
+| [`listWorkConversationFiles`](#op-listworkconversationfiles) | `GET /api/v1/work/conversations/{conversation_id}/files` | read | `work:read` | List Work Conversation Files |
+| [`listWorkConversationMessages`](#op-listworkconversationmessages) | `GET /api/v1/work/conversations/{conversation_id}/messages` | read | `work:read` | List Work Conversation Messages |
+| [`listWorkItemHistory`](#op-listworkitemhistory) | `GET /api/v1/work/work-items/history` | read | `work:read` | List Work Item History |
+| [`listWorkItems`](#op-listworkitems) | `GET /api/v1/work/work-items` | read | `work:read` | List Work Items |
+| [`listWorkRecentActivity`](#op-listworkrecentactivity) | `GET /api/v1/work/team-hq/recent-activity` | read | `work:read` | List Work Recent Activity |
+| [`listWorkRoutineRuns`](#op-listworkroutineruns) | `GET /api/v1/work/routines/{routine_id}/runs` | billable | `work:run` | List Work Routine Runs |
+| [`listWorkRoutines`](#op-listworkroutines) | `GET /api/v1/work/routines` | read | `work:read` | List Work Routines |
+| [`listWorkTeamReceipts`](#op-listworkteamreceipts) | `GET /api/v1/work/team-hq/receipts` | read | `work:read` | List Work Team Receipts |
+| [`moveWorkMemory`](#op-moveworkmemory) | `POST /api/v1/work/memory/move` | write | `work:write` | Move Work Memory |
+| [`promoteWorkSignal`](#op-promoteworksignal) | `POST /api/v1/work/signals/promote` | billable | `work:run` | Promote Work Signal |
+| [`reactToWorkMessage`](#op-reacttoworkmessage) | `PUT /api/v1/work/messages/{message_id}/reaction` | write | `work:write` | React To Work Message |
+| [`runWorkRoutineNow`](#op-runworkroutinenow) | `POST /api/v1/work/routines/{routine_id}/run` | write | `work:write` | Run Work Routine Now |
+| [`saveWorkChannelCanvas`](#op-saveworkchannelcanvas) | `POST /api/v1/work/channels/{channel_id}/canvas` | write | `work:write` | Save Work Channel Canvas |
+| [`searchWork`](#op-searchwork) | `GET /api/v1/work/search` | read | `work:read` | Search Work |
+| [`setWorkChannelPurpose`](#op-setworkchannelpurpose) | `PUT /api/v1/work/channels/{channel_id}/purpose` | write | `work:write` | Set Work Channel Purpose |
+| [`setWorkDailyBrief`](#op-setworkdailybrief) | `POST /api/v1/work/preferences/daily-brief` | write | `work:write` | Set Work Daily Brief |
+| [`setWorkInboxDisposition`](#op-setworkinboxdisposition) | `POST /api/v1/work/inbox-dispositions` | write | `work:write` | Set Work Inbox Disposition |
+| [`setWorkPulseReaction`](#op-setworkpulsereaction) | `POST /api/v1/work/pulse/{note_id}/reaction` | write | `work:write` | Set Work Pulse Reaction |
+| [`setWorkReadMarkers`](#op-setworkreadmarkers) | `POST /api/v1/work/read-markers` | write | `work:write` | Set Work Read Markers |
+| [`setWorkSidebarPreferences`](#op-setworksidebarpreferences) | `POST /api/v1/work/sidebar-preferences` | write | `work:write` | Set Work Sidebar Preferences |
+| [`setWorkSignalState`](#op-setworksignalstate) | `POST /api/v1/work/signals/state` | write | `work:write` | Set Work Signal State |
+| [`updateWorkAgent`](#op-updateworkagent) | `PATCH /api/v1/work/agents/{agent_id}` | write | `work:write` | Update Work Agent |
+| [`updateWorkChannel`](#op-updateworkchannel) | `PATCH /api/v1/work/channels/{channel_id}` | write | `work:write` | Update Work Channel |
+| [`updateWorkProject`](#op-updateworkproject) | `PATCH /api/v1/work/projects/{project_id}` | write | `work:write` | Update Work Project |
+| [`updateWorkRoutine`](#op-updateworkroutine) | `PATCH /api/v1/work/routines/{routine_id}` | write | `work:write` | Update Work Routine |
+
+---
+
+<a id="op-addworkcustomemoji"></a>
+
+### `g8.api.work.addWorkCustomEmoji(input)`
+
+**Add Work Custom Emoji**
+
+- HTTP: `POST /api/v1/work/custom-emoji`
+- operationId: `add_work_custom_emoji_work_custom_emoji_post` (also callable as `g8.api.call("add_work_custom_emoji_work_custom_emoji_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Register one custom emoji for the whole organization.
+
+``url`` must be ``https:`` and is refused rather than coerced: a custom
+emoji renders in every member's browser. ``shortcode`` is lower-cased and
+must be 2-32 characters of ``a-z 0-9 _ + -``. The response carries the
+organization's whole emoji set.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkCustomEmojiRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkCustomEmojiRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.shortcode` | `string` | yes | min length 2, max length 32 |
+| `body.url` | `string` | yes | min length 1, max length 2048 |
+
+**Returns** `ApiResponse_WorkCustomEmojiResult_`: the envelope `{ data: WorkCustomEmojiResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkCustomEmojiResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `customEmojis` | `Array<Record<string, unknown>> \| null` | no | Every custom emoji the organization now has |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+| `event` | `Record<string, unknown> \| null` | no | The room event the write appended |
+
+**Example**
+
+```ts
+const result = await g8.api.work.addWorkCustomEmoji({ body: { shortcode: "example", url: "https://example.com" } });
+```
+
+---
+
+<a id="op-addworkpulsenote"></a>
+
+### `g8.api.work.addWorkPulseNote(input)`
+
+**Add Work Pulse Note**
+
+- HTTP: `POST /api/v1/work/pulse`
+- operationId: `add_work_pulse_note_work_pulse_post` (also callable as `g8.api.call("add_work_pulse_note_work_pulse_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Post one pulse update — the room's org-wide, channel-less status note.
+
+``replyToEventId`` threads it under an existing note.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkPulseNoteRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkPulseNoteRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content` | `string` | yes | min length 1, max length 2000 |
+| `body.replyToEventId` | `string \| null` | no | max length 128 |
+
+**Returns** `ApiResponse_WorkPulseNote_`: the envelope `{ data: WorkPulseNote, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkPulseNote` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+| `event` | `Record<string, unknown> \| null` | no | The room event carrying the note |
+
+**Example**
+
+```ts
+const result = await g8.api.work.addWorkPulseNote({ body: { content: "example" } });
+```
+
+---
+
+<a id="op-archiveworkagent"></a>
+
+### `g8.api.work.archiveWorkAgent(input)`
+
+**Archive Work Agent**
+
+- HTTP: `DELETE /api/v1/work/agents/{agent_id}`
+- operationId: `archive_work_agent_work_agents__agent_id__delete` (also callable as `g8.api.call("archive_work_agent_work_agents__agent_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `work:delete`
+
+Archive one Work agent. ``403`` unless the caller may edit it.
+
+The app answers ``204``; this answers ``200`` with the archived id so the
+response fits the Developer API envelope.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.agent_id` | `string (uuid)` | yes | Agent id |
+
+**Returns** `ApiResponse_WorkAgentArchived_`: the envelope `{ data: WorkAgentArchived, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentArchived` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agent_id` | `string` | yes | The agent that was archived |
+| `archived` | `boolean` | no | True once archived default `true` |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.work.archiveWorkAgent({ path: { agent_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-createworkagent"></a>
+
+### `g8.api.work.createWorkAgent(input)`
+
+**Create Work Agent**
+
+- HTTP: `POST /api/v1/work/agents`
+- operationId: `create_work_agent_work_agents_post` (also callable as `g8.api.call("create_work_agent_work_agents_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Create one Work agent and its conversation.
+
+``visibility: "organization"`` needs the share permission (see
+``GET /work/agents/policy``); ``403`` otherwise. Creating does not run it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkAgentProfileRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string (uuid) \| null` | no | Retry-safety key (a UUID). Replaying one returns the ORIGINAL agent instead of creating a second. Omit it and the server mints one, so a retried request creates again. |
+
+Body fields (`WorkAgentProfileRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.description` | `string` | yes | The agent's instructions min length 1, max length 20000 |
+| `body.name` | `string` | yes | Agent name min length 1, max length 100 |
+| `body.avatar` | `"spark" \| "compass" \| "chart" \| "code" \| "pen" \| "search" \| "shield" \| "bolt"` | no | Avatar glyph default `"spark"` |
+| `body.role` | `string` | no | Role shown beside the name default `"Assistant"`, min length 1, max length 100 |
+| `body.visibility` | `"private" \| "organization"` | no | `private` to its owner, or shared with the `organization` default `"private"` |
+
+**Returns** `ApiResponse_WorkAgentCreated_`: the envelope `{ data: WorkAgentCreated, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentCreated` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agent_id` | `string \| null` | no | Agent id |
+| `session_id` | `string \| null` | no | The agent's conversation session id |
+
+**Example**
+
+```ts
+const result = await g8.api.work.createWorkAgent({ body: { description: "example", name: "Example" } });
+```
+
+---
+
+<a id="op-createworkchannel"></a>
+
+### `g8.api.work.createWorkChannel(input)`
+
+**Create Work Channel**
+
+- HTTP: `POST /api/v1/work/channels`
+- operationId: `create_work_channel_work_channels_post` (also callable as `g8.api.call("create_work_channel_work_channels_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Create one Work channel.
+
+``409`` when the name is taken — a channel's slug IS its room address, so two
+channels cannot share one. ``422`` for a name or description that cannot be
+normalized, and for an unknown ``templateId``. ``templateId`` seats the
+template's specialists and seeds its Canvas.
+
+The creator comes from the authenticated principal. The body cannot express
+it: ``author``, ``actor_id``, ``org_id`` and ``createdBy`` are refused
+outright rather than ignored.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkChannelCreateRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkChannelCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | min length 1, max length 255 |
+| `body.description` | `string \| null` | no | max length 1000 |
+| `body.displayName` | `string \| null` | no | max length 255 |
+| `body.kind` | `"stream" \| "forum"` | no | default `"stream"` |
+| `body.memberUserIds` | `Array<string>` | no | max items 200 |
+| `body.participantAgentIds` | `Array<string>` | no | max items 16 |
+| `body.templateId` | `string \| null` | no | One of `work/channel_templates.py`'s ids. Seats its specialists and seeds its Canvas. |
+| `body.ttlSeconds` | `integer \| null` | no | A Temporary channel's lifetime in seconds; absent means Permanent. max 2147483647, > 0 |
+| `body.visibility` | `"open" \| "private"` | no | default `"open"` |
+
+**Returns** `ApiResponse_WorkChannelWriteResult_`: the envelope `{ data: WorkChannelWriteResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkChannelWriteResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `canvasSeeded` | `boolean \| null` | no | Present when `templateId` seeded a Canvas |
+| `channel` | `WorkChannel \| null` | no | The channel as stored after the write |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+
+**Example**
+
+```ts
+const result = await g8.api.work.createWorkChannel({ body: { name: "Example" } });
+```
+
+---
+
+<a id="op-createworkmessage"></a>
+
+### `g8.api.work.createWorkMessage(input)`
+
+**Create Work Message**
+
+- HTTP: `POST /api/v1/work/messages`
+- operationId: `create_work_message_work_messages_post` (also callable as `g8.api.call("create_work_message_work_messages_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Post one message into a conversation this credential may write to.
+
+``channel`` addresses the conversation — a channel name or id. Send either
+``message`` (plain text) or ``document`` (a rich-text document, normalized
+server-side so a hostile link never reaches storage), plus optional
+``attachmentIds``, ``mentionAgentIds`` and thread parents.
+
+``403`` when the caller is not a member of the channel — an organisation
+credential holds a seat in the built-in channels and nowhere else, so that
+is where it can post. ``404`` when no such conversation exists.
+
+Mentioning an agent starts an agent turn in the background, which is how a
+message gets answered; the send returns as soon as the message is stored.
+The author is resolved from the authenticated principal and the body cannot
+express one — ``author``, ``actor_id`` and ``org_id`` are refused outright.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkMessageCreateRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkMessageCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel` | `string` | yes | min length 1, max length 255 |
+| `body.attachmentIds` | `Array<string>` | no | max items 20 |
+| `body.document` | `Record<string, unknown> \| null` | no |  |
+| `body.mentionAgentIds` | `Array<string>` | no | max items 16 |
+| `body.mentionUserIds` | `Array<string>` | no | max items 64 |
+| `body.message` | `string \| null` | no | max length 12000 |
+| `body.parentMessageId` | `string \| null` | no | max length 128 |
+| `body.projectId` | `string \| null` | no | max length 255 |
+| `body.rootMessageId` | `string \| null` | no | max length 128 |
+
+**Returns** `ApiResponse_WorkMessage_`: the envelope `{ data: WorkMessage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `author` | `Record<string, unknown> \| null` | no | Resolved author — always the authenticated principal, never a request field |
+| `channel` | `string \| null` | no | Conversation address — a channel NAME or a direct-message id |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `document` | `Record<string, unknown> \| null` | no | Rich-text document, normalized server-side |
+| `id` | `string \| null` | no | Message id |
+| `text` | `string \| null` | no | Plain-text projection of the document |
+
+**Example**
+
+```ts
+const result = await g8.api.work.createWorkMessage({ body: { channel: "example" } });
+```
+
+---
+
+<a id="op-createworkproject"></a>
+
+### `g8.api.work.createWorkProject(input)`
+
+**Create Work Project**
+
+- HTTP: `POST /api/v1/work/projects`
+- operationId: `create_work_project_work_projects_post` (also callable as `g8.api.call("create_work_project_work_projects_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Create one project in one channel.
+
+``channel`` is the channel NAME. The channel is resolved and authorized
+exactly the way a send is, so a caller who may not post in a room may not
+attach durable state to it: ``403``. The project id, the creator and the
+room event come from the server; a body asserting them is refused by name.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkProjectCreateRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkProjectCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel` | `string` | yes | min length 1, max length 255 |
+| `body.name` | `string` | yes | min length 1, max length 500 |
+| `body.description` | `string \| null` | no | max length 2000 |
+| `body.status` | `"active" \| "paused" \| "completed" \| "archived"` | no | default `"active"` |
+
+**Returns** `ApiResponse_WorkProjectWriteResult_`: the envelope `{ data: WorkProjectWriteResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkProjectWriteResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `compatibilityEventId` | `string \| null` | no | Id of the room event the write appended |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result rather than writing again |
+| `project` | `WorkProject \| null` | no | The project as stored after the write |
+
+**Example**
+
+```ts
+const result = await g8.api.work.createWorkProject({ body: { channel: "example", name: "Example" } });
+```
+
+---
+
+<a id="op-createworkroutine"></a>
+
+### `g8.api.work.createWorkRoutine(input)`
+
+**Create Work Routine**
+
+- HTTP: `POST /api/v1/work/routines`
+- operationId: `create_work_routine_work_routines_post` (also callable as `g8.api.call("create_work_routine_work_routines_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Create one routine.
+
+``deliveryConversationId`` must be a conversation this credential can read —
+otherwise a routine would be a way to post into a room its author cannot
+see, and it is refused with the same ``403`` reading that room would give.
+
+``triggerKind: "schedule"`` takes ``weekdays`` + ``localTime`` + ``timezone``;
+``triggerKind: "event"`` takes a ``trigger`` config and an optional
+``eventPolicy`` instead. The creator comes from the authenticated principal.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkRoutineCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkRoutineCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agentId` | `string` | yes | Agent that runs the routine |
+| `body.deliveryConversationId` | `string` | yes | Conversation the routine posts into; must be readable by the caller |
+| `body.instruction` | `string` | yes | What the agent is asked to do each run |
+| `body.title` | `string` | yes | What the routine is called |
+| `body.enabled` | `boolean` | no | Whether the routine starts active default `true` |
+| `body.eventPolicy` | `Record<string, unknown> \| null` | no | Optional event-handling policy |
+| `body.localTime` | `string \| null` | no | Local run time `HH:MM`, for `schedule` routines |
+| `body.timezone` | `string` | no | IANA timezone the local time is read in default `"UTC"` |
+| `body.trigger` | `Record<string, unknown> \| null` | no | Trigger config, for `event` routines |
+| `body.triggerKind` | `string` | no | `schedule` or `event` default `"schedule"` |
+| `body.weekdays` | `Array<integer> \| null` | no | Days to run on (0-6), for `schedule` routines |
+
+**Returns** `ApiResponse_WorkRoutineEnvelope_`: the envelope `{ data: WorkRoutineEnvelope, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoutineEnvelope` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `routine` | `WorkRoutine` | yes | The routine as stored after the write |
+
+**Example**
+
+```ts
+const result = await g8.api.work.createWorkRoutine({
+  body: {
+    agentId: "example",
+    deliveryConversationId: "example",
+    instruction: "example",
+    title: "Example",
+  },
+});
+```
+
+---
+
+<a id="op-deleteworkchannel"></a>
+
+### `g8.api.work.deleteWorkChannel(input)`
+
+**Delete Work Channel**
+
+- HTTP: `DELETE /api/v1/work/channels/{channel_id}`
+- operationId: `delete_work_channel_work_channels__channel_id__delete` (also callable as `g8.api.call("delete_work_channel_work_channels__channel_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `work:delete`
+
+Delete one channel for everyone, leaving a non-restorable tombstone.
+
+``confirmationName`` must equal the channel's own slug. This is not
+reversible: the room's history stays as an audit record but nobody can read
+the channel again. The in-app surface spells this ``POST
+/v1/work/channels/{id}/delete``; the verb here is ``DELETE`` because that is
+what the operation is and what the scope derived for it means.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.channel_id` | `string` | yes | Channel id or slug |
+| `body` | `WorkChannelDeleteRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkChannelDeleteRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.confirmationName` | `string` | yes | min length 1, max length 255 |
+
+**Returns** `ApiResponse_WorkChannelWriteResult_`: the envelope `{ data: WorkChannelWriteResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkChannelWriteResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `canvasSeeded` | `boolean \| null` | no | Present when `templateId` seeded a Canvas |
+| `channel` | `WorkChannel \| null` | no | The channel as stored after the write |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.work.deleteWorkChannel({ path: { channel_id: "id" }, body: { confirmationName: "Example" } });
+```
+
+---
+
+<a id="op-deleteworkmessage"></a>
+
+### `g8.api.work.deleteWorkMessage(input)`
+
+**Delete Work Message**
+
+- HTTP: `DELETE /api/v1/work/messages/{message_id}`
+- operationId: `delete_work_message_work_messages__message_id__delete` (also callable as `g8.api.call("delete_work_message_work_messages__message_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `work:delete`
+
+Retract a message this credential authored. Soft, and safe to repeat.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.message_id` | `string` | yes | Message id |
+
+**Returns** `ApiResponse_WorkMessage_`: the envelope `{ data: WorkMessage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `author` | `Record<string, unknown> \| null` | no | Resolved author — always the authenticated principal, never a request field |
+| `channel` | `string \| null` | no | Conversation address — a channel NAME or a direct-message id |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `document` | `Record<string, unknown> \| null` | no | Rich-text document, normalized server-side |
+| `id` | `string \| null` | no | Message id |
+| `text` | `string \| null` | no | Plain-text projection of the document |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.work.deleteWorkMessage({ path: { message_id: "id" } });
+```
+
+---
+
+<a id="op-deleteworkproject"></a>
+
+### `g8.api.work.deleteWorkProject(input)`
+
+**Delete Work Project**
+
+- HTTP: `DELETE /api/v1/work/projects/{project_id}`
+- operationId: `delete_work_project_work_projects__project_id__delete` (also callable as `g8.api.call("delete_work_project_work_projects__project_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `work:delete`
+
+Tombstone one project. Its conversation survives.
+
+``403`` unless the caller created it or holds Owner/Admin. The response
+names what SURVIVES: the project's messages and action receipts are kept
+and counted. Repeating the call is safe. The optional body carries only an
+audit ``reason``; omitting it records ``user_requested``, as the app does.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.project_id` | `string` | yes | Project id |
+| `body` | `WorkProjectDeleteRequest \| null` | no | Request body; fields below. |
+
+Body fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.reason` | `string` | no | default `"user_requested"`, min length 1, max length 500 |
+
+**Returns** `ApiResponse_WorkProjectDeleted_`: the envelope `{ data: WorkProjectDeleted, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkProjectDeleted` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `action_receipts_preserved` | `integer \| null` | no | Action receipts KEPT, for the same reason |
+| `deleted` | `boolean \| null` | no | True once the tombstone is in place |
+| `deleted_at` | `string \| null` | no | When the tombstone was written |
+| `messages_preserved` | `integer \| null` | no | Messages KEPT: deleting a project does not delete its conversation |
+| `project_id` | `string \| null` | no | The project that was tombstoned |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.work.deleteWorkProject({ path: { project_id: "id" } });
+```
+
+---
+
+<a id="op-deleteworkroutine"></a>
+
+### `g8.api.work.deleteWorkRoutine(input)`
+
+**Delete Work Routine**
+
+- HTTP: `DELETE /api/v1/work/routines/{routine_id}`
+- operationId: `delete_work_routine_work_routines__routine_id__delete` (also callable as `g8.api.call("delete_work_routine_work_routines__routine_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `work:delete`
+
+Delete one routine. Same guard as changing it: the delivery conversation decides.
+
+Answers ``200`` with the deleted id rather than the in-app ``204``: every
+Developer API operation returns the same ``{"data": ...}`` envelope, and one
+route with no body is the exception every generated client has to special-case.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.routine_id` | `string (uuid)` | yes | Routine id |
+
+**Returns** `ApiResponse_WorkRoutineDeleted_`: the envelope `{ data: WorkRoutineDeleted, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoutineDeleted` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes | The routine that was deleted |
+| `deleted` | `boolean` | no | Always true; the operation is idempotent default `true` |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.work.deleteWorkRoutine({ path: { routine_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-editworkmemory"></a>
+
+### `g8.api.work.editWorkMemory(input)`
+
+**Edit Work Memory**
+
+- HTTP: `PUT /api/v1/work/memory`
+- operationId: `edit_work_memory_work_memory_put` (also callable as `g8.api.call("edit_work_memory_work_memory_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Replace one memory topic. ``expected_revision`` is a compare-and-swap; stale is ``409``.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkMemoryEditRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkMemoryEditRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content` | `string` | yes | The new content max length 49152 |
+| `body.expected_revision` | `string \| null` | yes | The `revision` you read, or null when the topic is new pattern `^[a-f0-9]{64}$` |
+| `body.topic` | `"profile" \| "goals" \| "decisions" \| "feedback" \| "corrections" \| "entities"` | yes | The topic to replace |
+| `body.agent_id` | `string (uuid) \| null` | no | Required for, and only for, `agent` scope |
+| `body.scope` | `"personal" \| "agent" \| "team"` | no | `personal`, `agent` or `team` default `"personal"` |
+
+**Returns** `ApiResponse_WorkMemoryNote_`: the envelope `{ data: WorkMemoryNote, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMemoryNote` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `content` | `string \| null` | no | Content |
+| `revision` | `string \| null` | no | Revision; send it back to edit or move |
+| `size_bytes` | `integer \| null` | no | Stored size |
+| `topic` | `string \| null` | no | Topic |
+| `updated_at` | `string \| null` | no | Last write time |
+
+**Example**
+
+```ts
+const result = await g8.api.work.editWorkMemory({
+  body: { content: "example", expected_revision: "example", topic: "profile" },
+});
+```
+
+---
+
+<a id="op-editworkmessage"></a>
+
+### `g8.api.work.editWorkMessage(input)`
+
+**Edit Work Message**
+
+- HTTP: `PATCH /api/v1/work/messages/{message_id}`
+- operationId: `edit_work_message_work_messages__message_id__patch` (also callable as `g8.api.call("edit_work_message_work_messages__message_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Correct a message this credential authored.
+
+Deliberately not a re-send: no agent turn runs again and nobody is notified,
+so an agent that already acted on the first wording is not run twice. Pass
+``expected_revision`` to make the edit conditional on the version you read.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.message_id` | `string` | yes | Message id |
+| `body` | `WorkMessageEditRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkMessageEditRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.document` | `Record<string, unknown> \| null` | no |  |
+| `body.expected_revision` | `integer` | no | default `1`, min 1 |
+| `body.text` | `string \| null` | no | max length 12000 |
+
+**Returns** `ApiResponse_WorkMessage_`: the envelope `{ data: WorkMessage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `author` | `Record<string, unknown> \| null` | no | Resolved author — always the authenticated principal, never a request field |
+| `channel` | `string \| null` | no | Conversation address — a channel NAME or a direct-message id |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `document` | `Record<string, unknown> \| null` | no | Rich-text document, normalized server-side |
+| `id` | `string \| null` | no | Message id |
+| `text` | `string \| null` | no | Plain-text projection of the document |
+
+**Example**
+
+```ts
+const result = await g8.api.work.editWorkMessage({ path: { message_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-forwardworkmessage"></a>
+
+### `g8.api.work.forwardWorkMessage(input)`
+
+**Forward Work Message**
+
+- HTTP: `POST /api/v1/work/messages/{message_id}/forward`
+- operationId: `forward_work_message_work_messages__message_id__forward_post` (also callable as `g8.api.call("forward_work_message_work_messages__message_id__forward_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Copy one message into another conversation, keeping its source attribution.
+
+Both ends are checked: the caller must be able to read the original and to
+write into the destination, so forwarding can never move content into a room
+its author could not have posted in.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.message_id` | `string` | yes | Message id |
+| `body` | `WorkMessageForwardRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkMessageForwardRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel` | `string` | yes | min length 1, max length 255 |
+
+**Returns** `ApiResponse_WorkMessage_`: the envelope `{ data: WorkMessage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `author` | `Record<string, unknown> \| null` | no | Resolved author — always the authenticated principal, never a request field |
+| `channel` | `string \| null` | no | Conversation address — a channel NAME or a direct-message id |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `document` | `Record<string, unknown> \| null` | no | Rich-text document, normalized server-side |
+| `id` | `string \| null` | no | Message id |
+| `text` | `string \| null` | no | Plain-text projection of the document |
+
+**Example**
+
+```ts
+const result = await g8.api.work.forwardWorkMessage({ path: { message_id: "id" }, body: { channel: "example" } });
+```
+
+---
+
+<a id="op-getworkagent"></a>
+
+### `g8.api.work.getWorkAgent(input)`
+
+**Get Work Agent**
+
+- HTTP: `GET /api/v1/work/agents/{agent_id}`
+- operationId: `get_work_agent_work_agents__agent_id__get` (also callable as `g8.api.call("get_work_agent_work_agents__agent_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+One Work agent. ``403`` when it is another person's private agent.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.agent_id` | `string (uuid)` | yes | Agent id |
+
+**Returns** `ApiResponse_WorkAgentProfile_`: the envelope `{ data: WorkAgentProfile, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentProfile` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agent_id` | `string \| null` | no | Agent id |
+| `avatar` | `string \| null` | no | Avatar glyph |
+| `can_edit` | `boolean \| null` | no | Whether this caller may edit it |
+| `description` | `string \| null` | no | Instructions |
+| `name` | `string \| null` | no | Agent name |
+| `owner_id` | `string \| null` | no | Owner identity |
+| `role` | `string \| null` | no | Role |
+| `updated_at` | `string \| null` | no | Last edit time |
+| `version` | `integer \| null` | no | Profile version; send it back to edit |
+| `visibility` | `string \| null` | no | `private` or `organization` |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkAgent({ path: { agent_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-getworkagentpolicy"></a>
+
+### `g8.api.work.getWorkAgentPolicy(input?)`
+
+**Get Work Agent Policy**
+
+- HTTP: `GET /api/v1/work/agents/policy`
+- operationId: `get_work_agent_policy_work_agents_policy_get` (also callable as `g8.api.call("get_work_agent_policy_work_agents_policy_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+What this caller may do with Work agents: create a private one, share one org-wide.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkAgentPolicy_`: the envelope `{ data: WorkAgentPolicy, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentPolicy` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `can_create` | `boolean \| null` | no | May create a private agent |
+| `can_share_organization` | `boolean \| null` | no | May create an organization-wide agent |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkAgentPolicy();
+```
+
+---
+
+<a id="op-getworkattachmentlink"></a>
+
+### `g8.api.work.getWorkAttachmentLink(input)`
+
+**Get Work Attachment Link**
+
+- HTTP: `GET /api/v1/work/attachments/{attachment_id}`
+- operationId: `get_work_attachment_link_work_attachments__attachment_id__get` (also callable as `g8.api.call("get_work_attachment_link_work_attachments__attachment_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Authorize this credential for one attachment, then mint a short-lived link.
+
+Being authenticated is not permission: an attachment id is a UUID in a URL,
+and "holds a key" would otherwise make every file in the organization
+readable. A caller may read an attachment carried by a message in a
+conversation they can see. A missing attachment and an unreadable one both
+answer ``404``, so this cannot be used to probe which ids exist.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.attachment_id` | `string` | yes | Attachment id |
+| `query.download` | `boolean` | no | Force a download rather than inline rendering default `false` |
+
+**Returns** `ApiResponse_WorkAttachmentLink_`: the envelope `{ data: WorkAttachmentLink, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAttachmentLink` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `expires_in` | `integer` | yes | Seconds until the URL stops working |
+| `url` | `string` | yes | Time-limited download URL |
+| `attachment` | `Record<string, unknown>` | no | Stored attachment metadata |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkAttachmentLink({ path: { attachment_id: "id" } });
+```
+
+---
+
+<a id="op-getworkchannelcanvas"></a>
+
+### `g8.api.work.getWorkChannelCanvas(input)`
+
+**Get Work Channel Canvas**
+
+- HTTP: `GET /api/v1/work/channels/{channel_id}/canvas`
+- operationId: `get_work_channel_canvas_work_channels__channel_id__canvas_get` (also callable as `g8.api.call("get_work_channel_canvas_work_channels__channel_id__canvas_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+One channel's Canvas, to a caller entitled to that channel.
+
+``403`` when the caller may not read the channel — the same rule that
+decides its messages, so a room cannot be readable on one half and refused
+on the other. A channel with no Canvas answers an empty one rather than 404.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.channel_id` | `string` | yes | Channel id or slug |
+
+**Returns** `ApiResponse_WorkCanvas_`: the envelope `{ data: WorkCanvas, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkCanvas` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channelId` | `string \| null` | no | Channel the canvas belongs to |
+| `content` | `string \| null` | no | Canvas content |
+| `revisionId` | `string \| null` | no | Current revision id |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkChannelCanvas({ path: { channel_id: "id" } });
+```
+
+---
+
+<a id="op-getworkdailybrief"></a>
+
+### `g8.api.work.getWorkDailyBrief(input?)`
+
+**Get Work Daily Brief**
+
+- HTTP: `GET /api/v1/work/preferences/daily-brief`
+- operationId: `get_work_daily_brief_work_preferences_daily_brief_get` (also callable as `g8.api.call("get_work_daily_brief_work_preferences_daily_brief_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+THIS principal's daily-brief schedule, plus when the next one is due and why.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkDailyBriefSettings_`: the envelope `{ data: WorkDailyBriefSettings, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkDailyBriefSettings` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `settings` | `Record<string, unknown> \| null` | no | The stored schedule |
+| `status` | `Record<string, unknown> \| null` | no | Delivery status (`latestBrief`, `lastBriefDate`, `nextDueAt`, `reason`). Returned on the read only; null on the write |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkDailyBrief();
+```
+
+---
+
+<a id="op-getworkinboxdispositions"></a>
+
+### `g8.api.work.getWorkInboxDispositions(input?)`
+
+**Get Work Inbox Dispositions**
+
+- HTTP: `GET /api/v1/work/inbox-dispositions`
+- operationId: `get_work_inbox_dispositions_work_inbox_dispositions_get` (also callable as `g8.api.call("get_work_inbox_dispositions_work_inbox_dispositions_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+THIS principal's Inbox states, keyed by conversation. Never anybody else's.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkInboxDispositions_`: the envelope `{ data: WorkInboxDispositions, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkInboxDispositions` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `dispositions` | `Record<string, unknown> \| null` | no | Conversation key -> `active`, `snoozed` or `archived` |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkInboxDispositions();
+```
+
+---
+
+<a id="op-getworkmemory"></a>
+
+### `g8.api.work.getWorkMemory(input?)`
+
+**Get Work Memory**
+
+- HTTP: `GET /api/v1/work/memory`
+- operationId: `get_work_memory_work_memory_get` (also callable as `g8.api.call("get_work_memory_work_memory_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Every topic in one memory scope, and whether this caller may edit it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.scope` | `"personal" \| "agent" \| "team"` | no | `personal`, `agent` or `team` default `"personal"` |
+| `query.agent_id` | `string (uuid) \| null` | no | Required for, and only for, `agent` scope |
+
+**Returns** `ApiResponse_WorkMemoryPage_`: the envelope `{ data: WorkMemoryPage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMemoryPage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agent_id` | `string \| null` | no | The agent, for `agent` scope |
+| `can_edit` | `boolean \| null` | no | Whether this caller may edit this scope |
+| `entries` | `Array<WorkMemoryNote> \| null` | no | The topics |
+| `scope` | `string \| null` | no | The scope read |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkMemory();
+```
+
+---
+
+<a id="op-getworkmessage"></a>
+
+### `g8.api.work.getWorkMessage(input)`
+
+**Get Work Message**
+
+- HTTP: `GET /api/v1/work/messages/{message_id}`
+- operationId: `get_work_message_work_messages__message_id__get` (also callable as `g8.api.call("get_work_message_work_messages__message_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+One message, if this credential may read the conversation carrying it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.message_id` | `string` | yes | Message id |
+
+**Returns** `ApiResponse_WorkMessage_`: the envelope `{ data: WorkMessage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `author` | `Record<string, unknown> \| null` | no | Resolved author — always the authenticated principal, never a request field |
+| `channel` | `string \| null` | no | Conversation address — a channel NAME or a direct-message id |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `document` | `Record<string, unknown> \| null` | no | Rich-text document, normalized server-side |
+| `id` | `string \| null` | no | Message id |
+| `text` | `string \| null` | no | Plain-text projection of the document |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkMessage({ path: { message_id: "id" } });
+```
+
+---
+
+<a id="op-getworkoversight"></a>
+
+### `g8.api.work.getWorkOversight(input?)`
+
+**Get Work Oversight**
+
+- HTTP: `GET /api/v1/work/oversight`
+- operationId: `get_work_oversight_work_oversight_get` (also callable as `g8.api.call("get_work_oversight_work_oversight_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+What needs a person: pending approvals, blocked work and unattended fixes.
+
+Read-only, and read from the canonical approval and work-item tables rather
+than from relay events. Each group carries its own state, so an empty list
+always says which of "nothing here", "we could not find out" and "nothing is
+recorded for this workspace" it means. Deciding an approval is not part of
+this surface — see the module docstring.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | Maximum rows PER GROUP default `50` |
+| `query.fix_window_hours` | `integer` | no | How far back autonomous fixes are read default `24` |
+
+**Returns** `ApiResponse_WorkOversight_`: the envelope `{ data: WorkOversight, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkOversight();
+```
+
+---
+
+<a id="op-getworkreadmarkers"></a>
+
+### `g8.api.work.getWorkReadMarkers(input?)`
+
+**Get Work Read Markers**
+
+- HTTP: `GET /api/v1/work/read-markers`
+- operationId: `get_work_read_markers_work_read_markers_get` (also callable as `g8.api.call("get_work_read_markers_work_read_markers_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+How far THIS principal has read each conversation. Never anybody else's.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkReadMarkers_`: the envelope `{ data: WorkReadMarkers, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkReadMarkers` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `markers` | `Record<string, unknown> \| null` | no | Conversation key -> the point this principal has read to |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkReadMarkers();
+```
+
+---
+
+<a id="op-getworkroom"></a>
+
+### `g8.api.work.getWorkRoom(input?)`
+
+**Get Work Room**
+
+- HTTP: `GET /api/v1/work/room`
+- operationId: `get_work_room_work_room_get` (also callable as `g8.api.call("get_work_room_work_room_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The whole Work room this credential may read, in one call.
+
+Channels, conversations, recent messages and events, the member directory
+and the agent roster — narrowed to the caller's own audience and bounded to
+the recent end of history. ``truncation`` names what was left out and
+carries the cursor to resume each conversation from at
+``GET /work/conversations/{conversation_id}/messages``.
+
+For an organisation credential that audience is the built-in channels; see
+the module docstring for why, and for what it is not.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkRoom_`: the envelope `{ data: WorkRoom, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoom` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agents` | `Array<Record<string, unknown>> \| null` | no | Agent roster available in this workspace |
+| `counts` | `Record<string, unknown> \| null` | no | Per-collection counts of what the caller can see |
+| `members` | `Array<Record<string, unknown>> \| null` | no | Organization member directory, for turning an actor id into a name |
+| `room` | `Record<string, unknown> \| null` | no | Channels, direct messages, messages, events and per-viewer state the caller may read |
+| `truncation` | `Record<string, unknown> \| null` | no | What was left out of the bounded read, and the cursors to resume from |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkRoom();
+```
+
+---
+
+<a id="op-getworkteamhistory"></a>
+
+### `g8.api.work.getWorkTeamHistory(input?)`
+
+**Get Work Team History**
+
+- HTTP: `GET /api/v1/work/team-hq/history`
+- operationId: `get_work_team_history_work_team_hq_history_get` (also callable as `g8.api.call("get_work_team_history_work_team_hq_history_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Per-rep daily series behind the board. A null day was not measured; it is not zero.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Window size in days; clamped to 3-31 default `7` |
+
+**Returns** `ApiResponse_WorkTeamHqHistory_`: the envelope `{ data: WorkTeamHqHistory, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkTeamHqHistory` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `days` | `Array<string> \| null` | no | The dates in the window, oldest first |
+| `reps` | `Array<Record<string, unknown>> \| null` | no | Per-rep series; null for a day that was not measured (a gap is not a zero) |
+| `source` | `string \| null` | no | `live`, `cached` or `unavailable` |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkTeamHistory();
+```
+
+---
+
+<a id="op-getworkteamleaderboard"></a>
+
+### `g8.api.work.getWorkTeamLeaderboard(input?)`
+
+**Get Work Team Leaderboard**
+
+- HTTP: `GET /api/v1/work/team-hq/leaderboard`
+- operationId: `get_work_team_leaderboard_work_team_hq_leaderboard_get` (also callable as `g8.api.call("get_work_team_leaderboard_work_team_hq_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The Team HQ board over the organization's own SDR analytics.
+
+``source`` is the honesty field: ``live``, ``cached``, ``partial`` (then
+``degradedMetrics`` names the columns that failed, ABSENT from every row
+rather than zero) or ``unavailable`` (``rows`` empty on purpose).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.period` | `"day" \| "month"` | no | `day` or `month` default `"day"` |
+
+**Returns** `ApiResponse_WorkTeamHqLeaderboard_`: the envelope `{ data: WorkTeamHqLeaderboard, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkTeamHqLeaderboard` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `degradedMetrics` | `Array<string> \| null` | no | Columns that failed to measure; absent from every row rather than zero |
+| `generatedAt` | `string \| null` | no | When this response was built |
+| `goals` | `Record<string, unknown> \| null` | no | Per role-group goals, or null |
+| `measuredAt` | `string \| null` | no | When the rows were measured; null when unavailable |
+| `period` | `string \| null` | no | `day` or `month` |
+| `rows` | `Array<Record<string, unknown>> \| null` | no | One row per rep |
+| `source` | `string \| null` | no | `live`, `cached`, `partial` or `unavailable` |
+
+**Example**
+
+```ts
+const result = await g8.api.work.getWorkTeamLeaderboard();
+```
+
+---
+
+<a id="op-listavailableworkchannels"></a>
+
+### `g8.api.work.listAvailableWorkChannels(input?)`
+
+**List Available Work Channels**
+
+- HTTP: `GET /api/v1/work/channels/available`
+- operationId: `list_available_work_channels_work_channels_available_get` (also callable as `g8.api.call("list_available_work_channels_work_channels_available_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The organization's channels this credential is not part of.
+
+The channel browser. An ``open`` channel carries its description and member
+count; a ``private`` one answers with identity only, so a room nobody here
+belongs to is listed without leaking anything about it. Built-ins and
+archived channels are absent.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkAvailableChannelList_`: the envelope `{ data: WorkAvailableChannelList, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAvailableChannelList` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channels` | `Array<WorkAvailableChannel>` | no | Channels the caller is not part of |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listAvailableWorkChannels();
+```
+
+---
+
+<a id="op-listworkactivity"></a>
+
+### `g8.api.work.listWorkActivity(input?)`
+
+**List Work Activity**
+
+- HTTP: `GET /api/v1/work/activity`
+- operationId: `list_work_activity_work_activity_get` (also callable as `g8.api.call("list_work_activity_work_activity_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+What happened in Work, newest first, scoped to what this credential may read.
+
+One row per consequential act — a message sent, a conversation created, an
+approval decided, an execution finished. Filterable by actor kind, agent,
+category, conversation, consequence, time window and free text.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer \| null` | no | Page size; clamped to the server maximum |
+| `query.cursor` | `string \| null` | no | Opaque cursor from a previous page |
+| `query.actor` | `string \| null` | no | `human`, `agent`, `runner` or `system` |
+| `query.agentId` | `string \| null` | no | Only this agent's activity |
+| `query.category` | `string \| null` | no | message, conversation, approval, execution, workflow, canvas or configuration |
+| `query.conversation` | `string \| null` | no | Only this conversation |
+| `query.consequence` | `string \| null` | no | requested, changed, approved, completed, failed or recorded |
+| `query.from` | `string \| null` | no | ISO timestamp; inclusive lower bound |
+| `query.to` | `string \| null` | no | ISO timestamp; inclusive upper bound |
+| `query.q` | `string \| null` | no | Free text |
+
+**Returns** `ApiResponse_WorkActivityPage_`: the envelope `{ data: WorkActivityPage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkActivityPage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `events` | `Array<WorkActivityEntry>` | no | Activity entries, newest first |
+| `has_more` | `boolean` | no | Whether older entries remain default `false` |
+| `next_cursor` | `string \| null` | no | Opaque cursor for the next page |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkActivity();
+```
+
+---
+
+<a id="op-listworkagentexecutionidentities"></a>
+
+### `g8.api.work.listWorkAgentExecutionIdentities(input?)`
+
+**List Work Agent Execution Identities**
+
+- HTTP: `GET /api/v1/work/agents/execution-identities`
+- operationId: `list_work_agent_execution_identities_work_agents_execution_identities_get` (also callable as `g8.api.call("list_work_agent_execution_identities_work_agents_execution_identities_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The agent identities this caller may run work as.
+
+A source that could not be read degrades to a ``warnings`` entry rather than
+failing the list, as in the app.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkAgentExecutionIdentities_`: the envelope `{ data: WorkAgentExecutionIdentities, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentExecutionIdentities` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<Record<string, unknown>> \| null` | no | Execution identities |
+| `warnings` | `Array<string> \| null` | no | Identities that could not be resolved |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkAgentExecutionIdentities();
+```
+
+---
+
+<a id="op-listworkagents"></a>
+
+### `g8.api.work.listWorkAgents(input?)`
+
+**List Work Agents**
+
+- HTTP: `GET /api/v1/work/agents`
+- operationId: `list_work_agents_work_agents_get` (also callable as `g8.api.call("list_work_agents_work_agents_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The Work agents this caller may see: their own and the organization's shared ones.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | Page size default `50` |
+| `query.after` | `string (uuid) \| null` | no | `next_cursor` from the previous page |
+
+**Returns** `ApiResponse_WorkAgentProfilePage_`: the envelope `{ data: WorkAgentProfilePage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentProfilePage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<WorkAgentProfile>` | no | Agents on this page |
+| `next_cursor` | `string \| null` | no | Pass as `after` for the next page |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkAgents();
+```
+
+---
+
+<a id="op-listworkchannels"></a>
+
+### `g8.api.work.listWorkChannels(input?)`
+
+**List Work Channels**
+
+- HTTP: `GET /api/v1/work/channels`
+- operationId: `list_work_channels_work_channels_get` (also callable as `g8.api.call("list_work_channels_work_channels_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The channels this credential may read.
+
+The cheap half of ``GET /work/room``: membership only, no message or event
+history. Decided by ``room_visibility.visible_room`` — the same predicate
+the room read and the realtime socket run — so a channel can never be listed
+here and refused there.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkChannelList_`: the envelope `{ data: WorkChannelList, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkChannelList` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channels` | `Array<WorkChannel>` | no | Channels visible to the caller |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkChannels();
+```
+
+---
+
+<a id="op-listworkconversationevents"></a>
+
+### `g8.api.work.listWorkConversationEvents(input)`
+
+**List Work Conversation Events**
+
+- HTTP: `GET /api/v1/work/conversations/{conversation_id}/events`
+- operationId: `list_work_conversation_events_work_conversations__conversation_id__events_get` (also callable as `g8.api.call("list_work_conversation_events_work_conversations__conversation_id__events_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Page one conversation's chat events, newest first.
+
+The twin of the message page, and not redundant with it: some Work history
+exists only as an event and has no message row at all, so a client told
+``truncation.events`` needs this route to fetch what it lost. Same
+authorization, same cursor encoding.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.conversation_id` | `string` | yes | Channel name, channel id, or direct-message id |
+| `query.limit` | `integer` | no | Page size; clamped to the server maximum default `50` |
+| `query.cursor` | `string \| null` | no | Opaque cursor from a previous page |
+
+**Returns** `ApiResponse_WorkEventPage_`: the envelope `{ data: WorkEventPage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkEventPage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `conversation_id` | `string` | yes | The conversation these events belong to |
+| `cleared_behind` | `boolean \| null` | no | True when the caller's own clear watermark hides everything older |
+| `events` | `Array<WorkEvent>` | no | Events the caller may read |
+| `has_more` | `boolean` | no | Whether older stored rows remain default `false` |
+| `next_cursor` | `string \| null` | no | Opaque cursor for the next page |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkConversationEvents({ path: { conversation_id: "id" } });
+```
+
+---
+
+<a id="op-listworkconversationfiles"></a>
+
+### `g8.api.work.listWorkConversationFiles(input)`
+
+**List Work Conversation Files**
+
+- HTTP: `GET /api/v1/work/conversations/{conversation_id}/files`
+- operationId: `list_work_conversation_files_work_conversations__conversation_id__files_get` (also callable as `g8.api.call("list_work_conversation_files_work_conversations__conversation_id__files_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The messages in one conversation that carry files, newest first.
+
+Shared-file history uses exactly the conversation's live read permissions —
+losing access to a room loses access to what was shared in it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.conversation_id` | `string` | yes | Channel name, channel id, or direct-message id |
+| `query.limit` | `integer` | no | Page size; clamped to the server maximum default `50` |
+| `query.cursor` | `string \| null` | no | Opaque cursor from a previous page |
+| `query.query` | `string` | no | Filter by filename default `""` |
+
+**Returns** `ApiResponse_WorkMessagePage_`: the envelope `{ data: WorkMessagePage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessagePage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `conversation_id` | `string` | yes | The conversation these messages belong to |
+| `cleared_behind` | `boolean \| null` | no | True when the caller's own clear watermark hides everything older |
+| `has_more` | `boolean` | no | Whether older stored rows remain default `false` |
+| `messages` | `Array<WorkMessage>` | no | Messages the caller may read |
+| `next_cursor` | `string \| null` | no | Opaque cursor for the next page |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkConversationFiles({ path: { conversation_id: "id" } });
+```
+
+---
+
+<a id="op-listworkconversationmessages"></a>
+
+### `g8.api.work.listWorkConversationMessages(input)`
+
+**List Work Conversation Messages**
+
+- HTTP: `GET /api/v1/work/conversations/{conversation_id}/messages`
+- operationId: `list_work_conversation_messages_work_conversations__conversation_id__messages_get` (also callable as `g8.api.call("list_work_conversation_messages_work_conversations__conversation_id__messages_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Page one conversation's messages, newest first.
+
+Authorization happens before a single message is read, and an unreadable id
+and an unknown id produce the same ``403`` on purpose: handing back an empty
+page for a conversation the caller may not see would still confirm it
+exists.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.conversation_id` | `string` | yes | Channel name, channel id, or direct-message id |
+| `query.limit` | `integer` | no | Page size; clamped to the server maximum default `50` |
+| `query.cursor` | `string \| null` | no | Opaque cursor from a previous page |
+
+**Returns** `ApiResponse_WorkMessagePage_`: the envelope `{ data: WorkMessagePage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessagePage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `conversation_id` | `string` | yes | The conversation these messages belong to |
+| `cleared_behind` | `boolean \| null` | no | True when the caller's own clear watermark hides everything older |
+| `has_more` | `boolean` | no | Whether older stored rows remain default `false` |
+| `messages` | `Array<WorkMessage>` | no | Messages the caller may read |
+| `next_cursor` | `string \| null` | no | Opaque cursor for the next page |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkConversationMessages({ path: { conversation_id: "id" } });
+```
+
+---
+
+<a id="op-listworkitemhistory"></a>
+
+### `g8.api.work.listWorkItemHistory(input?)`
+
+**List Work Item History**
+
+- HTTP: `GET /api/v1/work/work-items/history`
+- operationId: `list_work_item_history_work_work_items_history_get` (also callable as `g8.api.call("list_work_item_history_work_work_items_history_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Agent work that has ENDED — completed, failed or cancelled, newest first.
+
+Same table and the same visibility scope as ``GET /work/work-items``; each
+row adds ``sessionId`` when a chat session is bound to it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | Maximum rows returned default `50` |
+
+**Returns** `ApiResponse_WorkItemList_`: the envelope `{ data: WorkItemList, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkItemList` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `work_items` | `Array<WorkItem>` | no | Work items visible to the caller |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkItemHistory();
+```
+
+---
+
+<a id="op-listworkitems"></a>
+
+### `g8.api.work.listWorkItems(input?)`
+
+**List Work Items**
+
+- HTTP: `GET /api/v1/work/work-items`
+- operationId: `list_work_items_work_work_items_get` (also callable as `g8.api.call("list_work_items_work_work_items_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Agent work that is RUNNING.
+
+The in-flight half of the All Work board. An organisation credential owns no
+individual's items, so it sees the organization's shared rows — the same
+answer the identity filter gives any principal with no personal identity.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | Maximum rows returned default `50` |
+
+**Returns** `ApiResponse_WorkItemList_`: the envelope `{ data: WorkItemList, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkItemList` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `work_items` | `Array<WorkItem>` | no | Work items visible to the caller |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkItems();
+```
+
+---
+
+<a id="op-listworkrecentactivity"></a>
+
+### `g8.api.work.listWorkRecentActivity(input?)`
+
+**List Work Recent Activity**
+
+- HTTP: `GET /api/v1/work/team-hq/recent-activity`
+- operationId: `list_work_recent_activity_work_team_hq_recent_activity_get` (also callable as `g8.api.call("list_work_recent_activity_work_team_hq_recent_activity_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+The Team HQ ticker's recent moments for this organization, newest first.
+
+A different feed from ``GET /work/activity`` (the room's own history): this
+is the org-wide revenue ticker, read from an org-scoped key, so another
+organization's log is unreachable by construction.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkTickerEvents_`: the envelope `{ data: WorkTickerEvents, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkTickerEvents` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `events` | `Array<Record<string, unknown>> \| null` | no | Moments, newest first |
+| `source` | `string \| null` | no | `live` for the receipts drill-down |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkRecentActivity();
+```
+
+---
+
+<a id="op-listworkroutineruns"></a>
+
+### `g8.api.work.listWorkRoutineRuns(input)`
+
+**List Work Routine Runs**
+
+- HTTP: `GET /api/v1/work/routines/{routine_id}/runs`
+- operationId: `list_work_routine_runs_work_routines__routine_id__runs_get` (also callable as `g8.api.call("list_work_routine_runs_work_routines__routine_id__runs_get", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `work:run`
+
+The run ledger for one routine: telemetry only, newest first.
+
+A plain list. It is named in ``READ_ONLY_ACTIVE_GET_ROUTES`` so the scope
+generator's ``/run`` marker does not escalate reading history into
+triggering work.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.routine_id` | `string (uuid)` | yes | Routine id |
+| `query.limit` | `integer` | no | Maximum runs returned default `25` |
+
+**Returns** `ApiResponse_WorkRoutineRunList_`: the envelope `{ data: WorkRoutineRunList, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoutineRunList` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `runs` | `Array<WorkRoutineRun>` | no | Runs, newest first |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.work.listWorkRoutineRuns({ path: { routine_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-listworkroutines"></a>
+
+### `g8.api.work.listWorkRoutines(input?)`
+
+**List Work Routines**
+
+- HTTP: `GET /api/v1/work/routines`
+- operationId: `list_work_routines_work_routines_get` (also callable as `g8.api.call("list_work_routines_work_routines_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Every routine in this organization's workspace, with its recent run activity.
+
+A routine is a standing instruction to an agent, delivered into one
+conversation, on a schedule or on an event. ``503`` when the workspace has
+never been provisioned to hold routines — nothing the caller sent is wrong.
+
+**Input**: none.
+
+**Returns** `ApiResponse_WorkRoutineList_`: the envelope `{ data: WorkRoutineList, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoutineList` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `routines` | `Array<WorkRoutine>` | no | Routines, with recent event activity folded in |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkRoutines();
+```
+
+---
+
+<a id="op-listworkteamreceipts"></a>
+
+### `g8.api.work.listWorkTeamReceipts(input)`
+
+**List Work Team Receipts**
+
+- HTTP: `GET /api/v1/work/team-hq/receipts`
+- operationId: `list_work_team_receipts_work_team_hq_receipts_get` (also callable as `g8.api.call("list_work_team_receipts_work_team_hq_receipts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+One rep's recent ticker moments, newest first. ``400`` for a malformed email.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.email` | `string` | yes | The rep whose recent moments to list |
+| `query.limit` | `integer` | no | Max events; clamped to 1-50 default `20` |
+
+**Returns** `ApiResponse_WorkTickerEvents_`: the envelope `{ data: WorkTickerEvents, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkTickerEvents` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `events` | `Array<Record<string, unknown>> \| null` | no | Moments, newest first |
+| `source` | `string \| null` | no | `live` for the receipts drill-down |
+
+**Example**
+
+```ts
+const result = await g8.api.work.listWorkTeamReceipts({ query: { email: "jane@acme.com" } });
+```
+
+---
+
+<a id="op-moveworkmemory"></a>
+
+### `g8.api.work.moveWorkMemory(input)`
+
+**Move Work Memory**
+
+- HTTP: `POST /api/v1/work/memory/move`
+- operationId: `move_work_memory_work_memory_move_post` (also callable as `g8.api.call("move_work_memory_work_memory_move_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Move one topic between scopes, guarded by both sides' revisions.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkMemoryMoveRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkMemoryMoveRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.destination` | `WorkMemoryScope` | yes | Where it should go |
+| `body.destination_revision` | `string \| null` | yes | The destination topic's revision, or null when it is empty pattern `^[a-f0-9]{64}$` |
+| `body.source` | `WorkMemoryScope` | yes | Where the topic is now |
+| `body.source_revision` | `string` | yes | The source topic's current revision pattern `^[a-f0-9]{64}$` |
+| `body.topic` | `"profile" \| "goals" \| "decisions" \| "feedback" \| "corrections" \| "entities"` | yes | The topic to move |
+
+**Returns** `ApiResponse_WorkMemoryNote_`: the envelope `{ data: WorkMemoryNote, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMemoryNote` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `content` | `string \| null` | no | Content |
+| `revision` | `string \| null` | no | Revision; send it back to edit or move |
+| `size_bytes` | `integer \| null` | no | Stored size |
+| `topic` | `string \| null` | no | Topic |
+| `updated_at` | `string \| null` | no | Last write time |
+
+**Example**
+
+```ts
+const result = await g8.api.work.moveWorkMemory({
+  body: {
+    destination: {},
+    destination_revision: "example",
+    source: {},
+    source_revision: "example",
+    topic: "profile",
+  },
+});
+```
+
+---
+
+<a id="op-promoteworksignal"></a>
+
+### `g8.api.work.promoteWorkSignal(input)`
+
+**Promote Work Signal**
+
+- HTTP: `POST /api/v1/work/signals/promote`
+- operationId: `promote_work_signal_work_signals_promote_post` (also callable as `g8.api.call("promote_work_signal_work_signals_promote_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `work:run`
+
+Turn one revenue signal into an accountable Work turn in ``#work``. BILLABLE.
+
+The promotion is an ordinary send, and like every send it schedules an
+agent turn after the write commits — which is why this is tiered
+``billable``. A replay is safe: the turn is claimed by a durable per-message
+key, so a second call never makes a second agent answer.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkSignalPromoteRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkSignalPromoteRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.signalEventId` | `string` | yes | min length 1, max length 128 |
+
+**Returns** `ApiResponse_WorkSignalPromoted_`: the envelope `{ data: WorkSignalPromoted, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkSignalPromoted` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `duplicate` | `boolean \| null` | no | True when this signal had already been promoted |
+| `message` | `Record<string, unknown> \| null` | no | The stored message that carries the turn |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.work.promoteWorkSignal({ body: { signalEventId: "example" } });
+```
+
+---
+
+<a id="op-reacttoworkmessage"></a>
+
+### `g8.api.work.reactToWorkMessage(input)`
+
+**React To Work Message**
+
+- HTTP: `PUT /api/v1/work/messages/{message_id}/reaction`
+- operationId: `react_to_work_message_work_messages__message_id__reaction_put` (also callable as `g8.api.call("react_to_work_message_work_messages__message_id__reaction_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Add or remove one emoji reaction on a message this credential may read.
+
+``active: true`` adds it, ``false`` removes it; sending the same value twice
+is a no-op rather than an error.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.message_id` | `string` | yes | Message id |
+| `body` | `WorkMessageReactionRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkMessageReactionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.active` | `boolean` | yes |  |
+| `body.emoji` | `string` | yes | min length 1, max length 32 |
+
+**Returns** `ApiResponse_WorkMessage_`: the envelope `{ data: WorkMessage, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkMessage` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `author` | `Record<string, unknown> \| null` | no | Resolved author — always the authenticated principal, never a request field |
+| `channel` | `string \| null` | no | Conversation address — a channel NAME or a direct-message id |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `document` | `Record<string, unknown> \| null` | no | Rich-text document, normalized server-side |
+| `id` | `string \| null` | no | Message id |
+| `text` | `string \| null` | no | Plain-text projection of the document |
+
+**Example**
+
+```ts
+const result = await g8.api.work.reactToWorkMessage({
+  path: { message_id: "id" },
+  body: { active: true, emoji: "example" },
+});
+```
+
+---
+
+<a id="op-runworkroutinenow"></a>
+
+### `g8.api.work.runWorkRoutineNow(input)`
+
+**Run Work Routine Now**
+
+- HTTP: `POST /api/v1/work/routines/{routine_id}/run`
+- operationId: `run_work_routine_now_work_routines__routine_id__run_post` (also callable as `g8.api.call("run_work_routine_now_work_routines__routine_id__run_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Run one routine immediately, as the caller's own message.
+
+Deliberately not the scheduled path: the instruction is posted into the
+delivery conversation as this credential's message and the normal turn
+machinery answers it, so a run-now exercises exactly what a live ask would —
+approvals and all. An event routine may carry a ``sampleEvent`` to run
+against; it is treated as data, never as instructions.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.routine_id` | `string (uuid)` | yes | Routine id |
+| `body` | `WorkRoutineRunNowRequest \| null` | no | Request body; fields below. |
+
+Body fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.sampleEvent` | `Record<string, unknown> \| null` | no | Example event payload; treated as data, never as instructions. `event` routines only. |
+
+**Returns** `ApiResponse_WorkRoutineRunResult_`: the envelope `{ data: WorkRoutineRunResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoutineRunResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `conversationId` | `string \| null` | no | Where it was posted |
+| `messageId` | `string \| null` | no | The message the run posted |
+| `runId` | `string \| null` | no | Ledger id of this manual run |
+| `runsPath` | `string \| null` | no | Developer API path to poll for this run's outcome |
+| `startedAt` | `string \| null` | no | When the run started |
+| `status` | `string \| null` | no | Always `running` on this response |
+
+**Example**
+
+```ts
+const result = await g8.api.work.runWorkRoutineNow({ path: { routine_id: "00000000-0000-0000-0000-000000000000" } });
+```
+
+---
+
+<a id="op-saveworkchannelcanvas"></a>
+
+### `g8.api.work.saveWorkChannelCanvas(input)`
+
+**Save Work Channel Canvas**
+
+- HTTP: `POST /api/v1/work/channels/{channel_id}/canvas`
+- operationId: `save_work_channel_canvas_work_channels__channel_id__canvas_post` (also callable as `g8.api.call("save_work_channel_canvas_work_channels__channel_id__canvas_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Replace one channel's Canvas from its content. Signed server-side.
+
+The counterpart of the published ``GET`` on this path. It is the app's
+``POST`` (bare content, revision authored server-side with the caller's
+derived key), not the ``PUT`` that accepts a client-SIGNED event, which a
+machine principal has no signing story for.
+
+``baseRevisionId`` is a compare-and-swap: send the ``revisionId`` the
+``GET`` gave you, omit it to skip the check, or send ``""`` to assert no
+canvas existed. ``403`` when the caller may not edit the channel; ``409``
+for an archived channel, a replayed key with a different body, or a stale
+``baseRevisionId``.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.channel_id` | `string` | yes | Channel id or slug |
+| `body` | `WorkCanvasSaveRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkCanvasSaveRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content` | `string` | yes | max length 100000 |
+| `body.baseRevisionId` | `string \| null` | no | max length 128 |
+
+**Returns** `ApiResponse_WorkCanvas_`: the envelope `{ data: WorkCanvas, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkCanvas` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channelId` | `string \| null` | no | Channel the canvas belongs to |
+| `content` | `string \| null` | no | Canvas content |
+| `revisionId` | `string \| null` | no | Current revision id |
+
+**Example**
+
+```ts
+const result = await g8.api.work.saveWorkChannelCanvas({ path: { channel_id: "id" }, body: { content: "example" } });
+```
+
+---
+
+<a id="op-searchwork"></a>
+
+### `g8.api.work.searchWork(input)`
+
+**Search Work**
+
+- HTTP: `GET /api/v1/work/search`
+- operationId: `search_work_work_search_get` (also callable as `g8.api.call("search_work_work_search_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `work:read`
+
+Search everything this credential may read, and nothing else.
+
+Deliberately has no storage-plane branch: "what can I find" is a question
+about one caller's permissions, and there is no viewer whose membership
+could scope an answer for a credential that has none.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.q` | `string` | yes | Search text |
+| `query.limit` | `integer` | no | Maximum hits; clamped to the server maximum default `25` |
+| `query.conversation` | `string \| null` | no | Channel name or direct-message id to search within |
+
+**Returns** `ApiResponse_WorkSearchResults_`: the envelope `{ data: WorkSearchResults, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkSearchResults` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query` | `string` | yes | The query that was run, as the server normalized it |
+| `hits` | `Array<WorkSearchHit>` | no | Ranked hits, capped by the server maximum |
+
+**Example**
+
+```ts
+const result = await g8.api.work.searchWork({ query: { q: "example" } });
+```
+
+---
+
+<a id="op-setworkchannelpurpose"></a>
+
+### `g8.api.work.setWorkChannelPurpose(input)`
+
+**Set Work Channel Purpose**
+
+- HTTP: `PUT /api/v1/work/channels/{channel_id}/purpose`
+- operationId: `set_work_channel_purpose_work_channels__channel_id__purpose_put` (also callable as `g8.api.call("set_work_channel_purpose_work_channels__channel_id__purpose_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Give one channel a purpose, taking it from whichever channel held it.
+
+``purpose`` is required but nullable: ``null`` clears it. An empty body is
+refused rather than guessed, because this operation reassigns state on
+channels the caller did not name and may not act on an ambiguity —
+``reassignedChannelIds`` says which ones it moved.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.channel_id` | `string` | yes | Channel id or slug |
+| `body` | `WorkChannelPurposeRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkChannelPurposeRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.purpose` | `string \| null` | yes |  |
+
+**Returns** `ApiResponse_WorkChannelWriteResult_`: the envelope `{ data: WorkChannelWriteResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkChannelWriteResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `canvasSeeded` | `boolean \| null` | no | Present when `templateId` seeded a Canvas |
+| `channel` | `WorkChannel \| null` | no | The channel as stored after the write |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkChannelPurpose({ path: { channel_id: "id" }, body: { purpose: "example" } });
+```
+
+---
+
+<a id="op-setworkdailybrief"></a>
+
+### `g8.api.work.setWorkDailyBrief(input)`
+
+**Set Work Daily Brief**
+
+- HTTP: `POST /api/v1/work/preferences/daily-brief`
+- operationId: `set_work_daily_brief_work_preferences_daily_brief_post` (also callable as `g8.api.call("set_work_daily_brief_work_preferences_daily_brief_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Store THIS principal's daily-brief schedule.
+
+An unknown ``timezone`` is a 422 rather than a UTC guess: a brief is a
+scheduled send, and a wrong zone delivers a morning brief at midnight.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkDailyBriefSettingsRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkDailyBriefSettingsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.timezone` | `string` | yes | min length 1, max length 100 |
+| `body.enabled` | `boolean` | no | default `false` |
+| `body.localTime` | `string \| null` | no | max length 5 |
+| `body.weekdays` | `Array<integer> \| null` | no | max items 7 |
+
+**Returns** `ApiResponse_WorkDailyBriefSettings_`: the envelope `{ data: WorkDailyBriefSettings, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkDailyBriefSettings` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `settings` | `Record<string, unknown> \| null` | no | The stored schedule |
+| `status` | `Record<string, unknown> \| null` | no | Delivery status (`latestBrief`, `lastBriefDate`, `nextDueAt`, `reason`). Returned on the read only; null on the write |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkDailyBrief({ body: { timezone: "example" } });
+```
+
+---
+
+<a id="op-setworkinboxdisposition"></a>
+
+### `g8.api.work.setWorkInboxDisposition(input)`
+
+**Set Work Inbox Disposition**
+
+- HTTP: `POST /api/v1/work/inbox-dispositions`
+- operationId: `set_work_inbox_disposition_work_inbox_dispositions_post` (also callable as `g8.api.call("set_work_inbox_disposition_work_inbox_dispositions_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Snooze, archive or reactivate one conversation, for this principal only.
+
+``state: "snoozed"`` REQUIRES a future ``snoozedUntil``; the app refuses a
+snooze without a wake-up with a 422.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkInboxDispositionRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkInboxDispositionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel` | `string` | yes | min length 1, max length 255 |
+| `body.conversationKey` | `string` | yes | min length 1, max length 512 |
+| `body.latestActivityAt` | `integer` | yes | min 0 |
+| `body.rootId` | `string` | yes | min length 1, max length 128 |
+| `body.state` | `"active" \| "snoozed" \| "archived"` | yes |  |
+| `body.snoozedUntil` | `string \| null` | no | max length 64 |
+
+**Returns** `ApiResponse_WorkInboxDisposition_`: the envelope `{ data: WorkInboxDisposition, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkInboxDisposition` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `disposition` | `Record<string, unknown> \| null` | no | The disposition as stored |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkInboxDisposition({
+  body: {
+    channel: "example",
+    conversationKey: "example",
+    latestActivityAt: 0,
+    rootId: "example",
+    state: "active",
+  },
+});
+```
+
+---
+
+<a id="op-setworkpulsereaction"></a>
+
+### `g8.api.work.setWorkPulseReaction(input)`
+
+**Set Work Pulse Reaction**
+
+- HTTP: `POST /api/v1/work/pulse/{note_id}/reaction`
+- operationId: `set_work_pulse_reaction_work_pulse__note_id__reaction_post` (also callable as `g8.api.call("set_work_pulse_reaction_work_pulse__note_id__reaction_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Upvote one pulse note, or take the upvote back.
+
+``reacted`` is the DESIRED state, not a toggle, so a retry is idempotent.
+Always ``200``; read ``duplicate`` to know whether anything was written.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.note_id` | `string` | yes | Pulse note id |
+| `body` | `WorkPulseReactionRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkPulseReactionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.reacted` | `boolean` | yes |  |
+
+**Returns** `ApiResponse_WorkPulseReaction_`: the envelope `{ data: WorkPulseReaction, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkPulseReaction` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `duplicate` | `boolean \| null` | no | True when the request asked for the state already stored |
+| `event` | `Record<string, unknown> \| null` | no | The room event, or null when taking back an upvote nobody had left nothing to write |
+| `reacted` | `boolean \| null` | no | The state that now stands |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkPulseReaction({ path: { note_id: "id" }, body: { reacted: true } });
+```
+
+---
+
+<a id="op-setworkreadmarkers"></a>
+
+### `g8.api.work.setWorkReadMarkers(input)`
+
+**Set Work Read Markers**
+
+- HTTP: `POST /api/v1/work/read-markers`
+- operationId: `set_work_read_markers_work_read_markers_post` (also callable as `g8.api.call("set_work_read_markers_work_read_markers_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Record that this principal has read these conversations up to a point.
+
+Batched (1-200 markers per request) and monotonic: a marker that moves
+backwards is ignored, so a replay changes nothing and no key is asked for.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkReadMarkersRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkReadMarkersRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.markers` | `Array<WorkReadMarkerRequest>` | yes | min items 1, max items 200 |
+
+**Returns** `ApiResponse_WorkReadMarkers_`: the envelope `{ data: WorkReadMarkers, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkReadMarkers` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `markers` | `Record<string, unknown> \| null` | no | Conversation key -> the point this principal has read to |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkReadMarkers({
+  body: {
+    markers: [
+      {
+        channel: "example",
+        conversationKey: "example",
+        lastReadAt: 0,
+        rootId: "example",
+      },
+    ],
+  },
+});
+```
+
+---
+
+<a id="op-setworksidebarpreferences"></a>
+
+### `g8.api.work.setWorkSidebarPreferences(input)`
+
+**Set Work Sidebar Preferences**
+
+- HTTP: `POST /api/v1/work/sidebar-preferences`
+- operationId: `set_work_sidebar_preferences_work_sidebar_preferences_post` (also callable as `g8.api.call("set_work_sidebar_preferences_work_sidebar_preferences_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Store how this principal wants its own sidebar ordered.
+
+Both halves are required and closed to ``alpha`` | ``recent``. There is no
+read route here because there is none in the app: the stored value rides
+the room payload (``GET /work/room``).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkSidebarPreferencesRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkSidebarPreferencesRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channels` | `"alpha" \| "recent"` | yes |  |
+| `body.directMessages` | `"alpha" \| "recent"` | yes |  |
+
+**Returns** `ApiResponse_WorkSidebarPreferences_`: the envelope `{ data: WorkSidebarPreferences, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkSidebarPreferences` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `preferences` | `Record<string, unknown> \| null` | no | The ordering as stored |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkSidebarPreferences({ body: { channels: "alpha", directMessages: "alpha" } });
+```
+
+---
+
+<a id="op-setworksignalstate"></a>
+
+### `g8.api.work.setWorkSignalState(input)`
+
+**Set Work Signal State**
+
+- HTTP: `POST /api/v1/work/signals/state`
+- operationId: `set_work_signal_state_work_signals_state_post` (also callable as `g8.api.call("set_work_signal_state_work_signals_state_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Snooze or dismiss one revenue signal.
+
+No ``Idempotency-Key``, matching the app: the key is derived from the
+signal and the target state, so it is idempotent by construction. ``404``
+for a signal that is not there.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `WorkSignalStateRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkSignalStateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.action` | `"snooze" \| "dismiss"` | yes |  |
+| `body.signalEventId` | `string` | yes | min length 1, max length 128 |
+
+**Returns** `ApiResponse_WorkSignalState_`: the envelope `{ data: WorkSignalState, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkSignalState` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `duplicate` | `boolean \| null` | no | True when the signal already held the requested state |
+| `event` | `Record<string, unknown> \| null` | no | The room event the write appended |
+
+**Example**
+
+```ts
+const result = await g8.api.work.setWorkSignalState({ body: { action: "snooze", signalEventId: "example" } });
+```
+
+---
+
+<a id="op-updateworkagent"></a>
+
+### `g8.api.work.updateWorkAgent(input)`
+
+**Update Work Agent**
+
+- HTTP: `PATCH /api/v1/work/agents/{agent_id}`
+- operationId: `update_work_agent_work_agents__agent_id__patch` (also callable as `g8.api.call("update_work_agent_work_agents__agent_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Replace one agent's profile, versioned.
+
+``expected_version`` is the ``version`` you read; a stale one is a ``409``
+so two editors cannot silently overwrite each other's instructions.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.agent_id` | `string (uuid)` | yes | Agent id |
+| `body` | `WorkAgentProfileEditRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkAgentProfileEditRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.expected_version` | `integer` | yes | The `version` you read; a stale one is a 409 min 1 |
+| `body.profile` | `WorkAgentProfileRequest` | yes | The full new profile |
+
+**Returns** `ApiResponse_WorkAgentProfile_`: the envelope `{ data: WorkAgentProfile, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkAgentProfile` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agent_id` | `string \| null` | no | Agent id |
+| `avatar` | `string \| null` | no | Avatar glyph |
+| `can_edit` | `boolean \| null` | no | Whether this caller may edit it |
+| `description` | `string \| null` | no | Instructions |
+| `name` | `string \| null` | no | Agent name |
+| `owner_id` | `string \| null` | no | Owner identity |
+| `role` | `string \| null` | no | Role |
+| `updated_at` | `string \| null` | no | Last edit time |
+| `version` | `integer \| null` | no | Profile version; send it back to edit |
+| `visibility` | `string \| null` | no | `private` or `organization` |
+
+**Example**
+
+```ts
+const result = await g8.api.work.updateWorkAgent({
+  path: { agent_id: "00000000-0000-0000-0000-000000000000" },
+  body: {
+    expected_version: 1,
+    profile: { description: "example", name: "Example" },
+  },
+});
+```
+
+---
+
+<a id="op-updateworkchannel"></a>
+
+### `g8.api.work.updateWorkChannel(input)`
+
+**Update Work Channel**
+
+- HTTP: `PATCH /api/v1/work/channels/{channel_id}`
+- operationId: `update_work_channel_work_channels__channel_id__patch` (also callable as `g8.api.call("update_work_channel_work_channels__channel_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Change one channel's display name, description, visibility, seating, agent policy or archive state.
+
+**Field PRESENCE is the contract** — an omitted field keeps its stored value,
+and ``description: null`` clears it.
+
+``name`` is not accepted and a rename never moves the room: the slug is the
+channel's address, and changing it would strand every event already filed
+under the old one. ``403`` when the caller neither owns the channel nor
+holds owner/admin rights, and separately when a non-admin tries to change
+agent activation — an organization-level spend decision rather than a
+room-owner one. ``409`` for a built-in channel's identity or visibility.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.channel_id` | `string` | yes | Channel id or slug |
+| `body` | `WorkChannelSettingsRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkChannelSettingsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agentResponsePolicy` | `"mention_required" \| "proactive" \| null` | no |  |
+| `body.archived` | `boolean \| null` | no |  |
+| `body.confirmAgentAccess` | `boolean` | no | default `false` |
+| `body.description` | `string \| null` | no | max length 1000 |
+| `body.displayName` | `string \| null` | no | max length 255 |
+| `body.memberUserIds` | `Array<string>` | no | max items 100 |
+| `body.participantAgentIds` | `Array<string>` | no | max items 32 |
+| `body.visibility` | `"open" \| "private" \| null` | no |  |
+
+**Returns** `ApiResponse_WorkChannelWriteResult_`: the envelope `{ data: WorkChannelWriteResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkChannelWriteResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `canvasSeeded` | `boolean \| null` | no | Present when `templateId` seeded a Canvas |
+| `channel` | `WorkChannel \| null` | no | The channel as stored after the write |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result |
+
+**Example**
+
+```ts
+const result = await g8.api.work.updateWorkChannel({ path: { channel_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updateworkproject"></a>
+
+### `g8.api.work.updateWorkProject(input)`
+
+**Update Work Project**
+
+- HTTP: `PATCH /api/v1/work/projects/{project_id}`
+- operationId: `update_work_project_work_projects__project_id__patch` (also callable as `g8.api.call("update_work_project_work_projects__project_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Rename one project, re-describe it, or move its status.
+
+**Field PRESENCE is the contract**: an omitted field keeps its stored
+value and ``description: null`` clears it. ``403`` unless the caller
+created the project or holds Owner/Admin — the SAME rule deletion uses, and
+the role half only answers correctly because of ``with_org_role``.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.project_id` | `string` | yes | Project id |
+| `body` | `WorkProjectUpdateRequest` | yes | Request body; fields below. |
+| `headers.Idempotency-Key` | `string \| null` | no | Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry. |
+
+Body fields (`WorkProjectUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.description` | `string \| null` | no | max length 2000 |
+| `body.name` | `string \| null` | no | max length 500 |
+| `body.status` | `"active" \| "paused" \| "completed" \| "archived" \| null` | no |  |
+
+**Returns** `ApiResponse_WorkProjectWriteResult_`: the envelope `{ data: WorkProjectWriteResult, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkProjectWriteResult` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `compatibilityEventId` | `string \| null` | no | Id of the room event the write appended |
+| `duplicate` | `boolean \| null` | no | True when an Idempotency-Key replay returned the original result rather than writing again |
+| `project` | `WorkProject \| null` | no | The project as stored after the write |
+
+**Example**
+
+```ts
+const result = await g8.api.work.updateWorkProject({ path: { project_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updateworkroutine"></a>
+
+### `g8.api.work.updateWorkRoutine(input)`
+
+**Update Work Routine**
+
+- HTTP: `PATCH /api/v1/work/routines/{routine_id}`
+- operationId: `update_work_routine_work_routines__routine_id__patch` (also callable as `g8.api.call("update_work_routine_work_routines__routine_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `work:write`
+
+Change one routine.
+
+Only somebody who can read the routine's delivery conversation may change
+it, and re-pointing ``deliveryConversationId`` is a second grant: the NEW
+conversation must be readable too. Omitted fields keep their stored value.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.routine_id` | `string (uuid)` | yes | Routine id |
+| `body` | `WorkRoutinePatchRequest` | yes | Request body; fields below. |
+
+Body fields (`WorkRoutinePatchRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agentId` | `string \| null` | no | Agent that runs the routine |
+| `body.deliveryConversationId` | `string \| null` | no | Re-point delivery; the new conversation must also be readable |
+| `body.enabled` | `boolean \| null` | no | Turn the routine on or off |
+| `body.eventPolicy` | `Record<string, unknown> \| null` | no | Optional event-handling policy |
+| `body.instruction` | `string \| null` | no | What the agent is asked to do each run |
+| `body.localTime` | `string \| null` | no | Local run time `HH:MM` |
+| `body.timezone` | `string \| null` | no | IANA timezone the local time is read in |
+| `body.title` | `string \| null` | no | What the routine is called |
+| `body.trigger` | `Record<string, unknown> \| null` | no | Trigger config, for `event` routines |
+| `body.triggerKind` | `string \| null` | no | `schedule` or `event` |
+| `body.weekdays` | `Array<integer> \| null` | no | Days to run on (0-6) |
+
+**Returns** `ApiResponse_WorkRoutineEnvelope_`: the envelope `{ data: WorkRoutineEnvelope, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`WorkRoutineEnvelope` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `routine` | `WorkRoutine` | yes | The routine as stored after the write |
+
+**Example**
+
+```ts
+const result = await g8.api.work.updateWorkRoutine({
+  path: { routine_id: "00000000-0000-0000-0000-000000000000" },
+  body: {},
+});
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-workactivityentry"></a>
+
+### `WorkActivityEntry`
+
+One entry in the Work activity feed.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `actor` | `string \| null` | no | `human`, `agent`, `runner` or `system` |
+| `category` | `string \| null` | no | message, conversation, approval, execution, workflow, canvas or configuration |
+| `consequence` | `string \| null` | no | requested, changed, approved, completed, failed or recorded |
+| `id` | `string \| null` | no | Activity entry id |
+
+<a id="type-workavailablechannel"></a>
+
+### `WorkAvailableChannel`
+
+A channel of this organization the caller is not currently part of. An `open` channel carries its description and member count; a `private` one answers with identity only, so nothing about the room itself leaks.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `description` | `string \| null` | no | Present for `open` channels only |
+| `displayName` | `string \| null` | no | Human-readable name |
+| `id` | `string \| null` | no | Channel id |
+| `memberCount` | `integer \| null` | no | Present for `open` channels only |
+| `name` | `string \| null` | no | Channel slug |
+| `visibility` | `string \| null` | no | `open` or `private` |
+
+<a id="type-workchannel"></a>
+
+### `WorkChannel`
+
+One Work channel as the room stores it.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `archivedAt` | `string \| null` | no | When the channel was archived, if it is |
+| `createdAt` | `string \| null` | no | Creation timestamp |
+| `createdBy` | `string \| null` | no | Identity that created the channel |
+| `description` | `string \| null` | no | Channel description |
+| `displayName` | `string \| null` | no | Human-readable name shown in the sidebar |
+| `id` | `string \| null` | no | Channel id (uuid5 of `{org}:{name}` — the room address) |
+| `kind` | `string \| null` | no | `stream` or `forum` |
+| `memberUserIds` | `Array<string> \| null` | no | Seated member identities |
+| `name` | `string \| null` | no | Slug, unique per organization. Renaming the display name never moves the room. |
+| `participantAgentIds` | `Array<string> \| null` | no | Seated agent ids |
+| `system` | `boolean \| null` | no | True for a built-in channel (`#work`, `#signals`) |
+| `visibility` | `string \| null` | no | `open` (self-serve joinable) or `private` (invite only) |
+
+<a id="type-workevent"></a>
+
+### `WorkEvent`
+
+One signed Work event from the conversation ledger.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `created_at` | `integer \| null` | no | Event creation time |
+| `id` | `string \| null` | no | Event id |
+| `kind` | `integer \| null` | no | Event kind number |
+
+<a id="type-workitem"></a>
+
+### `WorkItem`
+
+One unit of agent work on the All Work board.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `dueAt` | `string \| null` | no | Due date, when one is set |
+| `id` | `string \| null` | no | Work item id |
+| `ownerUserId` | `string \| null` | no | Identity the item is assigned to |
+| `priority` | `string \| null` | no | Priority band |
+| `status` | `string \| null` | no | Lifecycle status |
+| `title` | `string \| null` | no | What the work is |
+
+<a id="type-workmemoryscope"></a>
+
+### `WorkMemoryScope`
+
+Which memory to act on. Mirrors ``work.memory.MemorySelection``.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agent_id` | `string (uuid) \| null` | no | Required for, and only for, `agent` scope |
+| `scope` | `"personal" \| "agent" \| "team"` | no | `personal`, `agent` or `team` default `"personal"` |
+
+<a id="type-workproject"></a>
+
+### `WorkProject`
+
+One project: a named unit of work attached to a channel.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channel` | `string \| null` | no | Channel the project belongs to |
+| `createdBy` | `string \| null` | no | Ownership identity of whoever created it |
+| `description` | `string \| null` | no | Project description; null when cleared |
+| `id` | `string \| null` | no | Project id, minted server-side |
+| `name` | `string \| null` | no | Project name |
+| `status` | `string \| null` | no | `active`, `paused`, `completed` or `archived` |
+
+<a id="type-workreadmarkerrequest"></a>
+
+### `WorkReadMarkerRequest`
+
+How far this person has read ONE conversation. `last_read_at` is the conversation's `latestAt` boundary the reader was shown, in unix seconds — the same clock `WorkInboxDispositionRequest` keeps in `latest_activity_at` — not the instant they looked. A newer inbound message therefore lights the badge again on its own: the comparison is `latestAt > lastReadAt`, and nothing has to un-mark anything. Seconds are not a total order: `post_message` truncates event timestamps to whole seconds, so a message that lands in the SAME second as the one the reader saw would compare equal and pass as read. `l…
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channel` | `string` | yes | min length 1, max length 255 |
+| `conversationKey` | `string` | yes | min length 1, max length 512 |
+| `lastReadAt` | `integer` | yes | min 0 |
+| `rootId` | `string` | yes | min length 1, max length 128 |
+| `lastReadId` | `string \| null` | no | min length 1, max length 128 |
+
+<a id="type-workroutine"></a>
+
+### `WorkRoutine`
+
+One scheduled or event-triggered Work routine.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `agentId` | `string \| null` | no | Agent that runs the routine |
+| `deliveryConversationId` | `string \| null` | no | Conversation the routine posts into |
+| `enabled` | `boolean \| null` | no | Whether the routine is active |
+| `id` | `string \| null` | no | Routine id |
+| `instruction` | `string \| null` | no | What the agent is asked to do each run |
+| `lastRunAt` | `string \| null` | no | When the routine last ran |
+| `lastStatus` | `string \| null` | no | How the last run ended |
+| `localTime` | `string \| null` | no | Local run time, for `schedule` routines |
+| `timezone` | `string \| null` | no | IANA timezone the local time is read in |
+| `title` | `string \| null` | no | Routine title |
+| `triggerKind` | `string \| null` | no | `schedule` or `event` |
+| `weekdays` | `Array<integer> \| null` | no | Schedule weekdays (0-6), for `schedule` routines |
+
+<a id="type-workroutinerun"></a>
+
+### `WorkRoutineRun`
+
+One entry in a routine's run ledger.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string \| null` | no | Run id |
+| `startedAt` | `string \| null` | no | When the run started |
+| `status` | `string \| null` | no | How the run ended, or that it is still going |
+
+<a id="type-worksearchhit"></a>
+
+### `WorkSearchHit`
+
+One search hit — a message or an event, with its conversation.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `conversation` | `string \| null` | no | Conversation the hit belongs to |
+| `id` | `string \| null` | no | Message or event id |
+| `text` | `string \| null` | no | Matched text |