@sema-agent/sdk 0.0.121 → 0.0.122

package/openapi.yaml

@@ -547,6 +547,296 @@ paths:
             application/json:
               schema: { $ref: '#/components/schemas/ErrorResponse' }
 
+  /v1/runs/{taskId}/compact:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+    post:
+      tags: [runs]
+      operationId: runsCompact
+      x-status: live             # core 1.293 compact(opts); manual-compaction control leg.
+      summary: Request a manual compaction of a LIVE run (fires at the next safe turn boundary).
+      description: >
+        Manual compaction control. FIRE-AND-FORGET 202 — `compact()` resolves only once processed at the next
+        SAFE turn boundary (possibly a whole in-flight turn away), so the ack is immediate and the outcome
+        rides the run's OWN stream: a `compacted{trigger:"manual"}` event IF anything was summarized; the
+        other outcomes (failed/mooted/noop/blocked/disabled) emit NO event (a spinner must time out, not
+        block). `instructions` = the shell's targeted-summary directive, capped at 2048 CODE POINTS (the
+        engine's own cap — over-cap is a fail-loud 400 here, never a silently truncated 202). LIVE-only and
+        replica-local (`steerableRuns` handle): a run active on another replica or terminal → 409
+        `compact.not_running`. Owner-gated (operator may compact any tenant's run); burns model budget —
+        rate/quota/lease gates apply.
+      requestBody:
+        required: false
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                instructions: { type: string, minLength: 1, description: 'Targeted compaction directive; ≤2048 code points (engine cap, enforced fail-loud).' }
+      responses:
+        '202':
+          description: Accepted — compaction runs at the next turn boundary; watch the run stream for `compacted{trigger:"manual"}`.
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [taskId, status, delivery]
+                properties:
+                  taskId: { type: string }
+                  status: { type: string }
+                  delivery: { type: string, enum: [accepted] }
+                  note: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '409':
+          description: 'errorCode "compact.not_running" — run is terminal, or active on another replica (manual compact is replica-local).'
+          content:
+            application/json:
+              schema: { $ref: '#/components/schemas/ErrorResponse' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
+  /v1/runs/{taskId}/detach:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+    post:
+      tags: [runs]
+      operationId: runsDetach
+      x-status: live             # core 1.207 design/116 (CC mid-flight ctrl+b) sync-leg detach verb.
+      summary: Move a RUNNING tool call of this run to the background (CC ctrl+b).
+      description: >
+        design/116 — `TaskStream.detach(toolCallId)`. Fire-and-forget by CONTRACT and race-safe core-side: a
+        request landing before the tool reads its signal still detaches; after it finished = no-op; unknown
+        toolCallId = no-op (fail-safe — but note the ≤256-char cap is load-bearing: an unknown id still
+        allocates a registry entry for the run's lifetime). Only a detach-capable env honors it
+        (`backgroundCapabilities.supportsDetach`). The outcome surfaces on the run's OWN stream: the
+        early-settled `tool_end` with the `detached:true` structured card, then the `b*` task notification.
+        LIVE-only + replica-local (like compact) → 409 `detach.not_running` otherwise. Owner-gated; mutating
+        but runs no model (rate-limited only, no quota gate — parity with cancel).
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [toolCallId]
+              properties:
+                toolCallId: { type: string, minLength: 1, maxLength: 256 }
+      responses:
+        '202':
+          description: Requested — honest about carrying no confirmation (the run stream carries the outcome).
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [taskId, toolCallId, delivery]
+                properties:
+                  taskId: { type: string }
+                  toolCallId: { type: string }
+                  delivery: { type: string, enum: [requested] }
+                  note: { type: string }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '409':
+          description: 'errorCode "detach.not_running" — run is terminal, or active on another replica.'
+          content:
+            application/json:
+              schema: { $ref: '#/components/schemas/ErrorResponse' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
+  /v1/runs/{taskId}/subagents/{target}/output:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+      - name: target
+        in: path
+        required: true
+        schema: { type: string }
+        description: 'Background-agent handle (`a*` short form) under this parent run.'
+    get:
+      tags: [runs]
+      operationId: runsSubagentOutput
+      x-status: live             # [1488]③(b) background child read face (announced background_agent-ONLY contract, byte-stable).
+      summary: Read a BACKGROUND child's final report / current status (non-blocking).
+      description: >
+        [1488]③(b) — the background child read face. The fleet viewer gets `bg_notification` summaries only;
+        the child's FINAL assistant body lives in the core TaskRegistry (what the TaskOutput tool reads) and
+        is served here. Auth = the runs-face read pattern (verified principal → owner via the parent run row →
+        honest 404, no existence oracle); registry access is derived from the run row, NEVER caller-supplied.
+        Replica-local (in-process registry, like steer). Non-blocking: a still-running child returns its
+        current status honestly, no long-poll. This face is the announced `background_agent`-ONLY contract —
+        the generic task-handle verbs live under `/v1/runs/{taskId}/tasks/{target}/…`.
+      responses:
+        '200':
+          description: 'The registry projection. `content` = the child''s final assistant body (UNTRUSTED model output).'
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [taskId, target]
+                properties:
+                  taskId: { type: string }
+                  target: { type: string }
+                  content: { type: string }
+                  output: { type: object, description: 'Registry details projection (status/kind/…), passed through verbatim.' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
+  /v1/runs/{taskId}/subagents/{target}/resume:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+      - name: target
+        in: path
+        required: true
+        schema: { type: string }
+        description: 'The delegating tool call''s id (`parentToolCallId`) or the subagent''s agentName (ambiguous → 409).'
+    post:
+      tags: [runs]
+      operationId: runsResumeSubagent
+      x-status: live             # design/122 ③ (CC dfe parity): revive a settled child on its retained session.
+      summary: REVIVE a SETTLED subagent with a new prompt (async, on its retained session).
+      description: >
+        design/122 — CC "resume the agent" parity. Always async: the revived child runs in the background on
+        its RETAINED session (requires the parent run to have set `retainSubagentSessions`); completion is
+        announced via the deployment notify sink. Resume is only legal AFTER settle (handles live until leg
+        end). Owner-gated via the parent run row; content is fenced (`redactSteerIn`); the child's session id
+        is a continuation capability and never appears in any response. BILLABLE (starts model work) —
+        rate/quota/lease gates apply.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [content]
+              properties:
+                content: { type: string, description: 'The revival prompt (untrusted DATA; fenced server-side).' }
+      responses:
+        '200':
+          description: 'Revived. Body `{ taskId, target, status, delivery, marker, note }`.'
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '409':
+          description: 'core''s typed rejections verbatim as `errorCode`: resume.still_running / resume.retain_off / resume.evicted / resume.cap / resume.session_not_found (design/122 D2).'
+          content:
+            application/json:
+              schema: { $ref: '#/components/schemas/ErrorResponse' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
+  /v1/runs/{taskId}/subagents/{target}/stream:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+      - name: target
+        in: path
+        required: true
+        schema: { type: string }
+        description: 'Background-agent handle (`a*` short form) under this parent run.'
+    get:
+      tags: [runs]
+      operationId: runsSubagentStream
+      x-status: live             # S2 [1520] per-agent live tail (core 1.370 bgAgentId).
+      summary: Per-agent LIVE TAIL (SSE) — content frames from connect time onward.
+      description: >
+        S2 — the "tail" half of replay+tail (replay/final report = the `/output` face). SSE frames: first an
+        `event: meta` frame (`{version, runId, target, status, seq?, live: "replica-local", replayFace}`),
+        then `event: forward` frames (text/reasoning deltas, tool_start/end, task_progress — same builder
+        discipline as the sync main stream's forward branch) and `event: heartbeat` keepalives (real frames,
+        not comment lines). Frames are produced only on the replica hosting the parent run ⇒ live frames are
+        replica-local (the meta declares it; a row running on another instance heartbeats only, never
+        fabricates). A terminal child ends the stream right after the meta (the replay face is the read
+        surface). Gates are byte-identical to the `/output` face (principal → owner → session, fail-closed
+        404, no oracle).
+      responses:
+        '200':
+          description: 'SSE stream (`text/event-stream`): meta → forward*/heartbeat*.'
+          content:
+            text/event-stream:
+              schema: { type: string }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
+  /v1/runs/{taskId}/tasks/{target}/output:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+      - name: target
+        in: path
+        required: true
+        schema: { type: string }
+        description: 'EXACT task handle only (`b*` background bash, monitor, background agent) — agent-name / legacy-shellId resolution is deliberately not on the wire (fail-closed 404).'
+    get:
+      tags: [runs]
+      operationId: runsTaskOutput
+      x-status: live             # [1499] CC TaskOutput human-side counterpart (generic task-handle verb family).
+      summary: Read a background task handle's output (CC TaskOutput human-side counterpart).
+      description: >
+        [1499] — the GENERIC task-handle read serving the full registry kind set (background_bash stdout,
+        monitor batches, background_agent final report). Whether a read consumes the output cursor depends on
+        the handle's shape — the top-level `cursorSemantics` key ("cursor" = new bytes per read | "full" =
+        re-readable) is minted server-side so consumers never parse content markers; absent on error/not_ready
+        shapes (no fake semantics). `workflow` handles are refused at the seam (journal face owns workflow
+        reads — a poll here would suppress the completion push). `?filter=` is NOT accepted (400): the wire
+        serves the clipped projection. Gates mirror the subagent output face (principal → owner → session).
+      responses:
+        '200':
+          description: 'Registry projection passed through verbatim; `content` is UNTRUSTED tool/model output.'
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [taskId, target]
+                properties:
+                  taskId: { type: string }
+                  target: { type: string }
+                  content: { type: string }
+                  output: { type: object }
+                  cursorSemantics: { type: string, enum: [cursor, full], description: 'G14: whether THIS read consumed the cursor. Absent on error/not_ready or unknown kinds.' }
+        '400': { $ref: '#/components/responses/BadRequest' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
+  /v1/runs/{taskId}/tasks/{target}/stop:
+    parameters:
+      - $ref: '#/components/parameters/PrincipalHeader'
+      - $ref: '#/components/parameters/TaskIdPath'
+      - name: target
+        in: path
+        required: true
+        schema: { type: string }
+        description: 'EXACT task handle only (see the output verb); `workflow` handles refused.'
+    post:
+      tags: [runs]
+      operationId: runsTaskStop
+      x-status: live             # [1499] CC TaskStop human-side counterpart.
+      summary: Stop a background task handle (CC TaskStop human-side counterpart).
+      description: >
+        [1499] — stop the handle's process. A stop whose kill did NOT land must not read as success: core
+        keeps the handle honest (status stays "running", error = the env failure code) and the wire surfaces
+        that as a 409 with a discriminated `errorCode` — stop.not_local (task attached to another instance) /
+        stop.park_arbiter_unreachable / stop.park_resume_won (a concurrent approval resume won the race) /
+        stop.parked (durably parked on a tool-approval — resolve the approval instead, nothing live to kill) /
+        stop.not_landed. Mutating but runs no model (rate-limited only, parity with detach). Gates mirror the
+        output verb.
+      responses:
+        '200':
+          description: 'Stopped — same projection shape as the output verb ({ taskId, target, content, output }).'
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '404': { $ref: '#/components/responses/NotFound' }
+        '409':
+          description: 'Stop did not land — discriminated `errorCode` (stop.not_local / stop.park_arbiter_unreachable / stop.park_resume_won / stop.parked / stop.not_landed); body includes the current projection.'
+          content:
+            application/json:
+              schema: { $ref: '#/components/schemas/ErrorResponse' }
+        '501': { $ref: '#/components/responses/NotImplemented' }
+
   /v1/sessions:
     parameters:
       - $ref: '#/components/parameters/PrincipalHeader'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sema-agent/sdk",
-  "version": "0.0.121",
+  "version": "0.0.122",
   "description": "Typed, zero-runtime-dependency SDK for the Sema agent fleet usage plane. The shared substrate for all doors (CC/Codex MCP façade + web). Server-side only — tokens never enter the browser.",
   "type": "module",
   "license": "BUSL-1.1",