[{"data":1,"prerenderedAt":277},["ShallowReactive",2],{"$f2764srx7865rp":3},{"href":4,"title":5,"description":6,"kind":7,"mark":7,"planned":8,"contributors":9,"provenance":7,"express":8,"bridge":8,"html":10,"headings":11},"\u002Fdocs\u002Fmcp\u002Ftools","MCP tools","Every tool the OS's MCP server offers, generated from the tool catalog.",null,false,[],"\u003Cp>\u003Cem>Generated from the MCP tool catalog (\u003Ccode>apps\u002Fmcp\u002Fsrc\u002Ftool-catalog.ts\u003C\u002Fcode>). Do not edit by hand.\u003C\u002Fem>\u003C\u002Fp>\n\u003Ch2 id=\"os-list-runs\">\u003Ccode>os.list_runs\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the enterprise's runs, newest first, one page at a time. Each run carries its status, task (id, name, slug), the member it runs as, compact work references, and when it was created, started and finished. The response is { data, total, page, limit, pages }.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>pending\u003C\u002Fcode>, \u003Ccode>queued\u003C\u002Fcode>, \u003Ccode>running\u003C\u002Fcode>, \u003Ccode>waiting_on_gate\u003C\u002Fcode>, \u003Ccode>waiting_on_run\u003C\u002Fcode>, \u003Ccode>paused_spend\u003C\u002Fcode>, \u003Ccode>paused_plan\u003C\u002Fcode>, \u003Ccode>paused_team\u003C\u002Fcode>, \u003Ccode>paused\u003C\u002Fcode>, \u003Ccode>succeeded\u003C\u002Fcode>, \u003Ccode>failed\u003C\u002Fcode>, \u003Ccode>cancelled\u003C\u002Fcode>, \u003Ccode>skipped_overlap\u003C\u002Fcode>, \u003Ccode>blocked\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only runs in this status.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only runs of this task.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>live\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>true for only runs still in progress: not finished, not blocked, and not paused on spend, a plan limit or a switched-off team.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>page\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The page to read, from 1. Defaults to 1.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 200\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Runs per page, up to 200. Defaults to 25.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002Fsummary\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-get-run\">\u003Ccode>os.get_run\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>One run's status, why it stopped (blockedReason, when it is blocked), task id and input, and its last eight events. Not found for another enterprise's run.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The run id.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Fos-tool\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-blockers\">\u003Ccode>os.list_blockers\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>What is stopping work right now, as the Blockers page shows it: failed runs not yet cleared (one page, with failedTotal counting them all), stalled, blocked and spend-paused runs, stopped pipelines, missing model tiers, exhausted LLM capacity, task definition problems, and teams with no lead, no metric or an overdue retro. Read-only: nothing is retried or cleared. Waiting gates are not here; use os.list_open_gates.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>failedPage\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The page of failed runs to read, from 1. Defaults to 1. A page past the last reads the last.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>pageSize\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 100\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Failed runs per page, up to 100. Defaults to 100 in a run, and to 20 over the API.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fblockers\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>blockers:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-open-gates\">\u003Ccode>os.list_open_gates\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Every gate waiting on a decision, oldest first: the run and task it belongs to, the tool call it holds (toolName, payload), its summary when the run wrote one, who owns the decision, when it times out, and whether the run can be sent back with changes requested. Read-only: deciding a gate is not a tool here.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fgates?status=waiting\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>gates:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-kpi-board\">\u003Ccode>os.kpi_board\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>The enterprise's KPI board, as HQ shows it: every company KPI the owner has signed off and each team's key KPI with its light (red off target, amber at risk, green on target), its trend (up, down, flat), when it was last read, the cadence it is read on, and whether that reading is overdue. A KPI nobody has read yet has no light (\u003Ccode>rag\u003C\u002Fcode> is null): it is never read and overdue, not green. A KPI still waiting for sign-off is not on the board. A team that has set no key KPI is named with none rather than left out. The response is { enterprise, teams }. Read-only: recording a reading is not a tool here.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fenterprise\u002Fkpis\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>enterprise:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"kpi-record-reading\">\u003Ccode>kpi.record_reading\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Record one reading of a KPI by hand: the value, when it was taken, and who or what took it. Every reading is kept — correcting a wrong one means recording a new reading, never editing or deleting the old one — so a KPI history shows how it got to where it is. The light and the trend are read off the readings, so recording one is what moves them. A KPI nobody has signed off takes no reading: it is refused with 409 kpi_not_signed_off.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kpiId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The KPI the reading belongs to.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>value\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>number\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The number read, in the KPI's own unit.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>takenAt\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>When the reading was taken, as an ISO 8601 timestamp, e.g. 2026-01-08T00:00:00Z.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>recordedBy\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Who or what took the reading: a member id, or the agent or tool that read it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fkpis\u002F:kpiId\u002Freadings\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>kpis:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"kpi-list-readings\">\u003Ccode>kpi.list_readings\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>One KPI's readings, newest first: the value, when it was taken and who or what took it. This is the whole history behind the KPI's light and its trend, including any reading a later one corrected.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kpiId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The KPI whose readings to list.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fkpis\u002F:kpiId\u002Freadings\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>kpis:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"memory-ask\">\u003Ccode>memory.ask\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Ask enterprise memory a question and get an answer with the evidence behind it. Pass purpose (what you need it for) and, to restrict the search, teamId or projectId — an explicit filter is honoured as given and never widened, so omit both to search the whole enterprise. Pass selection to say which notes may answer: any (the default), trained (only what somebody taught, never what a run retained after its work) or confirmed (only the owner's own word: a note a person taught, or a decision they made at a gate). Before asking a person something they may already have decided, ask with selection confirmed and a purpose that does not quote the answer: insufficient_evidence means nothing confirmed matched, so you may ask. Returns answer, evidence, appliedFilters, appliedSelection, status and usage. Each evidence row carries its origin, kind, authorKind, sourceEventId and its layer and layerId, which say what it covers. A status of unavailable means memory could not be asked: carry on without it, and never read it as memory knowing nothing. In a run the reply always fits one result: evidence holds the notes that fit, whole; a first note too long on its own is cut and marked partial, with chars as its full length; and omitted names each note that matched and is not there. answer names the notes cited, and their text is in evidence only. Pass limit to get at most that many notes. Asking never stores anything.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>purpose\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>What you need the answer for. Shown in the answer.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Restrict to this team. Never widened back out.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>projectId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Restrict to this project. Never widened back out.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 20\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The most notes to return. Defaults to 20.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>selection\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>any\u003C\u002Fcode>, \u003Ccode>trained\u003C\u002Fcode>, \u003Ccode>confirmed\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Which notes may answer. Defaults to any. trained leaves out what runs retained after their work; confirmed keeps only the owner's own word. Never widened.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmemory\u002Fask\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>memory:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-decide-gate\">\u003Ccode>os.decide_gate\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Decide one gate waiting on a person, as its card in Needs you does. Pass gateId as os.list_open_gates lists it, and decision: approve, reject or request_changes. A question gate (toolName os.ask_ceo) is approved by answering it: answers holds one row per question, { number, answer }, or { number, requiresMoreDetail: true } to ask the run for more; a reject declines the whole ask and needs no answers. request_changes sends the work back with note as the feedback, only on a gate whose requestChanges is true. A gate that offers choices is decided through one: pass choice as its key, decision as the decision that choice records, and what the choice asks for in note (a time as ISO 8601). edit, with approve only, is the whole payload as it should run, changed only in the fields the gate’s editableFields names. The decision is recorded as you, and the run resumes, routes or ends exactly as it does from the portal. A gate already decided is refused.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>gateId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The gate, by the id os.list_open_gates lists it under.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>decision\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>approve\u003C\u002Fcode>, \u003Ccode>reject\u003C\u002Fcode>, \u003Ccode>request_changes\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>approve runs the gated call, or answers the questions; reject declines it; request_changes sends the work back with note as the feedback.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>note\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional. The reason for a rejection, the feedback for request_changes (required then), or what a choice asks for: a time as ISO 8601 for a datetime input.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>answers\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Approving a question gate: one object per question, { number, answer }, or { number, requiresMoreDetail: true } to ask for more. Every question the gate asks needs one.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>choice\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional. The key of the choice this decision is made through, from the gate’s choices; decision must be the decision that choice records.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>edit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional, with approve only. The gate’s whole payload as it should run, changed only in the fields its editableFields names.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fgates\u002F:gateId\u002Fdecision\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>gates:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-member-mailbox-actions\">\u003Ccode>os.member_mailbox_actions\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the one-click buttons a member’s mailbox offers, as the member’s page shows them: each an active task of the enterprise whose current version declares a mailbox action (mailboxAction) and that runs as a role this member holds, since those are the runs that read the member’s mailbox. on says where the button sits: mailbox, over the whole mailbox, or mail, on one message. Start one with os.start_task by its taskId; for a button on one message pass the message’s id as the emailId input. The run reads the member’s mailbox as its tasks always have. Pass id, the member’s id. A member in another enterprise, or one holding no such role, offers nothing.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The member’s id\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmembers\u002F:id\u002Fmailbox-actions\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>members:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-list\">\u003Ccode>os.my_mail_list\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the mail in your own mailbox, newest first: the mailbox of the person who signed in or connected this app, in the enterprise this call is in, and never a member’s or anyone else’s. Metadata and a snippet only, no bodies: read one with os.my_mail_read. Optional unreadOnly (only messages not yet opened), label (only mail carrying that label), handledState (only mail in that state), threadId (every mail in one conversation), search (only mail whose sender address or name, subject or text contains the words, any case), order (desc, the default, or asc), page and limit (default 25, max 200). Filters combine: label VIP with handledState unhandled lists only unhandled VIP mail; search invoice with label Acme finds the Acme mail about an invoice. A full row is large: about 30 fit in one result. To work through a long backlog pass compact true, which returns only id, fromAddress, subject, receivedAt, labels, handledState, spamScore and spamFlag, so about 100 rows fit.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>unreadOnly\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only messages nobody has opened yet\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>label\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only mail carrying this label, e.g. VIP\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>handledState\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>unhandled\u003C\u002Fcode>, \u003Ccode>replied\u003C\u002Fcode>, \u003Ccode>skipped\u003C\u002Fcode>, \u003Ccode>snoozed\u003C\u002Fcode>, \u003Ccode>escalated\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only mail in this handled state\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>threadId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only mail in this conversation, from a row’s threadId\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>search\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only mail whose sender address or name, subject or text contains this, any case\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>order\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>desc\u003C\u002Fcode>, \u003Ccode>asc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>By receivedAt. Default desc\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>page\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The page of results, from 1\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 200\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Rows per page. Default 25\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>compact\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only id, fromAddress, subject, receivedAt, labels, handledState, spamScore and spamFlag on each row\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-read\">\u003Ccode>os.my_mail_read\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one message from your own mailbox: sender, subject, text and sanitised HTML bodies, and attachment names and sizes (fetch one with os.my_mail_attachment). Reading marks it read for you too. Pass id from os.my_mail_list; an id from anyone else’s mailbox is not found.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-attachment\">\u003Ccode>os.my_mail_attachment\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Fetch one attachment of a message in your own mailbox, as its file name, content type, size and base64-encoded bytes. Pass id, a message id from os.my_mail_list, and attachmentId from that message’s attachments in os.my_mail_read. A file over 4 MB is refused here: download it from the API instead (GET \u002Fv1\u002Fmail\u002F{id}\u002Fattachments\u002F{attachmentId} without format=json streams the bytes).\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>attachmentId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>An attachment id from os.my_mail_read\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u002Fattachments\u002F:attachmentId?format=json\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-set-label\">\u003Ccode>os.my_mail_set_label\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Set the labels on one message in your own mailbox. Pass id from os.my_mail_list and labels, the whole set the mail should carry: it replaces whatever labels it had, and an empty list clears them. Labels are free text (e.g. VIP, Needs reply); there is no fixed list to choose from. List mail by label with os.my_mail_list.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>labels\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Every label the mail should carry. Replaces the current set\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u002Flabels\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-set-handled\">\u003Ccode>os.my_mail_set_handled\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Record where one message in your own mailbox stands. Pass id from os.my_mail_list and handledState: unhandled, replied, skipped or snoozed. A mail is in one state at a time. snoozed needs snoozedUntil, the date and time it comes back (ISO 8601); every other state takes no date and clears any snooze. escalated is a member’s state, raised to the enterprise owner: your mail has nobody to raise to, so it is refused. os.my_mail_reply moves the mail it answers to replied on its own.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>handledState\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>unhandled\u003C\u002Fcode>, \u003Ccode>replied\u003C\u002Fcode>, \u003Ccode>skipped\u003C\u002Fcode>, \u003Ccode>snoozed\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Where the mail stands now\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>snoozedUntil\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>ISO 8601 date and time the mail comes back. Only with handledState snoozed\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u002Fhandled\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-set-many\">\u003Ccode>os.my_mail_set_many\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Record the same decision on many messages in your own mailbox in one call. Name the mail one way: ids (up to 200 message ids from os.my_mail_list), or fromAddress (every unhandled mail that arrived from that exact sender address; mail already handled and mail you sent are never touched). Then pass labels (the whole set each mail should carry, replacing what it had), handledState (unhandled, replied, skipped or snoozed; snoozed needs snoozedUntil), or both. Use it to close a run of look-alike mail without reading each one. An id that is not in your mailbox changes nothing and comes back in notFound.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>ids\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Up to 200 message ids from os.my_mail_list. Not together with fromAddress\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>fromAddress\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A sender address, matched exactly: every unhandled mail that arrived from it. Not together with ids\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>labels\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Every label each mail should carry. Replaces the current set\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>handledState\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>unhandled\u003C\u002Fcode>, \u003Ccode>replied\u003C\u002Fcode>, \u003Ccode>skipped\u003C\u002Fcode>, \u003Ccode>snoozed\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where each mail stands now\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>snoozedUntil\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>ISO 8601 date and time the mail comes back. Only with handledState snoozed\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Ftriage\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-reply\">\u003Ccode>os.my_mail_reply\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Reply to one message in your own mailbox. Pass id from os.my_mail_list and the reply. Write the body as \u003Ccode>markdown\u003C\u002Fcode>; the OS sends it formatted with a plain-text copy, and raw HTML in it is not passed through. Or pass text, with optional html for a body you formatted yourself, as before; give markdown or text, not both, and never markdown with html. The subject comes from the message being answered, and the reply goes out from the address it arrived at, which has to be yours. It goes to the sender of the message being answered. Pass replyAll true to answer everyone on the original too: everyone else on its To and Cc is copied in, but for this mailbox’s own addresses. Optional cc and bcc, each one address or a list, copy in more people, seen or unseen; 50 addresses at most in all. Pass to, one address or a list, to send it to them in place of that sender; the subject, the address it leaves from and the threading still come from the original. With replyAll, anyone already in to is not copied in again. It threads under the original in the recipient’s mail client. Pass attachments to attach files: each by a public https link (url), by a file already on a mail in your mailbox (emailId and attachmentId), or inline as base64 for a small file. A mail carries up to 10 files, 7 MB together: a file past that, one that cannot be read or fetched, or an item that is not one is refused by name before anything leaves, and nothing is sent. Your signature, when you have set one, is added after the body; pass signature false to leave it off. The message you are answering is quoted below your reply and signature, under an \u003Ccode>On &lt;date&gt;, &lt;name&gt; wrote:\u003C\u002Fcode> line, as \u003Ccode>&gt;\u003C\u002Fcode> lines in text and a blockquote in html; pass quote false to leave it off. Your own mail is yours: nothing waits for anyone’s approval, and the message leaves in this call. The sent copy is filed in your mailbox in the original’s thread, listing the files it carried, and the original is marked read and moves to handled state replied.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list: the mail this answers\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>markdown\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The body in Markdown: headings, emphasis, lists, links, quotes, code and tables. The OS sends it formatted, with a plain-text copy. Give this or text, not both\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>text\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The reply, as plain text, when not given as markdown\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>html\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional HTML body beside text. Plain text is sent either way\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>to\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Who the reply goes to, in place of the sender of the message being answered: one address or a list. Left out, it goes to that sender\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>replyAll\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>true answers everyone on the original: its sender, and everyone else on its To and Cc but this mailbox\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>More people to copy in, seen by every recipient: one address or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>bcc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>People sent the reply that no other recipient sees: one address or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional files the reply carries: up to 10, 7 MB together. The message being answered’s own files are not attached unless you name them. Each item names one file in one of three ways: { url, filename?, contentType? }, a public https link the OS fetches, so a screenshot or any other hosted file is attached without writing out its bytes; { emailId, attachmentId, filename?, contentType? }, a file already on a mail in your mailbox, the ids as os.my_mail_read lists them; or { filename, contentType, base64 }, the bytes inline, for a small file. A link’s or a stored file’s filename and contentType are used unless you give your own; contentType is type\u002Fsubtype, such as image\u002Fpng. Refused whole, naming the file, before anything leaves: attachments_over_limit past the limits, attachment_unreadable for a stored file that is not in your mailbox or cannot be read, attachment_invalid for an item that is not one, attachment_link_refused for a link that is not a public https one or does not answer with the file\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>signature\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>false sends without your signature. Left out, the OS adds it when you have one\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>quote\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>false sends without the original quoted below. Left out, the OS quotes the message you are answering after the body and your signature\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u002Freply\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-send\">\u003Ccode>os.my_mail_send\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Send a new message from your own mailbox: to, subject and the body. to, cc and bcc each take one address or a list of them. Everyone in to and cc sees who else the mail went to; nobody sees bcc. An address named twice gets one copy, and a mail goes to at most 50 addresses in all. Write the body as \u003Ccode>markdown\u003C\u002Fcode>; the OS sends it formatted with a plain-text copy, and raw HTML in it is not passed through. Or pass text, with optional html for a body you formatted yourself, as before; give markdown or text, not both, and never markdown with html. It goes out from your own address in this enterprise, the one an owner gave you, or from one of your extra addresses when you name it as \u003Ccode>from\u003C\u002Fcode>. Pass attachments to attach files: each by a public https link (url), by a file already on a mail in your mailbox (emailId and attachmentId), or inline as base64 for a small file. A mail carries up to 10 files, 7 MB together: a file past that, one that cannot be read or fetched, or an item that is not one is refused by name before anything leaves, and nothing is sent. Your signature, when you have set one, is added after the body; pass signature false to leave it off. Your own mail is yours: nothing waits for anyone’s approval, and the message leaves in this call. The sent copy is filed in your mailbox, listing the files it carried. To answer a message already in your mailbox, use os.my_mail_reply instead, so it threads.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>to\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Who the mail is to: one email address, or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Who is copied in, seen by every recipient: one address or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>bcc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Who is sent the mail unseen by any other recipient: one address or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>subject\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The subject line\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>markdown\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The body in Markdown: headings, emphasis, lists, links, quotes, code and tables. The OS sends it formatted, with a plain-text copy. Give this or text, not both\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>text\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The message, as plain text, when not given as markdown\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>html\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional HTML body beside text. Plain text is sent either way\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>from\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional sender: one of your extra addresses in this enterprise. Left out, your own address is used\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional files the mail carries: up to 10, 7 MB together. Each item names one file in one of three ways: { url, filename?, contentType? }, a public https link the OS fetches, so a screenshot or any other hosted file is attached without writing out its bytes; { emailId, attachmentId, filename?, contentType? }, a file already on a mail in your mailbox, the ids as os.my_mail_read lists them; or { filename, contentType, base64 }, the bytes inline, for a small file. A link’s or a stored file’s filename and contentType are used unless you give your own; contentType is type\u002Fsubtype, such as image\u002Fpng. Refused whole, naming the file, before anything leaves: attachments_over_limit past the limits, attachment_unreadable for a stored file that is not in your mailbox or cannot be read, attachment_invalid for an item that is not one, attachment_link_refused for a link that is not a public https one or does not answer with the file\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>signature\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>false sends without your signature. Left out, the OS adds it when you have one\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-forward\">\u003Ccode>os.my_mail_forward\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Forward one message from your own mailbox to somebody else. Pass id from os.my_mail_list and to, who it goes to. to, cc and bcc each take one address or a list of them. Everyone in to and cc sees who else the mail went to; nobody sees bcc. An address named twice gets one copy, and a mail goes to at most 50 addresses in all. Optional markdown or text (not both) is a note placed above the forwarded message, sent formatted with a plain-text copy when written as markdown, and optional from is one of your extra addresses to send from. The new message carries the original under a forwarded-message line that says who wrote it and when: its text and, when it has HTML, its formatting, sanitised, with its pictures where they were; and the original’s files, its pictures among them, go with it. Pass attachments to add more files: each by a public https link (url), by a file already on a mail in your mailbox (emailId and attachmentId), or inline as base64 for a small file. The original’s files and yours count towards the 10 files, 7 MB a mail carries: past that, or when one of them cannot be read or fetched, or an item is not one, the forward is refused naming the files, and nothing is sent. Your signature, when you have set one, is added after your note and above the forwarded message; pass signature false to leave it off. Your own mail is yours: nothing waits for anyone’s approval, and the message leaves in this call. The sent copy is filed in your mailbox in the original’s thread, and the original is marked read; its handled state does not change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list: the mail to pass on\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>to\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Who the forward is to: one email address, or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Who is copied in, seen by every recipient: one address or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>bcc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string or array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Who is sent the forward unseen by any other recipient: one address or a list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>markdown\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional note above the forwarded message, in Markdown. The OS sends it formatted, with a plain-text copy. Give this or text, not both\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>text\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional note above the forwarded message, as plain text\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>from\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional sender: one of your extra addresses in this enterprise. Left out, your own address is used\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>attachments\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional files added to the original’s, which go with the forward anyway: the original’s and these together up to 10 files, 7 MB. Each item names one file in one of three ways: { url, filename?, contentType? }, a public https link the OS fetches, so a screenshot or any other hosted file is attached without writing out its bytes; { emailId, attachmentId, filename?, contentType? }, a file already on a mail in your mailbox, the ids as os.my_mail_read lists them; or { filename, contentType, base64 }, the bytes inline, for a small file. A link’s or a stored file’s filename and contentType are used unless you give your own; contentType is type\u002Fsubtype, such as image\u002Fpng. Refused whole, naming the file, before anything leaves: attachments_over_limit past the limits, attachment_unreadable for a stored file that is not in your mailbox or cannot be read, attachment_invalid for an item that is not one, attachment_link_refused for a link that is not a public https one or does not answer with the file\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>signature\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>false sends without your signature. Left out, the OS adds it when you have one\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u002Fforward\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-delete\">\u003Ccode>os.my_mail_delete\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Delete one message from your own mailbox for good: the message, its attachments and their stored files are removed, and nothing brings them back. Pass id from os.my_mail_list. This is not the archive: to keep a mail out of the way, record it as skipped with os.my_mail_set_handled instead. An id from anyone else’s mailbox is not found.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A message id from os.my_mail_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-actions\">\u003Ccode>os.my_mail_actions\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the one-click buttons your inbox offers. Each is a task whose current version declares a mailbox action: a task of the enterprise, which os.my_mail_start_action starts over your own mailbox (taskId set), or a public Catalog template that declares one and the enterprise holds no clone of, which has to be cloned first (catalogTaskId set). on says where the button sits: mailbox, over the whole mailbox, or mail, on one message, which starts the run with that message’s id. label is the button’s words, as the task declares them. schedule is your own cadence for a button, set with os.my_mail_schedule_action, or null.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Factions\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-start-action\">\u003Ccode>os.my_mail_start_action\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Press one of the buttons os.my_mail_actions lists: start the task by its taskId, over your own mailbox. The run reads and files your mail rather than its member’s, and the runs it chains do too. For a button on one message (on mail), pass emailId, the message it is pressed on, which the run receives as its emailId input. A busy task or member makes the run wait its turn as pending rather than refusing. A template (catalogTaskId set) cannot be started until it is cloned.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task to start: a taskId from os.my_mail_actions\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>emailId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>For a button on one message: that message’s id from os.my_mail_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Factions\u002F:taskId\u002Fruns\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-schedule-action\">\u003Ccode>os.my_mail_schedule_action\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Put one of the buttons os.my_mail_actions lists on a cadence of your own: each firing presses it for you, over your own mailbox, as os.my_mail_start_action does, and the run is recorded as asked for by you. Only a button over the whole mailbox (on mailbox) can be scheduled; one on a single message needs a message. cron is five fields (*\u002F15 * * * * is every 15 minutes, *\u002F15 8-21 * * 1-5 the same on weekdays from 08:00 to 21:45); timezone is an IANA zone, or enterprise (the default) to follow the enterprise’s. enabled false keeps the cadence without firing it. Saving again changes it. A firing starts nothing while the button’s last run over your mailbox is still going, or failed and nobody cleared it, and says so in the schedule’s refusalReason.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The button to schedule: a taskId from os.my_mail_actions, on mailbox\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cron\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Five-field cron, read in timezone, such as *\u002F15 * * * *\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>timezone\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>An IANA zone such as Europe\u002FMadrid, or enterprise (the default)\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>enabled\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>false keeps the cadence without firing it (default true)\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PUT\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Factions\u002F:taskId\u002Fschedule\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-unschedule-action\">\u003Ccode>os.my_mail_unschedule_action\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Stop the cadence os.my_mail_schedule_action set for one of your inbox’s buttons. The button stays, and a run already started finishes. cleared says whether there was a cadence to stop.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The button whose cadence to stop: a taskId from os.my_mail_actions\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Factions\u002F:taskId\u002Fschedule\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-contacts\">\u003Ccode>os.my_mail_contacts\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the contacts of your own mailbox: everyone a send, reply or forward from it went to, saved as it left, and everyone you added by hand. Most recently written to first, then by name. Pass search to keep only contacts whose name or address contains it, any case: search Sarah, or acme.com, finds the address to write to. Pass directory true to add the enterprise’s own people and members who have an address, after your contacts and each only once. limit is how many rows (default 50, max 200). Mail that arrived never makes a contact, so nobody who only wrote to you is here until you write back.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>search\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only contacts whose name or address contains this, any case\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>directory\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Also offer the enterprise’s own people and members who have an address\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 200\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Rows to return. Default 50\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Fcontacts\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-contact-save\">\u003Ccode>os.my_mail_contact_save\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Save an address to the contacts of your own mailbox. Pass address and, optionally, name. A new address is added as one you saved by hand; an address already in your contacts keeps its place and history, and takes the name when you give one. A name you set here is yours: a later send never replaces it. Leave name out to keep the name a contact already has. An empty name clears it.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>address\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The contact’s email address\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The name the contact goes by. Kept over any a later send carries\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Fcontacts\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-contact-delete\">\u003Ccode>os.my_mail_contact_delete\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Remove one contact from your own mailbox. Pass id from os.my_mail_contacts; a directory row has none, since it is not one of your contacts. Only the contact goes: mail to and from the address stays. A later send to the address saves it again.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A contact id from os.my_mail_contacts\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Fcontacts\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-signature\">\u003Ccode>os.my_mail_signature\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read your own mailbox’s signature: what the OS adds after the body of every mail you send, reply or forward, from the portal, the API or MCP, unless that send says signature false. Its html is the signature as you formatted it, sanitised; its text is the plain-text form, which a mail’s text part carries under a \u003Ccode>-- \u003C\u002Fcode> line. Both are empty when you have no signature. With none of your own, your mail is signed with the enterprise’s signature template, filled in with your name, title and address, unless useTemplate is false. Mail from one of your extra addresses carries that address’s own signature instead, when it has one: see os.my_mail_addresses.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Fsignature\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-signature-set\">\u003Ccode>os.my_mail_signature_set\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Set your own mailbox’s signature, which the OS adds after the body of every mail you send, reply or forward. Pass html for a formatted signature (bold, links, a few lines): it is sanitised to what mail may carry, and its plain-text form is derived from it, with each link written after its words. Or pass text alone for a plain signature. With html given, text is ignored. Each is at most 20 KB. Pass both empty to clear the signature: your mail then leaves with the enterprise’s signature template, filled in for you, or with none when there is no template or useTemplate is false. Pass useTemplate false to send with no signature at all while you have none of your own, true to use the template again; left out, it stays as it was. Given without html or text, your signature stays as it is. To sign mail from one of your extra addresses differently, use os.my_mail_address_signature_set.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>html\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The signature as HTML. Sanitised; its text form is derived\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>text\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The signature as plain text, used when no html is given\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>useTemplate\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Whether the enterprise’s signature template signs your mail while you have no signature of your own\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PUT\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Fsignature\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-addresses\">\u003Ccode>os.my_mail_addresses\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the extra addresses of your own mailbox: the further addresses at the enterprise’s domains an owner gave you, which deliver to your mailbox and which you can send from by naming one as \u003Ccode>from\u003C\u002Fcode> on os.my_mail_send or os.my_mail_forward. Your own address is not listed. Each comes with replyFromAlias and its own signature, which a mail leaving from that address carries in place of your mailbox’s; null means it signs as your mailbox does (os.my_mail_signature). Set or clear one with os.my_mail_address_signature_set. Adding and removing an address is an owner’s, on People.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Faliases\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-my-mail-address-signature-set\">\u003Ccode>os.my_mail_address_signature_set\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Set the signature of one of your own extra addresses: what the OS adds after the body of a mail you send or forward from that address, and of a reply that leaves from it, in place of your mailbox’s signature, unless that send says signature false. Pass id from os.my_mail_addresses, and html for a formatted signature: it is sanitised to what mail may carry, and its plain-text form is derived from it, with each link written after its words. Or pass text alone for a plain signature. With html given, text is ignored. Each is at most 20 KB. Pass both empty, or leave both out, to clear it: mail leaving from that address then carries your mailbox’s signature (os.my_mail_signature), or with none of your own, the enterprise’s signature template unless you switched it off, or nothing.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>An address id from os.my_mail_addresses\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>html\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The signature as HTML. Sanitised; its text form is derived\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>text\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The signature as plain text, used when no html is given\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PUT\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmail\u002Faliases\u002F:id\u002Fsignature\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>mail:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-get-enterprise-kpis\">\u003Ccode>os.get_enterprise_kpis\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>The company's KPI targets as set: unit, target and direction, AMBER band, cadence and source. A KPI waiting for a target has targetValue null. Each KPI carries signedOffAt: null while it waits for a person to sign it off, and until then no run sees it or records a reading for it.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fenterprise\u002Fkpi-targets\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>enterprise:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-set-enterprise-kpis\">\u003Ccode>os.set_enterprise_kpis\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Replace the company's complete KPI target list. A target needs its unit, direction, cadence and source; a no-target KPI is accepted. Uses the same validation as the portal. The answer's awaitingSignOff names every KPI still waiting for sign-off, or is null: an API token never signs a KPI off, so a KPI it adds or changes waits for a person.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kpis\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The complete KPI target list. Every item is validated by the API.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fenterprise\u002Fkpi-targets\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>enterprise:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-get-team-kpis\">\u003Ccode>os.get_team_kpis\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>A team's own KPI targets as set, including which one is its key KPI. This is the target list, not the role and task KPI tree. Each KPI carries signedOffAt: null while it waits for a person to sign it off, and until then no run sees it or records a reading for it.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team whose KPI targets are read.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:teamId\u002Fkpi-targets\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-set-team-kpis\">\u003Ccode>os.set_team_kpis\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Replace a team's complete KPI target list. Two key KPIs are refused; a list with none marked is stored with no key KPI. Uses the same validation as the portal. The answer's awaitingSignOff names every KPI still waiting for sign-off, or is null: an API token never signs a KPI off, so a KPI it adds or changes waits for a person.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team whose KPI targets are replaced.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kpis\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The complete KPI target list. Every item is validated by the API.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:teamId\u002Fkpi-targets\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"role-list-kpis\">\u003Ccode>role.list_kpis\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>A role's KPIs, oldest first: each one's target, direction, AMBER band, cadence, source, the team KPI it serves (servesName names it; served is false for one that serves none), whether a person has signed it off, its light and trend (null until it is signed off) and its readings. Not found for a role in another enterprise.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>roleId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role whose KPIs to list.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:roleId\u002Fkpis\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"role-define-kpi\">\u003Ccode>role.define_kpi\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Propose a KPI on a role, with the same fields as a KPI on any other layer. It waits for a person to sign it off, and until then draws no light and takes no reading. A KPI may serve only a team’s KPI, any team’s, since a role is held across teams (400 role_kpi_serves_non_team otherwise); leave servesKpiId out for one that serves none. The response is the role's KPIs after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>roleId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role the KPI belongs to.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>What is measured, up to 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>targetValue\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>number\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The target, in the KPI’s own unit. Set it with targetDirection, or leave both out for no target.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>targetDirection\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>at_least\u003C\u002Fcode>, \u003Ccode>at_most\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>at_least when higher is better, at_most when lower is better.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>amberBand\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>number, at least 0\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How far past the target still reads AMBER rather than RED.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>onTargetWorseningRule\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>true to read AMBER when on target but worse than the reading before.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cadenceMinutes\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How often it is read, in minutes; a reading older than this is overdue.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>servesKpiId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The KPI of the role’s own team this one serves.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>sourceKind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>task\u003C\u002Fcode>, \u003Ccode>person\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where readings come from: task (a task records them) or person (entered by hand).\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>sourceRef\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The task id, or the person’s human-user id, sourceKind names.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:roleId\u002Fkpis\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"role-edit-kpi\">\u003Ccode>role.edit_kpi\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Change a role KPI's fields; the ones left out keep their value. A KPI a person has signed off is changed only by a person, so this is refused with 403 kpi_signed_off_person_only for it. The response is the role's KPIs after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>roleId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role the KPI belongs to.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>What is measured, up to 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>targetValue\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>number\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The target, in the KPI’s own unit. Set it with targetDirection, or leave both out for no target.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>targetDirection\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>at_least\u003C\u002Fcode>, \u003Ccode>at_most\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>at_least when higher is better, at_most when lower is better.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>amberBand\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>number, at least 0\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How far past the target still reads AMBER rather than RED.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>onTargetWorseningRule\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>true to read AMBER when on target but worse than the reading before.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cadenceMinutes\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How often it is read, in minutes; a reading older than this is overdue.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>servesKpiId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The KPI of the role’s own team this one serves.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>sourceKind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>task\u003C\u002Fcode>, \u003Ccode>person\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where readings come from: task (a task records them) or person (entered by hand).\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>sourceRef\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The task id, or the person’s human-user id, sourceKind names.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kpiId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The KPI to change.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:roleId\u002Fkpis\u002F:kpiId\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-waiting\">\u003Ccode>os.list_waiting\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Every piece of open work nothing is working on, as the Waiting list shows it: one row per issue, pull request or work item whose last run has ended, with no live or queued run, no decision waiting and nothing on Blockers, that is not finished: its last run did not end on an outcome its task declares as finishing the work, nobody has marked it finished, and no person cancelled its last run. Work stays listed however old it is. Read-only: nothing is restarted or finished. Pass no arguments.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fwaiting\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-built-in-tools\">\u003Ccode>os.list_built_in_tools\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List every built-in tool a run can call: its name, a one-line summary, and its effect (read or write). A task may declare a built-in tool (os.\u003Cem>, workspace.\u003C\u002Fem>, memory.\u003Cem>, web.\u003C\u002Fem>) only from this list: saving a task that names any other is refused, as a tool that does not exist (tool_unknown) or one only the CEO chat offers (tool_not_run_callable). A row with gate is a tool a task may hold only if it also declares a CEO gate on the tool gate names: saving it without that gate is refused (gate_required_for_tool). Vendor tools are not here: os.list_tool_bindings lists what the enterprise has bound. Takes no arguments.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftools\u002Fbuilt-in?callable=run\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tools:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-chat-list\">\u003Ccode>os.chat_list\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List chat threads, most recently active first: each thread’s id, its state (idle, replying or closed), and its last message. In a run these are the enterprise owner’s threads with the member doing the run, the ones the OS files into: never another person’s private chats, and memberId is ignored. Over the API they are the threads you own, or only one member’s when you pass memberId. No message bodies beyond the last: read a thread with os.chat_read. A conversation opened for one job, such as designing a task, is never listed.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Over the API: only threads with this member. A run always lists its own member’s.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fchats\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>chats:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-chat-read\">\u003Ccode>os.chat_read\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one chat thread: its messages, oldest first, each with who wrote it. Pass id from os.chat_list, and optionally limit to read only the newest messages (up to 200). In a run you get what was said (people’s messages and the member’s), the newest 50 unless you pass limit, in one of the threads os.chat_list shows you, and reading does not mark the thread read. Over the API you get every row, tool calls included, in a thread you own or reach by its link, and reading marks it read for its owner, as opening it in the portal does.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A thread id from os.chat_list\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 200\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only the newest messages, up to 200. In a run it defaults to 50; over the API, to all of them.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fchats\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>chats:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-chat-write\">\u003Ccode>os.chat_write\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Write one message in a chat thread, as yourself. Pass content: Markdown. In a run you write as the member doing the run, for the enterprise’s people to read, and it is drawn as the member’s formatted text: paragraphs with their line breaks kept, bulleted and numbered lists, bold, and links, written \u003Ca href=\"https:\u002F\u002Fxn--rvg\">text\u003C\u002Fa> or as a bare web address. It shows as unread until someone opens the thread, nobody replies to the run, and the run carries on. Leave id out to write in the enterprise owner’s open thread with the member (one the owner owns is opened if there is none), or pass id from os.chat_list. At most 4000 characters in a run. For a question you need answered, use os.ask_ceo. Over the API, id is required, you write as the person or token calling, shown as you typed it with web addresses linked, and the member replies: the response is the thread with that reply in it. Sends no mail and opens no gate. A repeat writes the message again.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The thread, from os.chat_list. A run may leave it out to write in the enterprise owner’s open thread with its member. Required over the API.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>content\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The message, as Markdown\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fchats\u002F:id\u002Fmessages\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>chats:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-chat-open\">\u003Ccode>os.chat_open\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Open a new, empty chat thread with a member, and get its id to write in with os.chat_write. Pass memberId. Nothing is said and nothing is spent until a message is written. A run cannot call it: a run’s os.chat_write opens its member’s thread when there is none.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The member to talk to\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fchats\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>chats:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-start-task\">\u003Ccode>os.start_task\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Start a run of a task of a role you hold, an OS task, or a colleague’s task. Pass taskId or slug, and input matching the task’s fields; a field you leave out takes the task’s default. The run goes to a free member holding the task’s role, who may not be you; when every holder is busy it queues as pending. This only queues the run: check it with os.get_run before reporting on it.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The task id; pass exactly one of taskId or slug.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>slug\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The task slug; pass exactly one of taskId or slug.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>input\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Input matching the task fields.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>idempotencyKey\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Required over MCP\u002FAPI: a stable key for this start, at most 200 characters. Reuse on retries; use a new key for new work.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-read-run-log\">\u003Ccode>os.read_run_log\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read the retained log of a run in this enterprise, including earlier tool results and failure diagnostics that are no longer in its recent events. Pass a real runId from os.list_runs or os.get_run. Read from offset 0, then follow nextOffset until null; each slice is at most 16000 characters. A missing log is an evidence gap, not proof that no failure occurred. Read-only; never retries, routes, clears or changes a run.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The run id.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>offset\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 0\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Character offset, from 0; use the previous nextOffset to continue.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 16000\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Characters to read, up to 16000. Defaults to 8000.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Flog-slice\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-enterprise-kpis\">\u003Ccode>os.list_enterprise_kpis\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List every KPI of the enterprise, whatever layer owns it and whether or not it has been signed off, ordered by name then id. Each row carries its id (the kpiId the readings tools take), name, owner (layer and id), source (kind and ref), target (value, direction, AMBER band, on-target-worsening rule), cadence, current light, whether it is overdue, when it was signed off (null while it waits for sign-off, when it takes no reading), and its latest reading. The light is null when the KPI has no target or no reading yet. No arguments. Never another enterprise's KPIs.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fkpis\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>kpis:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-finish-waiting\">\u003Ccode>os.finish_waiting\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Mark one piece of work on the Waiting list finished, as its Mark finished button does. Pass pipeline as os.list_waiting names it. The finish is recorded on the work’s newest run, attributed to you (a task’s call is attributed to its run), and takes it off the list; no run is started or stopped, and the issue or pull request is not touched. Refused when the work is not on the list, or when its execution is still doing other work. A later run on the same pipeline lists it again once that run ends.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>pipeline\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The work, as \u003Ccode>owner\u002Fname#&lt;number&gt;\u003C\u002Fcode>, the way os.list_waiting names it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fwaiting\u002Ffinish\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-restart-waiting\">\u003Ccode>os.restart_waiting\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Restart one piece of work on the Waiting list at a step, as its Restart button does. Pass pipeline as os.list_waiting names it, and task: the slug of the step to run. The same task as the newest run retries it; another task of its pipeline routes the work there. The new run is open, so the work leaves the list, and the newest run records that you restarted it and where. Refused when the work is not on the list. A task’s restart is attributed to its run. Every restart is refused while the work’s execution is still doing other work, and preserves os.retry_run’s existing cap: a chain may be retried, routed or restarted 3 times; past that, escalate it.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>pipeline\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The work, as \u003Ccode>owner\u002Fname#&lt;number&gt;\u003C\u002Fcode>, the way os.list_waiting names it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>task\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The slug of the task to run: the newest run’s own task to retry it, or another task of its pipeline.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fwaiting\u002Frestart\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-clear-blocker\">\u003Ccode>os.clear_blocker\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Take one stopped run off Blockers without running it again, because nothing more is needed: its issue or pull request is closed, merged or parked, or it is a stale escalation nobody has to decide. A failed run, or one that finished on an outcome nothing follows, is cleared; a blocked run is cancelled. Pass runId as os.list_blockers names it, and note: why nothing more is needed, recorded on the run with your name. Choose workItemState: done only when you verified the work is complete, dropped when no longer wanted, ready only when it should be picked up again, or held to keep it parked. Omitted means held; clearing alone never requeues or completes work. A later run keeps its item.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The run id, as os.list_blockers names it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>workItemState\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>held\u003C\u002Fcode>, \u003Ccode>ready\u003C\u002Fcode>, \u003Ccode>done\u003C\u002Fcode>, \u003Ccode>dropped\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>What happens to the stopped pipeline’s work item: held (default), ready to retry, done when verified complete, or dropped when no longer wanted.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>note\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Why nothing more is needed, in one line.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Fclear-stopped\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-inspect-task-contract\">\u003Ccode>os.inspect_task_contract\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read the task and exact version a source run was pinned to (default version: pinned), or version: current for comparison. Includes structured outcome\u002Ffinish contract, successors with conditions and caps, tools and approval gates. Skill text is paged (offset in characters, limit up to 16000), with its content hash and exact version provenance. A repaired current task does not change a historical pinned contract. No binding values, checkpoints or storage addresses.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The source run id in this enterprise.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>version\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>pinned\u003C\u002Fcode>, \u003Ccode>current\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Pinned historical contract (default) or current task version.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>offset\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 0\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Offset from the previous nextOffset; starts at zero.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 16000\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Skill characters per page, defaults to 4000.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Ftask-contract\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-inspect-execution\">\u003Ccode>os.inspect_execution\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read the source execution graph with version provenance, runs, causal links, paged event headers and latest continuation. Inspect the latest continuation before routing or escalating: pending and running work must not be restarted. Raw input, ceoAnswers, payloads, credentials and checkpoints are omitted. Acceptance of a continuation is separate from validation and delivery.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The source run id in this enterprise.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>offset\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 0\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Offset from the previous nextOffset; starts at zero.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 100\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Event headers per page, at most 100; defaults to 25.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Fexecution-evidence\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-preview-run-route\">\u003Ccode>os.preview_run_route\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List actual supported recovery targets for this source run, or validate task (a target slug). Reports supported\u002Fallowed and actionable refusal, latest continuation and the unchanged retry limit. A preview is read-only and reserves nothing. os.route_run revalidates at acceptance; caps, spend and gates still apply. Workflow contract defects go to the workflow owner, never an invented application test stage.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The source run id in this enterprise.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>task\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Optional target slug to validate; omit to list supported targets.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Froute-preview\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-export-workflow-evidence\">\u003Ccode>os.export_workflow_evidence\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Export pinned\u002Fcurrent structured task contracts with text hashes, execution graph, causal history and route diagnostics. Includes capture time, exact provenance, pagination and explicit omissions. Omits skill prose, raw inputs\u002FceoAnswers, tool and result payloads, binding values, checkpoints and storage addresses. Follow execution.history.nextOffset; inspect_task_contract explicitly pages skill text when needed.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The source run id in this enterprise.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>offset\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 0\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Offset from the previous nextOffset; starts at zero.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 100\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Event headers per page, at most 100; defaults to 25.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fruns\u002F:runId\u002Fworkflow-export\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>runs:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-roles\">\u003Ccode>os.list_roles\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the enterprise's roles, ordered by slug: each one's id, name and slug. A role is a job across the enterprise, held by members on any team; it belongs to no team. No arguments. Never another enterprise's roles.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-read-role\">\u003Ccode>os.read_role\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one role: its name and slug, the members who hold it (members), the teams those members sit on (teams, each with its holders), and the tasks that run as it (tasks). Not found for a role in another enterprise.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-create-role\">\u003Ccode>os.create_role\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Create a role with a name and, optionally, a slug. A slug left out is made from the name. A slug, or a name with no slug, another role already has is refused with role_slug_taken. A role belongs to no team: it is held by members, every holder runs the role’s tasks on whatever team they sit, and a team runs the tasks of the roles its members hold. The response is the role as created.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role’s name, up to 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>slug\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The role’s slug, unique in the enterprise. Made from the name when left out.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-update-role\">\u003Ccode>os.update_role\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Change a role's name or slug; a field left out keeps its value. A slug another role already has is refused with role_slug_taken. The response is the role after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The role’s new name, up to 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>slug\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The role’s new slug, unique in the enterprise. A task names its role by this slug.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-delete-role\">\u003Ccode>os.delete_role\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Remove a role. A role a member still holds, or a task still runs as, is refused with role_has_dependents, naming each: take them off it first. The call is the confirmation, so the tool takes no confirm argument.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id?confirm=true\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-add-role-task\">\u003Ccode>os.add_role_task\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Give a role a task: the task runs as this role from now on, in place of any role it ran as before. The response is the role after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task that runs as the role.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id\u002Ftasks\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-remove-role-task\">\u003Ccode>os.remove_role_task\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Take a task away from a role: the task runs as no role until it is given one. A task that does not run as this role is refused with task_not_on_role. The response is the role after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>taskId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task to take off the role.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id\u002Ftasks\u002F:taskId\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-add-role-member\">\u003Ccode>os.add_role_member\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Give a role a member: the member holds the role from now on. The response is the role after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The member who holds the role.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id\u002Fmembers\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-remove-role-member\">\u003Ccode>os.remove_role_member\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Take a member away from a role: the member no longer holds it. The response is the role after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The member to take off the role.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Froles\u002F:id\u002Fmembers\u002F:memberId\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>roles:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-task-definitions\">\u003Ccode>os.list_task_definitions\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the enterprise's tasks, a page at a time: the ones it wrote or copied, and the OS's built-in tasks every enterprise runs. Each row carries its id, slug, name, kind, status, origin, builtIn (true for a shared built-in definition, false for one of the enterprise’s own), its role and the teams that inherit it (teams: the teams where a member holds that role), currentVersionId and currentVersion (its version number and declared fields). Narrow it with search (slug, name or role), kind, status, origin, teamId, assigneeRole, memberId, name or slug, and sort it by slug, name, kind, status, createdAt or updatedAt. Read one task in full, its skill text included, with os.read_task_definition. The response is { data, total, page, limit, pages }. Never another enterprise's tasks.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>search\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only tasks whose slug, name or role contains this text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>llm\u003C\u002Fcode>, \u003Ccode>deterministic\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only tasks of this kind.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>active\u003C\u002Fcode>, \u003Ccode>deprecated\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only tasks in this status.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>origin\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>tenant\u003C\u002Fcode>, \u003Ccode>os\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>tenant for the enterprise’s own tasks, os for the built-in ones.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only the tasks of the roles held on this team, by a seated member or its lead.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>assigneeRole\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only the tasks that run as this role, by its slug.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only the tasks of the roles this member holds in the enterprise.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only tasks whose name contains this text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>slug\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only tasks whose slug contains this text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>sort\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>slug\u003C\u002Fcode>, \u003Ccode>name\u003C\u002Fcode>, \u003Ccode>kind\u003C\u002Fcode>, \u003Ccode>status\u003C\u002Fcode>, \u003Ccode>createdAt\u003C\u002Fcode>, \u003Ccode>updatedAt\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The field to sort by. Defaults to slug.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>order\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>asc\u003C\u002Fcode>, \u003Ccode>desc\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The sort direction. Defaults to desc.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>page\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The page to read, from 1. Defaults to 1.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 200\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Tasks per page, up to 200. Defaults to 25.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-read-task-definition\">\u003Ccode>os.read_task_definition\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one of the enterprise's tasks in full, as it is live now: its skill text (skillMd), its current version (currentVersion, with its version number and its declared fields, inputs) and currentVersionId, the identity of that version, which a later change to the task names as the version it builds on, and this enterprise's own values for those inputs (inputValues). It also says whether the task is a shared built-in definition (builtIn), and carries its role, the teams that inherit it (teams: the teams where a member holds that role), its predecessors and successors. Pass id, from os.list_task_definitions. Not found for a task in another enterprise.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task, by its id from os.list_task_definitions.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-create-task\">\u003Ccode>os.create_task\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Create one of the enterprise’s own tasks. Pass name, goal, metric ({ text }) and skillMd. A slug left out is made from the name. kind defaults to llm, and status and runStatus default to active. Leave gates out and the task is given the default CEO gates; send gates as [] to declare none. A task that declares this tool is refused when it is saved. A task reaches it only through a bound connection to the OS’s own MCP server, with a gate naming the tool, as with every write that server serves. The OS’s built-in tasks are created with a release, never through this tool, and a slug one of them holds is reserved. Give the task to a role with assigneeRole: a task belongs to a role, not a team, and a team runs it by seating a holder of that role. Over this tool the create is refused with definition_issues, and nothing is saved, while the definition carries a routing issue: outcome_not_routed, named with the word (the skill tells a run to end on an outcome that no successor, finishesOn entry or plain success handles), self_loop_unconditional (a successor back to its own slug with no delayMinutes, other than ceo_approved or ceo_changes_requested), or asks_ceo_without_resume (it asks the CEO, does more work after the answer, and has no ceo_approved successor back to its own slug). Fix each and create it again. The response is the task as created, including id and currentVersionId.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task’s name, trimmed, at most 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>slug\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A slug of letters, digits and hyphens, at most 80 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>llm\u003C\u002Fcode>, \u003Ccode>deterministic\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>llm or deterministic. A deterministic task has no tools.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>active\u003C\u002Fcode>, \u003Ccode>deprecated\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>active or deprecated.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>assigneeRole\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The role whose holders run the task, by the role’s slug. A task is given to a role, never a team: every holder of the role runs it, on whatever team they sit, and a team runs the tasks of the roles its members hold. assigneeMemberId is refused.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>goal\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>What the task is for, in one or two sentences.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>metric\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>How the task is judged, as { text }.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>guardrails\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Sentences the task must hold to. Each item is plain text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>tools\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The tools the task may call. Each item is a tool name, as a string, such as &quot;acme.merge_pull_request&quot;. An entry that is an object, including one carrying its own gates or marked optional, cannot be sent through this tool: sending tools replaces them all, so leave tools out to keep the current ones.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>inputs\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The inputs, as { key, label, type, required?, configuration?, requiredGroup?, entries? }. type is string, number, boolean, link or file. configuration marks persistent enterprise setup. requiredGroup requires at least one input in the group; every member must agree on configuration. A string map may declare entries: { keyInput, separator }: comma-separated key\u002Fvalue entries must cover the resolved keyInput at each start. Missing required configuration prevents a run from starting.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>gates\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Gates on tools that reach outside. Each object is { tool, owner, approval }. On create, leave it out and the task is given the default CEO gates; on publish, leave it out and the current gates stay. Send [] to declare none, which is refused when a tool still requires a gate.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>spend\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Spend limits, as { moneyUsdPerRun, maxModelTier, model, maxSteps }. Leave model out, or send &quot;auto&quot;, and a model is chosen for each run by what the work needs, no higher than maxModelTier (economical, mid or frontier) when that is set. Send an exact model id as model to use that model for every run. maxSteps is how many steps a run gets, a whole number from 1 to 400; leave it out for the default for the tool shape (24, or 120 with workspace or Computer-Use tools). The run input maxSteps and the operator setting LLM_MAX_STEPS still win over it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>workspace\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The clone the task may change, as { branch, onDefaultBranch, writeAllow, rewriteAllow, writeDeny, appendOnly, pushAllow, requireFiles, credentials }. Each list is strings but \u003Ccode>credentials\u003C\u002Fcode>, which is [{ tool, as, prop? }]: a bound tool's secret (or its custom prop) as the environment variable \u003Ccode>as\u003C\u002Fcode> of the run's repository commands; \u003Ccode>onDefaultBranch: true\u003C\u002Fcode> keeps the run on the default branch's tip, with no branch of its own and nothing to push; \u003Ccode>pushAllow\u003C\u002Fcode> lists the full ref globs (\u003Ccode>refs\u002Fheads\u002Fmain\u003C\u002Fcode>, \u003Ccode>refs\u002Ftags\u002Fv*\u003C\u002Fcode>) a run may push with \u003Ccode>workspace.git_push\u003C\u002Fcode>'s \u003Ccode>ref\u003C\u002Fcode> besides its own branch, and needs \u003Ccode>writeAllow\u003C\u002Fcode>.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>successors\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>What runs after this task. Each object is { slug, on, when, delayMinutes, maxRunsPerIssue, escalate, verificationAnyOf }. on is succeeded, failed or terminal.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>finishesOn\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Outcome names that finish the work. Each item is plain text, at most 16.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>maxRunsPerExecution\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The most countable runs this task may have in one execution before its next start is logged or stopped, a whole number of at least 1. Counted per task across the execution, whichever handoff started each run. Never applied below the highest maxRunsPerIssue on a successor into the task. Left out on create, or never set, EXECUTION_MAX_TASK_RUNS applies; left out on publish, the current value stays.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>toolSlots\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Tool slots the task’s tools may be named by in place of one vendor’s tool type, at most 16. Each object is { key, label, description?, actions? }: key reads like a tool type (codehost), label is what a person choosing a binding reads. A tool named &quot;codehost&quot; or &quot;codehost.&lt;tool&gt;&quot; is then filled per enterprise by the binding that lists codehost among the slots it fills, and runs as that binding’s tool type. actions is a list of { name, description? }, at most 32, the actions the task names under the key (&quot;codehost.pr.merge&quot;); the filling binding maps each to one of its own tools, so the task names no vendor’s tool.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>callLimits\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How often one run may make a call, at most 16. Each object is { tool, match?, perRun }: tool is one tool the task’s tools reach, by its exact name (&quot;acme.issue_write&quot;); match names payload fields the call must carry to count, as a gate’s match does ({ &quot;method&quot;: &quot;create&quot; }); perRun is a whole number of at least 1. A call past the limit is not sent, and the run reads call_limit_reached instead.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>mailboxAction\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where a mailbox offers this task as a one-click button, as { on, label }. on is mailbox (a button above the mailbox’s list; the run starts with no input of the OS’s) or mail (a button on one open message; the run starts with that message’s id as its emailId input, so the task has to declare an input with that key). label is the button’s words, at most 40 characters. A public template that declares one is offered to clone on inboxes that have no such task yet. Leave it out to offer none.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>skillMd\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The skill text, markdown, telling the model how to do the job.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>contextPrefixes\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Key prefixes loaded into input.context when a run starts. Each item is plain text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>trainGrants\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Team or enterprise notes a run of this task may write. Each object is { layer, eventIdPrefix }, layer team or enterprise. A team note goes to each team the running member sits on or leads.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>overlapPolicy\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>skip\u003C\u002Fcode>, \u003Ccode>os\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>skip waits behind the member’s other work. os runs beside it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>serializeOn\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Input keys that partition this task’s work into lanes, up to 8. Each item is plain text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runStatus\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>active\u003C\u002Fcode>, \u003Ccode>disabled\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>active, the default, or disabled. disabled keeps runs from starting.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-publish-task-version\">\u003Ccode>os.publish_task_version\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Publish a new version of one of the enterprise’s tasks. Pass id and baseVersionId, the currentVersionId from os.read_task_definition. Send only the fields that change: a field left out keeps its current value. Sending null does not clear a field through this tool, because a null argument is dropped. Clear inputs, workspace, successors, finishesOn, toolSlots, callLimits, mailboxAction or maxRunsPerExecution over HTTP by sending null. name, slug, assigneeRole, serializeOn, status and kind change the task at once and are not part of the version. A save that changes nothing returns the current version with unchanged true. visibility public publishes the version to the catalog, listed on the task’s role when the enterprise has published that role, and private withdraws it and records the task as left out; either also needs catalog:write. Once the task is in the catalog, every version published after goes there too without visibility; a version the catalog refuses is still saved, and catalogPublication says why the catalog kept its version. A task that declares this tool is refused when it is saved. A task reaches it only through a bound connection to the OS’s own MCP server, with a gate naming the tool, as with every write that server serves, and a run cannot publish the task it is running (self_publish_refused). The OS’s built-in tasks are not edited this way. Give the task to a role with assigneeRole; a task has no team. A version that carries a routing issue is still saved, and definitionIssues lists each as a warning: outcome_not_routed, named with the word (the skill ends on a word no successor or finishesOn entry handles), self_loop_unconditional (a successor back to its own slug with no delayMinutes) or asks_ceo_without_resume (it asks the CEO and works on after the answer with no ceo_approved successor back to itself). The response is the version, and its id is the next baseVersionId.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task, by its id from os.list_task_definitions.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>baseVersionId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The currentVersionId this change was read from.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The task’s name, trimmed, at most 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>slug\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A slug of letters, digits and hyphens, at most 80 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>llm\u003C\u002Fcode>, \u003Ccode>deterministic\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>llm or deterministic. A deterministic task has no tools.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>status\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>active\u003C\u002Fcode>, \u003Ccode>deprecated\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>active or deprecated.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>assigneeRole\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The role whose holders run the task, by the role’s slug. A task is given to a role, never a team: every holder of the role runs it, on whatever team they sit, and a team runs the tasks of the roles its members hold. assigneeMemberId is refused.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>goal\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>What the task is for, in one or two sentences.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>metric\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How the task is judged, as { text }.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>guardrails\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Sentences the task must hold to. Each item is plain text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>tools\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The tools the task may call. Each item is a tool name, as a string, such as &quot;acme.merge_pull_request&quot;. An entry that is an object, including one carrying its own gates or marked optional, cannot be sent through this tool: sending tools replaces them all, so leave tools out to keep the current ones.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>inputs\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The inputs, as { key, label, type, required?, configuration?, requiredGroup?, entries? }. type is string, number, boolean, link or file. configuration marks persistent enterprise setup. requiredGroup requires at least one input in the group; every member must agree on configuration. A string map may declare entries: { keyInput, separator }: comma-separated key\u002Fvalue entries must cover the resolved keyInput at each start. Missing required configuration prevents a run from starting.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>gates\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Gates on tools that reach outside. Each object is { tool, owner, approval }. On create, leave it out and the task is given the default CEO gates; on publish, leave it out and the current gates stay. Send [] to declare none, which is refused when a tool still requires a gate.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>spend\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Spend limits, as { moneyUsdPerRun, maxModelTier, model, maxSteps }. Leave model out, or send &quot;auto&quot;, and a model is chosen for each run by what the work needs, no higher than maxModelTier (economical, mid or frontier) when that is set. Send an exact model id as model to use that model for every run. maxSteps is how many steps a run gets, a whole number from 1 to 400; leave it out for the default for the tool shape (24, or 120 with workspace or Computer-Use tools). The run input maxSteps and the operator setting LLM_MAX_STEPS still win over it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>workspace\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The clone the task may change, as { branch, onDefaultBranch, writeAllow, rewriteAllow, writeDeny, appendOnly, pushAllow, requireFiles, credentials }. Each list is strings but \u003Ccode>credentials\u003C\u002Fcode>, which is [{ tool, as, prop? }]: a bound tool's secret (or its custom prop) as the environment variable \u003Ccode>as\u003C\u002Fcode> of the run's repository commands; \u003Ccode>onDefaultBranch: true\u003C\u002Fcode> keeps the run on the default branch's tip, with no branch of its own and nothing to push; \u003Ccode>pushAllow\u003C\u002Fcode> lists the full ref globs (\u003Ccode>refs\u002Fheads\u002Fmain\u003C\u002Fcode>, \u003Ccode>refs\u002Ftags\u002Fv*\u003C\u002Fcode>) a run may push with \u003Ccode>workspace.git_push\u003C\u002Fcode>'s \u003Ccode>ref\u003C\u002Fcode> besides its own branch, and needs \u003Ccode>writeAllow\u003C\u002Fcode>.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>successors\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>What runs after this task. Each object is { slug, on, when, delayMinutes, maxRunsPerIssue, escalate, verificationAnyOf }. on is succeeded, failed or terminal.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>finishesOn\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Outcome names that finish the work. Each item is plain text, at most 16.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>maxRunsPerExecution\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The most countable runs this task may have in one execution before its next start is logged or stopped, a whole number of at least 1. Counted per task across the execution, whichever handoff started each run. Never applied below the highest maxRunsPerIssue on a successor into the task. Left out on create, or never set, EXECUTION_MAX_TASK_RUNS applies; left out on publish, the current value stays.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>toolSlots\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Tool slots the task’s tools may be named by in place of one vendor’s tool type, at most 16. Each object is { key, label, description?, actions? }: key reads like a tool type (codehost), label is what a person choosing a binding reads. A tool named &quot;codehost&quot; or &quot;codehost.&lt;tool&gt;&quot; is then filled per enterprise by the binding that lists codehost among the slots it fills, and runs as that binding’s tool type. actions is a list of { name, description? }, at most 32, the actions the task names under the key (&quot;codehost.pr.merge&quot;); the filling binding maps each to one of its own tools, so the task names no vendor’s tool.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>callLimits\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How often one run may make a call, at most 16. Each object is { tool, match?, perRun }: tool is one tool the task’s tools reach, by its exact name (&quot;acme.issue_write&quot;); match names payload fields the call must carry to count, as a gate’s match does ({ &quot;method&quot;: &quot;create&quot; }); perRun is a whole number of at least 1. A call past the limit is not sent, and the run reads call_limit_reached instead.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>mailboxAction\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where a mailbox offers this task as a one-click button, as { on, label }. on is mailbox (a button above the mailbox’s list; the run starts with no input of the OS’s) or mail (a button on one open message; the run starts with that message’s id as its emailId input, so the task has to declare an input with that key). label is the button’s words, at most 40 characters. A public template that declares one is offered to clone on inboxes that have no such task yet. Leave it out to offer none.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>skillMd\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The skill text, markdown, telling the model how to do the job.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>contextPrefixes\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Key prefixes loaded into input.context when a run starts. Each item is plain text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>trainGrants\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of objects\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Team or enterprise notes a run of this task may write. Each object is { layer, eventIdPrefix }, layer team or enterprise. A team note goes to each team the running member sits on or leads.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>overlapPolicy\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>skip\u003C\u002Fcode>, \u003Ccode>os\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>skip waits behind the member’s other work. os runs beside it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>serializeOn\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Input keys that partition this task’s work into lanes, up to 8. Each item is plain text.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>allowSelfReaction\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Kept for versions written before it was retired: the OS no longer reads it, and a reaction is a call like any other. Leave it out.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>visibility\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>public\u003C\u002Fcode>, \u003Ccode>private\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>public publishes this version to the catalog, private withdraws it. Either also needs catalog:write. Left out, a task already in the catalog sends this version there too, and any other task changes only itself.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u002F:id\u002Fversions\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-set-task-run-status\">\u003Ccode>os.set_task_run_status\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Set runStatus to active or disabled. Enabling permits future starts; it does not start a run. Disabling prevents future starts without cancelling work already running. Built-in task controls remain protected by the API.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task id from os.list_task_definitions.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>runStatus\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>active\u003C\u002Fcode>, \u003Ccode>disabled\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Whether the task may start.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u002F:id\u002Frun-status\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-set-task-schedule\">\u003Ccode>os.set_task_schedule\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Replace a task schedule. Pass cron, optionally an IANA timezone (otherwise the enterprise timezone), enabled (defaults to true), and input matching the task fields. The API validates the schedule and refuses built-in tasks. A disabled task still cannot run. Read the schedule back with os.read_task_definition.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task id from os.list_task_definitions.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>cron\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A five-field cron expression.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>timezone\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>An IANA timezone, or enterprise to follow the enterprise timezone.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>enabled\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>boolean\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Whether the schedule should fire. Defaults to true.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>input\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Inputs supplied on each scheduled run.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PUT\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u002F:id\u002Fschedule\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-remove-task-schedule\">\u003Ccode>os.remove_task_schedule\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Remove a task schedule so it no longer starts work on a cadence. Does not cancel existing runs. Built-in tasks are refused by the API.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task id from os.list_task_definitions.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u002F:id\u002Fschedule\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-set-task-input-values\">\u003Ccode>os.set_task_input_values\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Replace this enterprise's own values for the inputs a task declares, keyed by input key; pass {} to clear them. Every run of the task takes them, however it starts: a value the start gives wins, then these, then the task version's defaults. Works on any task the enterprise runs, including a linked clone whose definition another enterprise owns; it changes no version. Each key must be an input the current version declares and each value of its declared type; a file input takes none. Built-in tasks are refused. Read them back with os.read_task_definition (inputValues, and ignoredInputValues for saved values the current version no longer takes).\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The task id from os.list_task_definitions.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>values\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>Input key to value: text, a number or true\u002Ffalse, as the input declares.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PUT\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Ftasks\u002F:id\u002Finput-values\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>tasks:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-read-context\">\u003Ccode>os.read_context\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one enterprise context key. Returns key, value (null when absent), and updatedAt. This is workflow bookkeeping, separate from knowledge in memory.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>key\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>One enterprise context key, at most 512 characters, without whitespace.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fenterprise\u002Fcontext\u002F:key\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>enterprise:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-write-context\">\u003Ccode>os.write_context\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Store a JSON object under one enterprise context key, at most 16 KB encoded. Last write wins. Replaces the entire value, so read it before changing selected fields. Records the authenticated caller as the writer. Does not change task permissions, versions or schedules.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>key\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>One enterprise context key, at most 512 characters, without whitespace.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>value\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The complete JSON object to store, at most 16 KB.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PUT\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fenterprise\u002Fcontext\u002F:key\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>enterprise:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"memory-upload\">\u003Ccode>memory.upload\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Upload one note to a team or the whole enterprise. Pass layer (team or enterprise) and body. A team upload also passes teamId, a team in this enterprise; an enterprise upload passes no teamId. Optionally pass kind (fact, the default; inference, preference or correction) and source ({ eventId, revision }), the event the note was learned from, so uploading it again is not stored twice. To correct a note, pass kind correction and supersedes ({ entryId }) naming the entry it replaces. Author and enterprise come from the caller. Task, member and role notes are not uploaded here. A task that declares this tool is refused when it is saved. eventId and revision are strings. A source that is not an object, or a half that is not a string, is refused with memory_source_invalid. A call that leaves source out, or leaves either half empty or out, is stored as a new note each time.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>layer\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>team\u003C\u002Fcode>, \u003Ccode>enterprise\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>team or enterprise. A team upload names teamId.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The team, when layer is team. Leave it out when layer is enterprise.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>body\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The note to retain, one claim in a sentence.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>fact\u003C\u002Fcode>, \u003Ccode>inference\u003C\u002Fcode>, \u003Ccode>preference\u003C\u002Fcode>, \u003Ccode>correction\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>fact, the default; inference, preference or correction. A correction replaces the note named in supersedes.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>source\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where the note was learned, as { eventId, revision }, both strings. The same pair in this enterprise is stored once.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>supersedes\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>object\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The entry this note corrects, as { entryId }. With kind correction it retires that entry.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fmemory\u002Ftrain\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>memory:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-teams\">\u003Ccode>os.list_teams\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List the enterprise's teams, ordered by name: each one's id, name, slug, status, lead (leadMemberId and leadName, null for none), charter and concurrentRunLimit (null when it uses the enterprise's). No arguments. Never another enterprise's teams.\u003C\u002Fp>\n\u003Cp>No arguments.\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-read-team\">\u003Ccode>os.read_team\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one team: its name, slug, status, lead, charter and concurrentRunLimit, the members on it (members) and the tasks it runs (tasks): the tasks of the roles its members hold, seated or as lead. A task belongs to a role, not a team, so the list changes as members join and leave. Not found for a team in another enterprise.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team, by its id from os.list_teams.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-create-team\">\u003Ccode>os.create_team\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Create a team with a name and, optionally, its own concurrent run limit (concurrentRunLimit); left out, the team uses the enterprise's. Its slug is made from the name, so a name whose slug another team already has is refused with team_slug_taken. The response is the team as created.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team’s name, up to 200 characters. Its slug is made from it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>concurrentRunLimit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How many of the team’s runs may run at once, at least 1. Left out, the team uses the enterprise’s limit.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-update-team\">\u003Ccode>os.update_team\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Change a team's name or its concurrent run limit (concurrentRunLimit); a field left out keeps its value. A limit that would take every team's together past the enterprise's is refused with concurrent_run_limit_over_enterprise. The response is the team after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team, by its id from os.list_teams.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The team’s new name, up to 200 characters. Its slug stays as it is.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>concurrentRunLimit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>How many of the team’s runs may run at once, at least 1. Every team’s limit together stays within the enterprise’s.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-delete-team\">\u003Ccode>os.delete_team\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Remove a team. Its members come off it and keep their roles, and with them the tasks those roles run. The enterprise’s last team is refused with last_team: an enterprise keeps at least one. Any other refusal comes back with the API’s reason. The call is the confirmation, so the tool takes no confirm argument.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team, by its id from os.list_teams.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-add-team-member\">\u003Ccode>os.add_team_member\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Put a member on a team, and, when roleId names one, give them that role too. The role is a convenience: a team can hold a member before it has a role to give them. The response is the team after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team, by its id from os.list_teams.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The member to put on the team.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>roleId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A role the member holds from now on as well. Left out, their roles are unchanged.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:id\u002Fmembers\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-remove-team-member\">\u003Ccode>os.remove_team_member\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Take a member off a team. They keep their roles; a lead taken off no longer leads it. The response is the team after the change.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team, by its id from os.list_teams.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>memberId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The member to take off the team.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>DELETE\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:id\u002Fmembers\u002F:memberId\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-add-work-item\">\u003Ccode>os.add_work_item\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Add an item to a team's work list: a title, a kind (one word you choose), and optionally a state, a priority, a short body (up to 16 KB), up to 20 links, a parent item on the same team (one level only) and a not-before date until which no run claims it. It starts proposed unless you give an open state, and goes to the end of its level. Who added it is recorded from the caller. A run adds to the first team its member sits on or leads, or, with forFunction, to the list of the team in its enterprise that holds that business function: as proposed, for that team's lead or a person to approve. An issue or pull request has one open item across the enterprise: a link to one another open item holds, on any team’s list, is refused with work_item_exists, and the issue is taken.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team whose list it is. A run leaves it out: the first team its member sits on or leads is used, and any other is ignored.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>What the work is, up to 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>A word the task chooses for the kind of work (content, outreach, bug): one word, no spaces, up to 40 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>state\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>proposed\u003C\u002Fcode>, \u003Ccode>ready\u003C\u002Fcode>, \u003Ccode>held\u003C\u002Fcode>, \u003Ccode>in_progress\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Where it starts: proposed (waiting for a person) unless given. held is parked until a person releases it. Closed states are set by os.close_work_item.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>priority\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>urgent\u003C\u002Fcode>, \u003Ccode>high\u003C\u002Fcode>, \u003Ccode>medium\u003C\u002Fcode>, \u003Ccode>low\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Its level, urgent first. Left out, it has none and lists after every level.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>body\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A short body: plain text, up to 16 KB. Link a larger document instead.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>links\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Up to 20 http(s) URLs the work refers to.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>parentId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The item this one sits under, such as a campaign or an epic, by its id: an item on the same team that has no parent itself. Left out, it stands alone.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>notBefore\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The moment before which no run claims it, such as a check due 28 days after go-live: a date-time with an offset or Z (2026-12-03T09:00:00Z), or a date (2026-12-03) meaning the start of that day in the enterprise's timezone. It still lists in its usual place. Left out, it can be claimed as soon as it is ready.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>forFunction\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>support\u003C\u002Fcode>, \u003Ccode>marketing\u003C\u002Fcode>, \u003Ccode>sales\u003C\u002Fcode>, \u003Ccode>operations\u003C\u002Fcode>, \u003Ccode>engineering\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A run only: put the item on another team's list, the team of your enterprise that holds this business function. It is added as proposed whatever state you give, for a person or that team's lead to approve: you can never approve it, and unless you sit on that team you cannot read or change it afterwards. With no such team, or more than one, nothing is added: the finding goes to a person on Blockers and the answer says raised. Naming your first team's function adds the item to your first team's list as proposed. Ignored outside a run, where teamId names the team.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:teamId\u002Fwork-items\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-list-work-items\">\u003Ccode>os.list_work_items\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>List a team's work items: the open ones (proposed, ready, held, in_progress) unless you ask for a state, optionally of one kind. Ordered by priority (urgent first, none last), then position, then age, in pages of 25 (up to 200). A run lists the first team its member sits on or leads. Each item carries its parentId and a rollup of its children, \u003Ccode>children: { total, byState }\u003C\u002Fcode>, closed children counted.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team whose list it is. A run leaves it out: the first team its member sits on or leads is used, and any other is ignored.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>state\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>open\u003C\u002Fcode>, \u003Ccode>proposed\u003C\u002Fcode>, \u003Ccode>ready\u003C\u002Fcode>, \u003Ccode>held\u003C\u002Fcode>, \u003Ccode>in_progress\u003C\u002Fcode>, \u003Ccode>done\u003C\u002Fcode>, \u003Ccode>dropped\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only items in this state, or open for every open state. Left out, every open state.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Only items of this kind.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>page\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, at least 1\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Which page, from 1.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>limit\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer, 1 to 200\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Items per page: 25 unless given.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fteams\u002F:teamId\u002Fwork-items\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-read-work-item\">\u003Ccode>os.read_work_item\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Read one work item with every field, open or closed, and claimedByRunStatus: the status now of the run holding it (live, waiting at a gate, ended, or null for none), which tells work being done from work waiting, finished without closing the item, or stopped. Not found for an item in another enterprise, or, for a run, on the list of a team its member is not on, unless it is the open item the run holds.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The item, by its id from os.list_work_items or os.add_work_item.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>GET\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fwork-items\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:read\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-update-work-item\">\u003Ccode>os.update_work_item\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Change an open item's title, kind, state (among the open ones), priority, position, body, links, parent or not-before date. A field left out keeps its value. Each change is kept in the item’s history with who made it, and a call that changes nothing records nothing. A closed item cannot be changed (work_item_closed). Only a person approves a proposed item or releases a held one: a run that tries is refused (approval_requires_person).\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The item, by its id from os.list_work_items or os.add_work_item.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>title\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The new title, up to 200 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kind\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>A word the task chooses for the kind of work (content, outreach, bug): one word, no spaces, up to 40 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>state\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>proposed\u003C\u002Fcode>, \u003Ccode>ready\u003C\u002Fcode>, \u003Ccode>held\u003C\u002Fcode>, \u003Ccode>in_progress\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Move it between the open states: proposed waits for a person, ready can be claimed, held is parked until a person releases it. A run cannot move a proposed or held item out of that state. Use os.close_work_item to finish or drop it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>priority\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>urgent\u003C\u002Fcode>, \u003Ccode>high\u003C\u002Fcode>, \u003Ccode>medium\u003C\u002Fcode>, \u003Ccode>low\u003C\u002Fcode>, \u003Ccode>none\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Its level, urgent first. none clears it, so it lists after every level.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>position\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>integer\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Its place among items of the same level: lower lists first. A new item goes to the end.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>body\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The new body: plain text, up to 16 KB.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>links\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The whole new list of links: up to 20 http(s) URLs.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>parentId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The item this one sits under, by its id: an item on the same team that has no parent itself. none clears it. An item that has children takes no parent.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>notBefore\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Set or move the moment before which no run claims it: a date-time with an offset or Z (2026-12-03T09:00:00Z), or a date (2026-12-03) meaning the start of that day in the enterprise's timezone. none clears it. It keeps its state and place in the list; a run already holding it keeps it.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>PATCH\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fwork-items\u002F:id\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-close-work-item\">\u003Ccode>os.close_work_item\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Close an item as done or dropped, with an optional reason. It stays readable with its whole history, and can no longer be changed. Closing it again the same way changes nothing; the other way is work_item_closed.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>id\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The item, by its id from os.list_work_items or os.add_work_item.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>state\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>done\u003C\u002Fcode>, \u003Ccode>dropped\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>done when the work is finished, dropped when it is not.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>reason\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>Why, in a sentence, up to 2000 characters.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fwork-items\u002F:id\u002Fclose\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>teams:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-publish-role\">\u003Ccode>os.publish_role\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Publish one of the enterprise’s roles to the catalog, where any company can clone it. Pass sourceRoleId, the role’s id from os.list_roles. Only the role’s name and slug are published: its members stay with the enterprise, and its tasks are listed with it once each is published to the catalog itself (those already published join it at once). Public role slugs are global, so a slug the catalog already holds is refused (catalog_role_slug_taken). A plan without catalog publishing is refused with its reason (catalog_publish_not_in_plan) and nothing is written. A task that declares this tool is refused when it is saved. A task reaches it only through a bound connection to the OS’s own MCP server, with a gate naming the tool, as with every write that server serves. The response is the public role, with its id and slug.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>sourceRoleId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The role to publish, by its id from os.list_roles.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fcatalog\u002Froles\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>catalog:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"os-publish-team\">\u003Ccode>os.publish_team\u003C\u002Fcode>\u003C\u002Fh2>\n\u003Cp>Publish one of the enterprise’s teams to the catalog, as Share on the team’s page does. Pass teamId, the team’s id from os.list_teams. The team’s roles the catalog does not hold yet are published first, then the team as one entry under its slug: a teammate slot per member carrying the roles they hold and nothing of the member, its KPIs, the cadence of each schedule on a task the catalog holds, and its goal. Its tasks travel once each is published to the catalog itself. roleSlugs names the roles that go; the rest are left out, and stay left out when the team is published again without roleSlugs. name and description are the words the catalog shows, and default to the team’s name and goal; kindOfWork and businessFunction file it. Publishing a team that has an entry brings that entry up to date instead of adding a second. Refused on a plan without catalog publishing (catalog_publish_not_in_plan), for a team with no roles (team_has_no_roles), and while another publisher holds a public role of one of its slugs (catalog_role_slug_taken, naming the slugs); nothing is written then. A task that declares this tool is refused when it is saved. A task reaches it only through a bound connection to the OS’s own MCP server, with a gate naming the tool, as with every write that server serves. The response is the entry and the public roles it names.\u003C\u002Fp>\n\u003Cdiv class=\"prose__table\">\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Argument\u003C\u002Fth>\n\u003Cth>Type\u003C\u002Fth>\n\u003Cth>Required\u003C\u002Fth>\n\u003Cth>Description\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>\u003Ccode>teamId\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>yes\u003C\u002Ftd>\n\u003Ctd>The team to publish, by its id from os.list_teams.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>roleSlugs\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>array of strings\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The slugs of the team’s roles that go to the catalog; the rest are left out. Leave it out to keep what was left out last time.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>name\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The name the catalog shows, at most 200 characters. Leave it out for the team’s name.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>description\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>One line the catalog shows, at most 280 characters. Leave it out for the team’s goal.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>kindOfWork\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The kind of work setup offers the team for: one lowercase word, such as support. Leave it out for none.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>businessFunction\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>string, one of \u003Ccode>support\u003C\u002Fcode>, \u003Ccode>marketing\u003C\u002Fcode>, \u003Ccode>sales\u003C\u002Fcode>, \u003Ccode>operations\u003C\u002Fcode>, \u003Ccode>engineering\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>no\u003C\u002Ftd>\n\u003Ctd>The business function the catalog files the team under. Leave it out for none.\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\n\u003C\u002Fdiv>\n\u003Cul>\n\u003Cli>\u003Cstrong>Method:\u003C\u002Fstrong> \u003Ccode>POST\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Path:\u003C\u002Fstrong> \u003Ccode>\u002Fv1\u002Fcatalog\u002Fshare\u002Fteams\u002F:teamId\u003C\u002Fcode>\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Scope:\u003C\u002Fstrong> \u003Ccode>catalog:write\u003C\u002Fcode>\u003C\u002Fli>\n\u003C\u002Ful>\n",[12,16,19,22,25,28,31,34,37,40,43,46,49,52,55,58,61,64,67,70,73,76,79,82,85,88,91,94,97,100,103,106,109,112,115,118,121,124,127,130,133,136,139,142,145,148,151,154,157,160,163,166,169,172,175,178,181,184,187,190,193,196,199,202,205,208,211,214,217,220,223,226,229,232,235,238,241,244,247,250,253,256,259,262,265,268,271,274],{"id":13,"text":14,"level":15,"planned":8},"os-list-runs","os.list_runs",2,{"id":17,"text":18,"level":15,"planned":8},"os-get-run","os.get_run",{"id":20,"text":21,"level":15,"planned":8},"os-list-blockers","os.list_blockers",{"id":23,"text":24,"level":15,"planned":8},"os-list-open-gates","os.list_open_gates",{"id":26,"text":27,"level":15,"planned":8},"os-kpi-board","os.kpi_board",{"id":29,"text":30,"level":15,"planned":8},"kpi-record-reading","kpi.record_reading",{"id":32,"text":33,"level":15,"planned":8},"kpi-list-readings","kpi.list_readings",{"id":35,"text":36,"level":15,"planned":8},"memory-ask","memory.ask",{"id":38,"text":39,"level":15,"planned":8},"os-decide-gate","os.decide_gate",{"id":41,"text":42,"level":15,"planned":8},"os-member-mailbox-actions","os.member_mailbox_actions",{"id":44,"text":45,"level":15,"planned":8},"os-my-mail-list","os.my_mail_list",{"id":47,"text":48,"level":15,"planned":8},"os-my-mail-read","os.my_mail_read",{"id":50,"text":51,"level":15,"planned":8},"os-my-mail-attachment","os.my_mail_attachment",{"id":53,"text":54,"level":15,"planned":8},"os-my-mail-set-label","os.my_mail_set_label",{"id":56,"text":57,"level":15,"planned":8},"os-my-mail-set-handled","os.my_mail_set_handled",{"id":59,"text":60,"level":15,"planned":8},"os-my-mail-set-many","os.my_mail_set_many",{"id":62,"text":63,"level":15,"planned":8},"os-my-mail-reply","os.my_mail_reply",{"id":65,"text":66,"level":15,"planned":8},"os-my-mail-send","os.my_mail_send",{"id":68,"text":69,"level":15,"planned":8},"os-my-mail-forward","os.my_mail_forward",{"id":71,"text":72,"level":15,"planned":8},"os-my-mail-delete","os.my_mail_delete",{"id":74,"text":75,"level":15,"planned":8},"os-my-mail-actions","os.my_mail_actions",{"id":77,"text":78,"level":15,"planned":8},"os-my-mail-start-action","os.my_mail_start_action",{"id":80,"text":81,"level":15,"planned":8},"os-my-mail-schedule-action","os.my_mail_schedule_action",{"id":83,"text":84,"level":15,"planned":8},"os-my-mail-unschedule-action","os.my_mail_unschedule_action",{"id":86,"text":87,"level":15,"planned":8},"os-my-mail-contacts","os.my_mail_contacts",{"id":89,"text":90,"level":15,"planned":8},"os-my-mail-contact-save","os.my_mail_contact_save",{"id":92,"text":93,"level":15,"planned":8},"os-my-mail-contact-delete","os.my_mail_contact_delete",{"id":95,"text":96,"level":15,"planned":8},"os-my-mail-signature","os.my_mail_signature",{"id":98,"text":99,"level":15,"planned":8},"os-my-mail-signature-set","os.my_mail_signature_set",{"id":101,"text":102,"level":15,"planned":8},"os-my-mail-addresses","os.my_mail_addresses",{"id":104,"text":105,"level":15,"planned":8},"os-my-mail-address-signature-set","os.my_mail_address_signature_set",{"id":107,"text":108,"level":15,"planned":8},"os-get-enterprise-kpis","os.get_enterprise_kpis",{"id":110,"text":111,"level":15,"planned":8},"os-set-enterprise-kpis","os.set_enterprise_kpis",{"id":113,"text":114,"level":15,"planned":8},"os-get-team-kpis","os.get_team_kpis",{"id":116,"text":117,"level":15,"planned":8},"os-set-team-kpis","os.set_team_kpis",{"id":119,"text":120,"level":15,"planned":8},"role-list-kpis","role.list_kpis",{"id":122,"text":123,"level":15,"planned":8},"role-define-kpi","role.define_kpi",{"id":125,"text":126,"level":15,"planned":8},"role-edit-kpi","role.edit_kpi",{"id":128,"text":129,"level":15,"planned":8},"os-list-waiting","os.list_waiting",{"id":131,"text":132,"level":15,"planned":8},"os-list-built-in-tools","os.list_built_in_tools",{"id":134,"text":135,"level":15,"planned":8},"os-chat-list","os.chat_list",{"id":137,"text":138,"level":15,"planned":8},"os-chat-read","os.chat_read",{"id":140,"text":141,"level":15,"planned":8},"os-chat-write","os.chat_write",{"id":143,"text":144,"level":15,"planned":8},"os-chat-open","os.chat_open",{"id":146,"text":147,"level":15,"planned":8},"os-start-task","os.start_task",{"id":149,"text":150,"level":15,"planned":8},"os-read-run-log","os.read_run_log",{"id":152,"text":153,"level":15,"planned":8},"os-list-enterprise-kpis","os.list_enterprise_kpis",{"id":155,"text":156,"level":15,"planned":8},"os-finish-waiting","os.finish_waiting",{"id":158,"text":159,"level":15,"planned":8},"os-restart-waiting","os.restart_waiting",{"id":161,"text":162,"level":15,"planned":8},"os-clear-blocker","os.clear_blocker",{"id":164,"text":165,"level":15,"planned":8},"os-inspect-task-contract","os.inspect_task_contract",{"id":167,"text":168,"level":15,"planned":8},"os-inspect-execution","os.inspect_execution",{"id":170,"text":171,"level":15,"planned":8},"os-preview-run-route","os.preview_run_route",{"id":173,"text":174,"level":15,"planned":8},"os-export-workflow-evidence","os.export_workflow_evidence",{"id":176,"text":177,"level":15,"planned":8},"os-list-roles","os.list_roles",{"id":179,"text":180,"level":15,"planned":8},"os-read-role","os.read_role",{"id":182,"text":183,"level":15,"planned":8},"os-create-role","os.create_role",{"id":185,"text":186,"level":15,"planned":8},"os-update-role","os.update_role",{"id":188,"text":189,"level":15,"planned":8},"os-delete-role","os.delete_role",{"id":191,"text":192,"level":15,"planned":8},"os-add-role-task","os.add_role_task",{"id":194,"text":195,"level":15,"planned":8},"os-remove-role-task","os.remove_role_task",{"id":197,"text":198,"level":15,"planned":8},"os-add-role-member","os.add_role_member",{"id":200,"text":201,"level":15,"planned":8},"os-remove-role-member","os.remove_role_member",{"id":203,"text":204,"level":15,"planned":8},"os-list-task-definitions","os.list_task_definitions",{"id":206,"text":207,"level":15,"planned":8},"os-read-task-definition","os.read_task_definition",{"id":209,"text":210,"level":15,"planned":8},"os-create-task","os.create_task",{"id":212,"text":213,"level":15,"planned":8},"os-publish-task-version","os.publish_task_version",{"id":215,"text":216,"level":15,"planned":8},"os-set-task-run-status","os.set_task_run_status",{"id":218,"text":219,"level":15,"planned":8},"os-set-task-schedule","os.set_task_schedule",{"id":221,"text":222,"level":15,"planned":8},"os-remove-task-schedule","os.remove_task_schedule",{"id":224,"text":225,"level":15,"planned":8},"os-set-task-input-values","os.set_task_input_values",{"id":227,"text":228,"level":15,"planned":8},"os-read-context","os.read_context",{"id":230,"text":231,"level":15,"planned":8},"os-write-context","os.write_context",{"id":233,"text":234,"level":15,"planned":8},"memory-upload","memory.upload",{"id":236,"text":237,"level":15,"planned":8},"os-list-teams","os.list_teams",{"id":239,"text":240,"level":15,"planned":8},"os-read-team","os.read_team",{"id":242,"text":243,"level":15,"planned":8},"os-create-team","os.create_team",{"id":245,"text":246,"level":15,"planned":8},"os-update-team","os.update_team",{"id":248,"text":249,"level":15,"planned":8},"os-delete-team","os.delete_team",{"id":251,"text":252,"level":15,"planned":8},"os-add-team-member","os.add_team_member",{"id":254,"text":255,"level":15,"planned":8},"os-remove-team-member","os.remove_team_member",{"id":257,"text":258,"level":15,"planned":8},"os-add-work-item","os.add_work_item",{"id":260,"text":261,"level":15,"planned":8},"os-list-work-items","os.list_work_items",{"id":263,"text":264,"level":15,"planned":8},"os-read-work-item","os.read_work_item",{"id":266,"text":267,"level":15,"planned":8},"os-update-work-item","os.update_work_item",{"id":269,"text":270,"level":15,"planned":8},"os-close-work-item","os.close_work_item",{"id":272,"text":273,"level":15,"planned":8},"os-publish-role","os.publish_role",{"id":275,"text":276,"level":15,"planned":8},"os-publish-team","os.publish_team",1794928143211]