--- title: Processes full: true _openapi: preload: - ./specs/toolbox-api.json toc: - depth: 2 title: List processes url: '#list-processes' - depth: 2 title: Create a process url: '#create-a-process' - depth: 2 title: Get a process url: '#get-a-process' - depth: 2 title: Delete a process record url: '#delete-a-process-record' - depth: 2 title: Attach a websocket to a process url: '#attach-a-websocket-to-a-process' - depth: 2 title: Read process logs or follow them as SSE url: '#read-process-logs-or-follow-them-as-sse' - depth: 2 title: Resize a PTY url: '#resize-a-pty' - depth: 2 title: Signal a process url: '#signal-a-process' - depth: 2 title: Write process stdin url: '#write-process-stdin' - depth: 2 title: Wait for process completion url: '#wait-for-process-completion' structuredData: headings: - content: List processes id: list-processes - content: Create a process id: create-a-process - content: Get a process id: get-a-process - content: Delete a process record id: delete-a-process-record - content: Attach a websocket to a process id: attach-a-websocket-to-a-process - content: Read process logs or follow them as SSE id: read-process-logs-or-follow-them-as-sse - content: Resize a PTY id: resize-a-pty - content: Signal a process id: signal-a-process - content: Write process stdin id: write-process-stdin - content: Wait for process completion id: wait-for-process-completion contents: - content: List process records, optionally filtered by state, kind, session, name, or pid. heading: list-processes - content: Create a process record and launch exec, pty, or code work. `waitMs` keeps the request open until terminal or timeout; `logs=text|base64` adds the first log page and therefore requires `waitMs`. heading: create-a-process - content: Fetch a process by stable id or by its live alias. heading: get-a-process - content: Delete a process record and purge its logs. System processes stay protected. heading: delete-a-process-record - content: Upgrades to a websocket that streams live output frames and accepts stdin bytes. When `cursor` is set, the daemon replays ledger bytes up to the attach-time tail first. Invalid or expired replay cursors are reported as websocket policy closes (`1008`), not HTTP errors. heading: attach-a-websocket-to-a-process - content: Returns a JSON page by default, or an SSE stream when `follow=true`. SSE event names are `log`, `state`, `warning`, `error`, and `eof`; `Last-Event-ID` resumes from the last seen cursor. heading: read-process-logs-or-follow-them-as-sse - content: Change the terminal size of a PTY process. heading: resize-a-pty - content: Send a signal, optionally with escalation, or interrupt a running code execution. heading: signal-a-process - content: Write stdin data and optionally close stdin. heading: write-process-stdin - content: "Long-poll for the terminal result. Omitted `timeoutMs` keeps the daemon's default 60-second chunk, `timeoutMs=0` waits until terminal, and any positive value is honored uncapped. Timing out returns `reason: timed_out` without killing the process." heading: wait-for-process-completion methods: - GET - POST - GET - DELETE - GET - GET - POST - POST - POST - GET --- {/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} export default function Layout(props) { const { OpenAPIPage } = props.components ?? {}; return ( <> {props.children} ); }