Servers Playground How we check Add a server Log in

ZeroWidth Workbench

Working · 324 ms

ai.zerowidth/workbenchv1.0.0 Domain verified

Build, run and publish Workbench flows, tasks, shims and knowledge bases.

AI & Agents Developer Tools

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://api.zerowidth.ai/mcp/x/workbench

Authorization (optional)

Bearer token: a workspace API key or personal access token from accounts.zerowidth.ai

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

comments_create

Posts a comment on a workspace entity — a new thread, or a reply when rootId is given. Use it to leave findings where the discussion already lives (an eval result on the flow being debated, a summary on a long thread). Mention people via mentionedUserIds (from workspace member ids) to ring their notification bell; never mention someone who didn't ask to be pulled in.

bodystring, required

entityIdstring, required

entityKindstring, required

What the thread hangs on.

rootIdstring

Reply into this thread; omit to start a new one.

workspacestring

Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

approvalIdstring

mentionedUserIdsarray

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

ZeroWidth Workbench MCP server | mcptry

ZeroWidth Workbench

Working · 324 ms

ai.zerowidth/workbenchv1.0.0 Domain verified

Build, run and publish Workbench flows, tasks, shims and knowledge bases.

AI & Agents Developer Tools

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://api.zerowidth.ai/mcp/x/workbench

Authorization (optional)

Bearer token: a workspace API key or personal access token from accounts.zerowidth.ai

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

comments_create

bodystring, required

entityIdstring, required

entityKindstring, required

What the thread hangs on.

rootIdstring

Reply into this thread; omit to start a new one.

workspacestring

Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

approvalIdstring

mentionedUserIdsarray

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (61)

comments_create

Argument	Type	Description
body*	string
rootId	string	Reply into this thread; omit to start a new one.
entityId*	string
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string
entityKind*	string	What the thread hangs on.
mentionedUserIds	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "entityId",
    "body"
  ],
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1
    },
    "rootId": {
      "type": "string",
      "description": "Reply into this thread; omit to start a new one."
    },
    "entityId": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string"
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "compass_page",
        "compass_opportunity",
        "caliper_review",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_spec",
        "napkin_board",
        "napkin_diagram",
        "napkin_doc",
        "napkin_sheet",
        "napkin_interface",
        "ledger_entry",
        "prism_field",
        "workspace_file"
      ],
      "type": "string",
      "description": "What the thread hangs on."
    },
    "mentionedUserIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20
    }
  }
}

comments_list

Lists the comment threads on one workspace entity (open first, then resolved) with authors and timestamps. Read this before weighing in on contested work — the threads are where disagreement lives before it becomes a decision.

read-only

Argument	Type	Description
entityId*	string
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
entityKind*	string	What the thread hangs on.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "entityId"
  ],
  "properties": {
    "entityId": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "compass_page",
        "compass_opportunity",
        "caliper_review",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_spec",
        "napkin_board",
        "napkin_diagram",
        "napkin_doc",
        "napkin_sheet",
        "napkin_interface",
        "ledger_entry",
        "prism_field",
        "workspace_file"
      ],
      "type": "string",
      "description": "What the thread hangs on."
    }
  }
}

comments_resolve

Sets a comment thread's resolved state (rootId = the thread's root comment id). Resolve ONLY when the human asked or the thread's question is demonstrably settled — and say what settled it in a reply first. Reopening is for new evidence.

destructive

Argument	Type	Description
rootId*	string
resolved*	boolean
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "rootId",
    "resolved"
  ],
  "properties": {
    "rootId": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "resolved": {
      "type": "boolean"
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string"
    }
  }
}

entity_tags_browse

Without a tag: every tag in use across the workspace with how many entities carry it, most-used first — the vocabulary the team already organizes by. With a tag: everything filed under it across every tool, each with its kind, id, title, and path. Use it to reuse existing labels instead of inventing near-duplicates, and to answer 'show me everything about X' when X is a label.

read-only

Argument	Type	Description
tag	string	A tag to expand into its items. Omit to list tags.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "tag": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "A tag to expand into its items. Omit to list tags."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

entity_tags_get

Returns the tags on a batch of entities of one kind — the labels galleries organize by. Ids come from the kind's list/get tool or from search_workspace. Use it before entity_tags_set so you replace the full set knowingly, and to answer 'what is this filed under'. Entities the user can't see are omitted.

read-only

Argument	Type	Description
ids*	array
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
entityKind*	string	Which kind the ids belong to.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "ids"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "minItems": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "workbench_task",
        "workbench_kb",
        "compass_page",
        "compass_opportunity",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_review",
        "caliper_spec",
        "caliper_source",
        "ledger_entry",
        "ledger_metric",
        "napkin_board",
        "napkin_deck",
        "napkin_doc",
        "napkin_sheet",
        "napkin_diagram",
        "prism_field",
        "prism_study"
      ],
      "type": "string",
      "description": "Which kind the ids belong to."
    }
  }
}

entity_tags_set

Replaces the FULL tag set on one entity (an empty list clears it). Read the current tags with entity_tags_get first and pass the merged list — this is not additive. Tags are lowercase letters, numbers, spaces, and hyphens; prefer labels already in use (entity_tags_browse) so the workspace's vocabulary stays small. The id comes from the kind's list/get tool or search_workspace.

destructive

Argument	Type	Description
tags*	array
entityId*	string
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
entityKind*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "entityId",
    "tags"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9](?:[a-z0-9 -]*[a-z0-9])?$",
        "maxLength": 40
      },
      "maxItems": 50
    },
    "entityId": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "workbench_task",
        "workbench_kb",
        "compass_page",
        "compass_opportunity",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_review",
        "caliper_spec",
        "caliper_source",
        "ledger_entry",
        "ledger_metric",
        "napkin_board",
        "napkin_deck",
        "napkin_doc",
        "napkin_sheet",
        "napkin_diagram",
        "prism_field",
        "prism_study"
      ],
      "type": "string"
    }
  }
}

get_doc

Fetch the full Markdown body of a specific docs page by its slug. Use this after `search_docs` when the user needs the complete content of a page. No authentication required.

read-only

Argument	Type	Description
slug*	string	Page slug. Accepts 'compass/api', '/compass/api', or 'docs/compass/api'.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "slug"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "description": "Page slug. Accepts 'compass/api', '/compass/api', or 'docs/compass/api'."
    }
  }
}

list_docs

Enumerate all available docs pages, optionally filtered by product (e.g. 'compass', 'legal', 'overview'). Use this to discover what slugs exist before calling `get_doc`. No authentication required.

read-only

Argument	Type	Description
product	string	Optional product slug filter (e.g. 'compass', 'legal', 'overview').

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "product": {
      "type": "string",
      "description": "Optional product slug filter (e.g. 'compass', 'legal', 'overview')."
    }
  }
}

search_docs

Search ZeroWidth product documentation. Returns matching pages with title, slug, public URL, and a query-relevant snippet. Use this when the user asks about a ZeroWidth product (Compass, Workbench, Caliper, Prism, Ledger, Napkin, the assistant), an API behavior, or a policy. No authentication required — the docs corpus is public.

read-only

Argument	Type	Description
limit	integer	Max number of results. Defaults to 10.
query*	string	Search query — keywords or natural-language phrase.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 20,
      "description": "Max number of results. Defaults to 10.",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "Search query — keywords or natural-language phrase."
    }
  }
}

search_workspace

Finds anything in the workspace in one call — uploaded files (searching the text inside them), folders, Workbench flows, shims, knowledge bases and tasks, Compass pages and changes, Caliper datasets, evals, rubrics, reviews, specs and sources, Ledger entries, Napkin sketches, decks, docs, sheets, diagrams and interfaces. The same search the person uses in Home. Use it FIRST whenever the user mentions something without saying where it lives ('the SOW', 'the dispatch interviews', 'that invoice'). The query is words in any order: each word must appear in the thing's name, its tags, the names of the folders it's filed under, or the text inside it — so 'northwind sow' finds the SOW filed in the Northwind folder, and 'dispatch interview' finds 'Dispatcher interview 1.md'. Results are ranked best first. Each hit carries its id, kind, path (for a link), folderPath (where it's filed, top-down), tags, and a snippet when the words were found inside it rather than in its name — say where a thing lives using folderPath. A file's id feeds workspace_files_read; other ids feed the kind's *_get tool. Pass folderId to search only inside one folder and everything under it. If nothing comes back, try fewer or different words before telling the user it doesn't exist. Results only include what the user can see, and only kinds this token may read.

read-only

Argument	Type	Description
q*	string	Words, any order, case-insensitive. Fewer words find more.
kinds	array	Restrict to these kinds (file, folder, flow, page, doc, dataset, …). Omit to search everything.
limit	integer
folderId	string

workbench_executions_get

The flow's stack traces: recent executions with per-node timelines — what each node received, produced, how long it took, and the exact error when one failed. USE THIS when a run misbehaves instead of guessing: read the failing node's inputs/error, then propose a fix (workbench_flows_edit_text) grounded in what actually happened. Pass executionId to inspect one run, or just flowId for the most recent runs. Node inputs/outputs are truncated for transport — the full record is in the flow's dev drawer.

read-only

Argument	Type	Description
limit	integer	How many recent executions (default 3, max 10). Ignored when executionId is set.
flowId*	string	Workbench flow id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic).
executionId	string	Specific execution to inspect. Omit for the latest runs.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 10,
      "minimum": 1,
      "description": "How many recent executions (default 3, max 10). Ignored when executionId is set."
    },
    "flowId": {
      "type": "string",
      "description": "Workbench flow id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic)."
    },
    "executionId": {
      "type": "string",
      "description": "Specific execution to inspect. Omit for the latest runs."
    }
  }
}

workbench_flow_authoring_guide

READ THIS FIRST before writing or editing any raw flow orchestration JSON. Covers the document shape, the settings-vs-input-ports rule (temperature, max_tokens, tools, response_format are PORTS, not settings — constants reach ports via value nodes), exact link format, plugin links, and three complete worked examples.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

workbench_flows_attach_knowledge_base

Attaches a knowledge base to an AGENT flow's draft, the same way picking it in the agent editor does: a docs knowledge base becomes a search tool the model calls when a question needs it; a tabular one also puts its tables in the prompt and adds a query tool. The flow needs a system prompt (scaffold it with one). Attaching one that's already there changes nothing. Do it BEFORE workbench_flows_publish: a published version is what interfaces and schedules run, so attach, try it with workbench_flows_run, then publish — and if something already pins an older version (an interface grant), re-grant the new version. Tell the model in its system prompt what the knowledge base holds and when to search it. May return `needs_confirmation`.

Argument	Type	Description
flowId*	string	The agent flow, from workbench_flows_scaffold or workbench_flows_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
knowledgeBaseId*	string	The knowledge base id, from workbench_kb_create or workbench_kb_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "knowledgeBaseId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "The agent flow, from workbench_flows_scaffold or workbench_flows_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "knowledgeBaseId": {
      "type": "string",
      "description": "The knowledge base id, from workbench_kb_create or workbench_kb_list."
    }
  }
}

workbench_flows_delete

Deletes a flow. Its schedules stop, guest share links die, and evals targeting it can no longer run (their binding shows flowOk: false) — check caliper_flow_performance for evals and workbench_flows_schedules_list before proposing, and prefer workbench_flows_update with archived: true when the user just wants it out of the way. May return `needs_confirmation`.

destructive

Argument	Type	Description
flowId*	string	Flow id, from workbench_flows_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id, from workbench_flows_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_flows_edit_text

Applies ONE precise text replacement to a flow's DRAFT orchestration — Edit-tool semantics: `find` must be the EXACT current text, copied character-for-character from workbench_flows_get, and must occur exactly once anywhere in the flow (system prompts, node settings, metadata, a node's type). `find` is text inside ONE value, not JSON: to change a model, find the model slug alone (`anthropic-claude-haiku-4-5`) and replace it with another `llm` slug from workbench_node_catalog_get. It can't add or remove nodes or links. Zero or multiple matches return an error instead of guessing. This is the improvement primitive: check receipts first with caliper_flow_performance, cite the run id in `note`, apply the edit after approval, then re-run the eval with caliper_evals_run and report the score delta — never claim improvement without the before/after. Edits land on the draft only; the published version changes when someone publishes (workbench_flows_publish, after the user has seen the result). May return `needs_confirmation` — show the user the exact find/replace diff and wait.

destructive

Argument	Type	Description
find*	string	EXACT current text (≥3 chars), copied verbatim — never reconstructed from memory.
note*	string	Why this edit. Cite eval run ids when it follows a measurement (e.g. 'refund answers scored 1/5 on accuracy in run cer_abc — adds the manager-approval rule'). Lands in the audit log.
flowId*	string	Flow to edit.
replace*	string

workbench_flows_fork

Copies a PUBLIC flow from another workspace (a template) into this one as a new draft the user owns. Identify it by its flowUuid (the id on Workbench's public template pages and in `workbench_flows_get` output); optionally pin which published version to copy. Flows already in this workspace can't be forked — open them instead. Counts toward the plan's flow cap. May return `needs_confirmation`.

Argument	Type	Description
flowUuid*	string	The source flow's public uuid.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
forkedFromVersion	string	Published version label to copy. Default: the latest published.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowUuid"
  ],
  "properties": {
    "flowUuid": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The source flow's public uuid."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "forkedFromVersion": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Published version label to copy. Default: the latest published."
    }
  }
}

workbench_flows_get

One flow. Default `view: summary` lists its nodes and links so you can pick one; `view: node` with a nodeId returns that node's full settings and prompt — read THAT before workbench_flows_edit_text, and copy `find` text from it character-for-character, never from memory. `view: full` returns the whole orchestration body.

read-only

Argument	Type	Description
view	string	`summary` (default): the flow's fields plus one line per node (id, type, label, and how long its prompt is) and the links — enough to pick a node. `node`: the full settings of one node (pass nodeId) — what you need before workbench_flows_edit_text. `full`: the whole orchestration body; large.
flowId*	string	Flow id.
nodeId	string	With view `node`: which node.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "view": {
      "enum": [
        "summary",
        "node",
        "full"
      ],
      "type": "string",
      "description": "`summary` (default): the flow's fields plus one line per node (id, type, label, and how long its prompt is) and the links — enough to pick a node. `node`: the full settings of one node (pass nodeId) — what you need before workbench_flows_edit_text. `full`: the whole orchestration body; large."
    },
    "flowId": {
      "type": "string",
      "description": "Flow id."
    },
    "nodeId": {
      "type": "string",
      "description": "With view `node`: which node."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic)."
    }
  }
}

workbench_flows_list

Lists every flow in the active workspace the caller can see. Returns summaries (id, name, visibility, updatedAt) — fetch one with `workbench_flows_get` for the full orchestration body.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic)."
    }
  }
}

workbench_flows_publish

Snapshots the flow's current DRAFT as a named published version — the version schedules (workbench_flows_schedule), guest share links (workbench_flows_share_create), public-API runs, and 'published'-stage evals execute. The draft keeps evolving after this; runs on the published side don't change until the next publish. Publishing does NOT run the flow, but any eval set to runOnPublish starts a run (that spends credit — mention it when one exists). Refused when the draft hasn't been run since it last changed: try it first with workbench_flows_run on a few real questions, including one it should decline, and read the answers. May return `needs_confirmation`.

destructive

Argument	Type	Description
note	string	What changed — a commit message.
flowId*	string	Flow to publish.
untried	boolean	true only when the person asked to publish this draft without trying it first.
version*	string	Version label, e.g. '1.0.0' or '2026-09-04'. Re-using a label retags it to this snapshot.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

workbench_flows_revisions_list

The flow's revision history, newest first: published versions carry a `version` label and note; entries with version null are draft autosaves. Use it to answer 'is this published?' (any entry with a version), to find a revision id for caliper_evals_create's flowRevisionId, or to see when the draft last changed.

read-only

Argument	Type	Description
limit	integer	Entries to return, default 20.
flowId*	string	Flow id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
publishedOnly	boolean	true = only labeled published versions (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 50,
      "minimum": 1,
      "description": "Entries to return, default 20."
    },
    "flowId": {
      "type": "string",
      "description": "Flow id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "publishedOnly": {
      "type": "boolean",
      "description": "true = only labeled published versions (default false)."
    }
  }
}

workbench_flows_run

Execute a flow and return its outputs synchronously. Runs the draft by default; pass source:"published" (optionally a version) to run the live published version. Spends workspace LLM budget, bounded by the token's cost cap. `input` is the flow's input envelope, e.g. {"kind":"chat","messages":[…]} or {"kind":"form","values":{…}}.

Argument	Type	Description
input	object	Flow input envelope (RunFlowInput). Omit for a flow that needs none.
flowId*	string	Flow id to run.
source	string	Which version to run. Default: draft.
version	string	Published version label (only with source:"published").
timeoutMs	integer	Max runtime in ms (also the hard cost ceiling).
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys.
approvalId	string	Re-call with the approvalId from a needs_confirmation response after the user approves.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "input": {
      "type": "object",
      "description": "Flow input envelope (RunFlowInput). Omit for a flow that needs none.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "flowId": {
      "type": "string",
      "description": "Flow id to run."
    },
    "source": {
      "enum": [
        "draft",
        "published"
      ],
      "type": "string",
      "description": "Which version to run. Default: draft."
    },
    "version": {
      "type": "string",
      "description": "Published version label (only with source:\"published\")."
    },
    "timeoutMs": {
      "type": "integer",
      "maximum": 600000,
      "description": "Max runtime in ms (also the hard cost ceiling).",
      "exclusiveMinimum": 0
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Re-call with the approvalId from a needs_confirmation response after the user approves."
    }
  }
}

workbench_flows_scaffold

Creates a runnable first-draft flow from a spec you author: pick the simplest pattern that fits (classifier for read-and-bucket, structurer for transform/extract/draft-for-review, agent for genuinely conversational), write a production-quality system prompt grounded in what the user told you, and mark anything stubbed with [STUB: ...] markers plus stubNotes. The draft opens in Workbench's simple editor at /w/<workspace>/flows/<id> — give the user that path. May return `needs_confirmation`; show the user what you're proposing and wait for their approval, then re-call with the approvalId. When the draft comes from a Compass change, pass its opportunityId so the flow and the change point at each other (Compass shows 'Open in Workbench'; the flow shows where it came from). Then: workbench_flows_run to try it, workbench_flows_publish when it's ready for schedules and share links.

Argument	Type	Description
mode*	string	Pattern editor the draft opens in. Pick interviewer for conversations that LEARN something from a person (research calls, intake, retros) — pair it with workbench_flows_share_create so non-account humans can talk to it.
model	string	The model node slug the draft runs on, from workbench_node_catalog_get, that the workspace allows. For a classifier, a `decision` entry (Jev, Kev, Solar Decide); defaults to TypeSafe: Jev Latest. Otherwise an `llm` entry (e.g. an OpenAI, Anthropic, or Google model); defaults to Claude Haiku 4.5. Set it here rather than editing the flow afterwards.
flowName*	string	Imperative + specific, ≤80 chars.
stubNotes	string	What's stubbed / missing / worth wiring next.

workbench_flows_scenarios_create

Saves a named scenario: values for the flow's variables, e.g. one demo customer. It shows in the test pane's Scenarios menu, and Caliper evals can run as it. Use the person's details from what the user shared (a CRM screenshot, a profile) and say which ones you made up. May return `needs_confirmation`.

Argument	Type	Description
flowId*	string	Flow id.
values	object	Values by variable name, e.g. { member_first_name: "Lexi", plan_type: "Platinum" }. Names come from workbench_flows_scenarios_list's `variables`; a name the flow doesn't have is left out and reported back.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
scenarioName*	string	What it's called in the menu, e.g. 'Lexi Taylor, Platinum'.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "scenarioName"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id."
    },
    "values": {
      "type": "object",
      "description": "Values by variable name, e.g. { member_first_name: \"Lexi\", plan_type: \"Platinum\" }. Names come from workbench_flows_scenarios_list's `variables`; a name the flow doesn't have is left out and reported back.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "scenarioName": {
      "type": "string",
      "maxLength": 80,
      "minLength": 1,
      "description": "What it's called in the menu, e.g. 'Lexi Taylor, Platinum'."
    }
  }
}

workbench_flows_scenarios_delete

Deletes one scenario. A design session running as it goes back to no scenario. May return `needs_confirmation`.

destructive

Argument	Type	Description
flowId*	string	Flow id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
scenarioId*	string	Scenario id, from workbench_flows_scenarios_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "scenarioId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "scenarioId": {
      "type": "string",
      "description": "Scenario id, from workbench_flows_scenarios_list."
    }
  }
}

workbench_flows_scenarios_list

A flow's variables (each {{token}} in an agent's prompt, with its type) and every saved scenario with its values. Read this before creating or updating a scenario, so the values use the flow's real variable names.

read-only

Argument	Type	Description
flowId*	string	Flow id, from workbench_flows_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id, from workbench_flows_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_flows_scenarios_update

Renames a scenario or changes its values. `values` MERGES into what's saved: pass only the variables that change, and null to clear one. Get the scenarioId from workbench_flows_scenarios_list. May return `needs_confirmation`.

destructive

Argument	Type	Description
flowId*	string	Flow id.
values	object	Values by variable name, e.g. { member_first_name: "Lexi", plan_type: "Platinum" }. Names come from workbench_flows_scenarios_list's `variables`; a name the flow doesn't have is left out and reported back.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
scenarioId*	string	Scenario id, from workbench_flows_scenarios_list.
scenarioName	string	New name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "scenarioId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id."
    },
    "values": {
      "type": "object",
      "description": "Values by variable name, e.g. { member_first_name: \"Lexi\", plan_type: \"Platinum\" }. Names come from workbench_flows_scenarios_list's `variables`; a name the flow doesn't have is left out and reported back.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "scenarioId": {
      "type": "string",
      "description": "Scenario id, from workbench_flows_scenarios_list."
    },
    "scenarioName": {
      "type": "string",
      "maxLength": 80,
      "minLength": 1,
      "description": "New name."
    }
  }
}

workbench_flows_schedule

Set a specific built flow to run automatically on a cadence — the deterministic counterpart to a routine. Each run executes the flow's latest PUBLISHED revision with the fixed `input` envelope and routes the output per `delivery`. USE THIS when the user wants a flow they've built to run on a schedule ("run my digest flow every morning"). Do NOT create a routine for this — a routine runs a free-form instruction, not a built flow. The schedule runs the PUBLISHED flow, so the flow must be published (check workbench_flows_revisions_list; publish with workbench_flows_publish if it isn't). `input` is fixed for every run, so the flow itself should fetch anything time-varying at run time. Manage existing schedules with workbench_flows_schedules_list / workbench_flows_schedules_update.

Argument	Type	Description
input*	any	Fixed input envelope every run executes with — {"kind":"chat","messages":[…]} or {"kind":"form","values":{…}}, the same shape workbench_flows_run takes. Constant across runs.
label	any
flowId*	string	Flow to schedule (id from workbench_flows_list).
delivery	string
interval	string	Plain cadence: hourly, daily, or weekly. Omit when passing recurrence.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys.

workbench_flows_schedules_delete

Removes a schedule for good. Prefer workbench_flows_schedules_update with enabled: false when the user might want it back. May return `needs_confirmation`.

destructive

Argument	Type	Description
flowId*	string	Flow the schedule belongs to.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
scheduleId*	string	Schedule id, from workbench_flows_schedules_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "scheduleId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow the schedule belongs to."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "scheduleId": {
      "type": "string",
      "description": "Schedule id, from workbench_flows_schedules_list."
    }
  }
}

workbench_flows_schedules_list

Every schedule on one flow: cadence, whether it's paused (`enabled: false`), the next fire time, delivery, and the last run's status. Read this before workbench_flows_schedule (don't create a duplicate) and to get the scheduleId for workbench_flows_schedules_update / workbench_flows_schedules_delete / workbench_flows_schedules_run_now.

read-only

Argument	Type	Description
flowId*	string	Flow id, from workbench_flows_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id, from workbench_flows_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_flows_schedules_run_now

Runs one iteration of a schedule immediately through the real scheduled pipeline (same input, same delivery — the email or channel it normally posts to) without moving its cadence. Works on paused schedules. Use it to test a schedule the user just set up. Spends workspace credit and delivers for real, so it sits behind the approval gate — may return `needs_confirmation`. The run is fire-and-forget: check workbench_flows_schedules_list for lastStatus, or workbench_executions_get for the trace.

Argument	Type	Description
flowId*	string	Flow the schedule belongs to.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
scheduleId*	string	Schedule id, from workbench_flows_schedules_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "scheduleId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow the schedule belongs to."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "scheduleId": {
      "type": "string",
      "description": "Schedule id, from workbench_flows_schedules_list."
    }
  }
}

workbench_flows_schedules_update

Changes one schedule: `enabled: false` pauses it (configuration kept), `enabled: true` resumes and recomputes the next fire time from now; `interval` / `scheduleTime` / `scheduleTimezone` / `scheduleDayOfWeek` change the cadence; `label`, `delivery`, and `input` can change too. Pass only what changes. Get the scheduleId from workbench_flows_schedules_list. May return `needs_confirmation`.

destructive

Argument	Type	Description
input	any	New fixed input envelope — {"kind":"chat","messages":[…]} or {"kind":"form","values":{…}}.
label	any
flowId*	string	Flow the schedule belongs to.
enabled	boolean	false pauses, true resumes.
delivery	string
interval	string	New cadence: hourly, daily, or weekly.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string

workbench_flows_share_create

Creates a no-account guest link where anyone can chat with the flow's latest PUBLISHED revision at workbench's /s/<token> page — the fastest way to put a working flow in a stakeholder's hands ('here, try it'). The flow must have a published version (workbench_flows_revisions_list shows it; publish with workbench_flows_publish if not). Conversations are capped per guest; the link can expire, and you can list links with workbench_flows_shares_list and kill one with workbench_flows_shares_revoke. May return `needs_confirmation` — say who the link is for and wait.

Argument	Type	Description
label	string	Who/what this link is for, e.g. 'support pilot'.
flowId*	string	Flow to share.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this.
approvalId	string	Approval id from a prior needs_confirmation envelope.
expiresInDays	integer	Days until the link dies. Omit = revoke-only.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "label": {
      "type": "string",
      "description": "Who/what this link is for, e.g. 'support pilot'."
    },
    "flowId": {
      "type": "string",
      "description": "Flow to share."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation envelope."
    },
    "expiresInDays": {
      "type": "integer",
      "maximum": 365,
      "minimum": 1,
      "description": "Days until the link dies. Omit = revoke-only."
    }
  }
}

workbench_flows_shares_list

Every guest link on one flow, newest first: label, whether it's still live, the shareUrl (live links only — dead ones have no URL), expiry, and how many guests and messages it has seen. Use it to answer 'who has access', to recover a link the user lost, and to get the shareId for workbench_flows_shares_revoke.

read-only

Argument	Type	Description
flowId*	string	Flow id, from workbench_flows_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow id, from workbench_flows_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_flows_shares_revoke

Kills one guest link immediately — anyone holding it gets a closed page from then on. Conversations already had stay in the flow's history. Get the shareId from workbench_flows_shares_list. May return `needs_confirmation`.

destructive

Argument	Type	Description
flowId*	string	Flow the link belongs to.
shareId*	string	Share id, from workbench_flows_shares_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "shareId"
  ],
  "properties": {
    "flowId": {
      "type": "string",
      "description": "Flow the link belongs to."
    },
    "shareId": {
      "type": "string",
      "description": "Share id, from workbench_flows_shares_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_flows_update

Changes a flow's name, description, visibility, tags, or archived state — the metadata around the flow, NOT its orchestration (prompts and nodes change through workbench_flows_edit_text). Pass only what changes. Archiving hides the flow from the default gallery but leaves it runnable, scheduled, and shared; pass archived: false to restore. May return `needs_confirmation`.

destructive

Argument	Type	Description
tags	array	Replacement tag set (lowercase labels). The whole set, not a diff.
flowId*	string	Flow id, from workbench_flows_list.
archived	boolean	true archives, false restores.
flowName	string	New name.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
visibility	string	Who can see it: PRIVATE (only the user), WORKSPACE (every member, the default), or SHARED (specific people, granted afterwards). Say 'make it private' → PRIVATE.

workbench_kb_add_documents

Adds documents to a knowledge base and starts ingestion (chunk + embed; graph KBs also extract entities; tabular KBs load CSV as tables). Text goes inline (Markdown, plain text, CSV — encoding utf8); binary files (PDF, .docx) go base64-encoded with their mimeType. Up to 50 sources per call, ~10 MB each. Ingestion runs in the BACKGROUND — the result carries a runId; check it with workbench_kb_ingestion_status when the user asks, don't poll. workbench_kb_search works once it finishes. Content from <attached-file> blocks is ideal source material. Check workbench_kb_documents_list first so you don't add a document twice. Embedding spends workspace inference credit, so this sits behind the approval gate: may return `needs_confirmation`.

Argument	Type	Description
kbId*	string	Knowledge base id (from workbench_kb_list or workbench_kb_create).
sources*	array	Documents to ingest (1-50).
workspace	string	Workspace slug override.
approvalId	string	Approval id from a prior needs_confirmation envelope.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId",
    "sources"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id (from workbench_kb_list or workbench_kb_create)."
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "content"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 300,
            "minLength": 1,
            "description": "Document name, e.g. 'refund-policy.md' or 'handbook.pdf'."
          },
          "content": {
            "type": "string",
            "maxLength": 10000000,
            "minLength": 1,
            "description": "The document: full text for utf8 sources, base64 bytes for binary ones."
          },
          "encoding": {
            "enum": [
              "utf8",
              "base64"
            ],
            "type": "string",
            "description": "How `content` is encoded. Default utf8; base64 for PDF / docx bytes."
          },
          "mimeType": {
            "type": "string",
            "maxLength": 200,
            "description": "Content type. Default text/markdown for utf8 sources. Required for base64: application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document (.docx), text/csv, …"
          }
        }
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Documents to ingest (1-50)."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug override."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation envelope."
    }
  }
}

workbench_kb_create

Creates an empty knowledge base. Recipe 'docs' (default) for reference material an agent searches at runtime; 'tabular' for spreadsheet-style data queried with SQL; 'graph' for entity/relationship extraction. After creating, add content with workbench_kb_add_documents, then give an agent flow a search tool over it with workbench_flows_attach_knowledge_base (before publishing the flow). May return `needs_confirmation`.

Argument	Type	Description
name*	string	Knowledge base name (1-200 chars).
recipe	string	Default 'docs'.
workspace	string	Workspace slug override.
approvalId	string	Approval id from a prior needs_confirmation envelope.
visibility	string	Who can see it: PRIVATE (only the user), WORKSPACE (every member, the default), or SHARED (specific people, granted afterwards). Say 'make it private' → PRIVATE.
description	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Knowledge base name (1-200 chars)."
    },
    "recipe": {
      "enum": [
        "docs",
        "tabular",
        "graph"
      ],
      "type": "string",
      "description": "Default 'docs'."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug override."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation envelope."
    },
    "visibility": {
      "enum": [
        "PRIVATE",
        "WORKSPACE",
        "SHARED"
      ],
      "type": "string",
      "description": "Who can see it: PRIVATE (only the user), WORKSPACE (every member, the default), or SHARED (specific people, granted afterwards). Say 'make it private' → PRIVATE."
    },
    "description": {
      "type": "string"
    }
  }
}

workbench_kb_delete

Deletes a knowledge base and everything in it. Flows that search it will find nothing — check which agents use it (the user knows; the KB page in Workbench lists them) and say so before proposing. May return `needs_confirmation`.

destructive

Argument	Type	Description
kbId*	string	Knowledge base id, from workbench_kb_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id, from workbench_kb_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_kb_document_delete

Removes one ingested document and all its chunks; searches stop returning it at once. Get the documentId from workbench_kb_documents_list. To replace a document, remove it then workbench_kb_add_documents the new version. May return `needs_confirmation`.

destructive

Argument	Type	Description
kbId*	string	Knowledge base id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
documentId*	string	Document id, from workbench_kb_documents_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId",
    "documentId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "documentId": {
      "type": "string",
      "description": "Document id, from workbench_kb_documents_list."
    }
  }
}

workbench_kb_documents_list

Every document ingested into the KB's current content: id, name, type, size, chunk count. Empty for a KB with nothing ingested yet (or one whose ingestion is still running — check workbench_kb_ingestion_status). Use it before workbench_kb_add_documents to avoid re-adding a document, and to get the documentId for workbench_kb_document_delete.

read-only

Argument	Type	Description
kbId*	string	Knowledge base id, from workbench_kb_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id, from workbench_kb_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_kb_get

One knowledge base: name, recipe (docs / tabular / graph), status, document and chunk counts, embedding model, and ingestion settings. Read it to confirm a KB has content before pointing a flow at it. Get the kbId from workbench_kb_list.

read-only

Argument	Type	Description
kbId*	string	Knowledge base id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_kb_ingestion_status

The state of one ingestion run started by workbench_kb_add_documents: PENDING / RUNNING / DONE / FAILED, chunks written, and the error when it failed. Read it when the user asks whether their documents are in yet, or before a search that needs them — don't poll in a loop; ingestion of a few documents takes under a minute. Pass the runId the add-documents call returned.

read-only

Argument	Type	Description
kbId*	string	Knowledge base id.
runId*	string	Ingestion run id, from workbench_kb_add_documents.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId",
    "runId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id."
    },
    "runId": {
      "type": "string",
      "description": "Ingestion run id, from workbench_kb_add_documents."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_kb_list

Lists every knowledge base in the active workspace the caller can see. Returns summaries (id, name, description, status, doc/chunk counts, embedding model). Use an id with `workbench_kb_search` to retrieve content.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys (workspace is intrinsic)."
    }
  }
}

workbench_kb_search

Retrieves the most relevant chunks from one knowledge base — the core RAG primitive. `mode:"semantic"` (default) embeds the query and ranks by meaning (spends a small amount of workspace credit); `mode:"keyword"` is a free case-insensitive substring match. Each hit carries the chunk text, its document, and a score (cosine similarity 0-1 for semantic, match count for keyword). Get a kbId from `workbench_kb_list`.

read-only

Argument	Type	Description
kbId*	string	Knowledge base id (from workbench_kb_list).
mode	string	semantic (embed + rank by meaning, default) or keyword (free substring match).
limit	integer	Max hits to return, 1-50. Default 10.
query*	string	What to search for.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId",
    "query"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base id (from workbench_kb_list)."
    },
    "mode": {
      "enum": [
        "semantic",
        "keyword"
      ],
      "type": "string",
      "description": "semantic (embed + rank by meaning, default) or keyword (free substring match)."
    },
    "limit": {
      "type": "integer",
      "maximum": 50,
      "description": "Max hits to return, 1-50. Default 10.",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "What to search for."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys."
    }
  }
}

workbench_node_catalog_get

The ground truth for what nodes exist and what their ports actually are — verify against this instead of recalling. Search by keyword/category for summaries; pass `slug` for one node's full detail (inputs, outputs, settings). Inputs are PORTS fed by links; settings live on the node — see `workbench_flow_authoring_guide`. The catalog is the WORKSPACE'S: model nodes the workspace's inference policy forbids come back with `allowed: false` — never author with those; pick an allowed model. Pass `flowId` to include the flow's pinned imports as nodes.

read-only

Argument	Type	Description
q	string	Keyword over slug / name / tagline / description.
slug	string	Exact node slug → full detail for that one node (ports + settings).
limit	integer	Results per page, 1-50. Default 20.
flowId	string	A flow whose pinned imports should appear as `imported-<uuid>` nodes.
offset	integer	Pagination offset.
category	string	Filter by category.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; the catalog's policy annotation is per workspace.

workbench_shim_add_answer

Adds one answer (a label and, optionally, when it applies). The shim needs three examples of it before it builds again with the new answer. May return `needs_confirmation`.

Argument	Type	Description
answer*	string
shimId*	string	Shim id, from workbench_shim_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
description	string	When this answer applies.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "shimId",
    "answer"
  ],
  "properties": {
    "answer": {
      "type": "string",
      "maxLength": 80,
      "minLength": 1
    },
    "shimId": {
      "type": "string",
      "description": "Shim id, from workbench_shim_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "description": "When this answer applies."
    }
  }
}

workbench_shim_add_examples

Adds example inputs to one answer. Write inputs a real person would actually type in the shim's setting — varied in length, register and specifics, each one clearly this answer and not another — never paraphrases of the answer's name. Read the shim first so new examples fit alongside the existing ones and land where recall is low. Exact duplicates are skipped. The shim rebuilds on its own afterwards; read it again for the new report. May return `needs_confirmation`.

Argument	Type	Description
answer*	string	The answer these examples belong to, exactly as labelled.
shimId*	string	Shim id, from workbench_shim_list.
examples*	array
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "shimId",
    "answer",
    "examples"
  ],
  "properties": {
    "answer": {
      "type": "string",
      "description": "The answer these examples belong to, exactly as labelled."
    },
    "shimId": {
      "type": "string",
      "description": "Shim id, from workbench_shim_list."
    },
    "examples": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 4000,
        "minLength": 1
      },
      "maxItems": 100,
      "minItems": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_shim_create

Creates a shim from a name, the question it answers, and its answers. Add examples afterwards with workbench_shim_add_examples — three or more per answer and it builds on its own. May return `needs_confirmation`.

Argument	Type	Description
name*	string	A short name, e.g. "Support triage".
answers*	array
question*	string	The question, e.g. "Which team should read this message?"
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
inputsComeFrom	string	One line on where the inputs come from, in the user's words.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "question",
    "answers"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A short name, e.g. \"Support triage\"."
    },
    "answers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "label"
        ],
        "properties": {
          "label": {
            "type": "string",
            "maxLength": 80,
            "minLength": 1
          },
          "description": {
            "type": "string",
            "maxLength": 1000,
            "description": "When this answer applies."
          }
        }
      },
      "maxItems": 64,
      "minItems": 2
    },
    "question": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "The question, e.g. \"Which team should read this message?\""
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "inputsComeFrom": {
      "type": "string",
      "maxLength": 2000,
      "description": "One line on where the inputs come from, in the user's words."
    }
  }
}

workbench_shim_get

One shim in full: the question, where its inputs come from, every answer with its description and examples, what the shim still needs before it can build, and the newest build's report — held-out accuracy, recall per answer, which answers get mistaken for which, and the compiler's notes. Read it before writing examples: match the setting and the existing examples' register, and put new examples where recall is low or the compiler says an answer is thin.

read-only

Argument	Type	Description
shimId*	string	Shim id, from workbench_shim_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "shimId"
  ],
  "properties": {
    "shimId": {
      "type": "string",
      "description": "Shim id, from workbench_shim_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_shim_list

Every shim the user can see: id, name, the question it answers, how many answers and examples it has, and the published version's held-out accuracy (null until something is published). A shim is a small decision model that runs inside an app with no model call. Start here to get a shimId.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_tasks_act

Records THIS user's verdict on a run that is waiting on them — the labels come from the gate (workbench_tasks_run_view shows them via the plan; a wrong label errors listing the real options). Echo the verdict + note back to the user in one line BEFORE calling; that echo is the confirmation. Refuses when the gate is assigned to someone else.

Argument	Type	Description
note	string	The user's reasoning, attached to the verdict.
runId*	string	Task run id that is waiting_human.
verdict*	string	One of the gate's verdict labels, e.g. "confirmed".
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "runId",
    "verdict"
  ],
  "properties": {
    "note": {
      "type": "string",
      "maxLength": 2000,
      "description": "The user's reasoning, attached to the verdict."
    },
    "runId": {
      "type": "string",
      "description": "Task run id that is waiting_human."
    },
    "verdict": {
      "type": "string",
      "description": "One of the gate's verdict labels, e.g. \"confirmed\"."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_tasks_compile

Runs the compiler over a sentence and returns the PROPOSED plan (or repair-grade problems — fix by refining the sentence with the user, not by guessing). Nothing persists. Present the proposal in plain terms: which clauses run flows, which you will handle, who decides, what the compiler noted. `computer.sites` lists sites the plan names and whether the Task allows them; workbench_tasks_set_sites asks an admin to allow the rest. Then iterate or freeze. Compile may take ~15s.

Argument	Type	Description
taskId	string	The task this sentence belongs to, when compiling an edit — keeps it out of the child-task candidates.
sentence*	string	The sentence to compile.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Re-call with the approvalId from a needs_confirmation response after the user approves.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "sentence"
  ],
  "properties": {
    "taskId": {
      "type": "string",
      "description": "The task this sentence belongs to, when compiling an edit — keeps it out of the child-task candidates."
    },
    "sentence": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "The sentence to compile."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Re-call with the approvalId from a needs_confirmation response after the user approves."
    }
  }
}

workbench_tasks_create

Creates a DRAFT Task from a name + sentence. A Task is for work with people in the loop (someone approves, decides or acts on each item before anything else happens) or a specific process mapped in Compass; its runs are measured. When nobody but you acts on it and you'd just do the same thing each time on a schedule, make a routine instead (routines_create). Use this once the user's sentence feels settled after you've refined it together — then compile it. The sentence should be THEIR words: trigger first ('When a claim arrives…'), then steps, branches, and who decides what. Name rooms, sheets, tables, flows and people by their names, never by id: people read the sentence on the Task's page.

Argument	Type	Description
sentence*	string	The process sentence, in the user's words.
taskName*	string	Short task name.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskName",
    "sentence"
  ],
  "properties": {
    "sentence": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "The process sentence, in the user's words."
    },
    "taskName": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Short task name."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_tasks_delete

Deletes a task. Runs still in flight are stopped (a gate waiting on someone is closed), and its schedule trigger stops firing; past runs stay in history. Check workbench_tasks_get for live runs and say so before proposing. May return `needs_confirmation`.

destructive

Argument	Type	Description
taskId*	string	Task id, from workbench_tasks_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskId"
  ],
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Task id, from workbench_tasks_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_tasks_freeze

Freezes a reviewed plan as the Task's next version and activates it. Pass the EXACT plan object a compile returned — never hand-edit it (change the sentence and recompile instead). Freeze ONLY after the user has seen the proposal and said go; echo what you're freezing in one line first. In-flight runs keep their pinned versions. After freezing, offer to start a first run.

destructive

Argument	Type	Description
plan*	any	The plan object from workbench_tasks_compile, verbatim.
taskId*	string	The task id (create a draft first if none).
sentence*	string	The sentence this plan was compiled from.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskId",
    "sentence",
    "plan"
  ],
  "properties": {
    "plan": {
      "description": "The plan object from workbench_tasks_compile, verbatim."
    },
    "taskId": {
      "type": "string",
      "description": "The task id (create a draft first if none)."
    },
    "sentence": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "The sentence this plan was compiled from."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_tasks_get

One Task in full: its sentence, status, the latest saved plan (the clauses — which run flows, which the assistant handles, who decides at each gate) with the flow and people names the plan refers to, and its recent runs, plus the sites its machine may reach (allowedSites) and the sites its plan names or past runs were refused (computer.sites). Read this before editing a task's sentence (workbench_tasks_compile with taskId) and when the user asks what a task does. Get the taskId from workbench_tasks_list.

read-only

Argument	Type	Description
taskId*	string	Task id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskId"
  ],
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Task id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_tasks_list

Lists the workspace's Tasks — sentence-orchestrated processes — with their sentence, status, and recent runs (id, status, who a waiting run is on). Use this to find a task the user names ('claims intake') and to see what's in flight; workbench_tasks_get reads one in full.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_tasks_run_view

The run's current state rendered as its sentence: what ran (with timings), which path each gate took, what's waiting on whom and for how long, what's coming up. Use whenever the user asks where something stands, and after acting on a gate.

read-only

Argument	Type	Description
runId*	string	Task run id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "runId"
  ],
  "properties": {
    "runId": {
      "type": "string",
      "description": "Task run id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

workbench_tasks_set_sites

Sets the full list of sites a Task's machine may reach (example.com, or *.example.com for its subdomains; up to 20), for steps that have to use a site like a person would. It replaces the list, so read workbench_tasks_get first (allowedSites, and computer.sites for what the plan names) and pass every site to keep. Always waits for approval, and only a workspace admin's approval applies it; for anyone else it says who can. The latest saved version runs with the new list.

Argument	Type	Description
sites*	array	Every site the Task may reach.
taskId*	string	Task id, from workbench_tasks_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskId",
    "sites"
  ],
  "properties": {
    "sites": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 253,
        "minLength": 1
      },
      "maxItems": 20,
      "description": "Every site the Task may reach."
    },
    "taskId": {
      "type": "string",
      "description": "Task id, from workbench_tasks_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_tasks_start

Kicks off a run of a Task and returns at once; the run carries on by itself and is live on the task's page. When the task expects an input document (its trigger has an input), pass the user's material as `input` — pasted text, extracted attachment text, or JSON. Tell the user it has started and what it does next. Check where it stands with workbench_tasks_run_view when they ask; don't poll it in a loop.

Argument	Type	Description
input	any	Trigger payload — the document text / JSON the task starts from.
taskId*	string	Task id (from workbench_tasks_list).
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskId"
  ],
  "properties": {
    "input": {
      "description": "Trigger payload — the document text / JSON the task starts from."
    },
    "taskId": {
      "type": "string",
      "description": "Task id (from workbench_tasks_list)."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

workbench_tasks_update

Changes a task's name — the gallery label only. The sentence and plan are versioned and change through workbench_tasks_compile + workbench_tasks_freeze, never here. May return `needs_confirmation`.

destructive

Argument	Type	Description
taskId*	string	Task id, from workbench_tasks_list.
taskName*	string	New name.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "taskId",
    "taskName"
  ],
  "properties": {
    "taskId": {
      "type": "string",
      "description": "Task id, from workbench_tasks_list."
    },
    "taskName": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "New name."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "mode",
    "flowName"
  ],
  "properties": {
    "mode": {
      "enum": [
        "agent",
        "structurer",
        "classifier",
        "interviewer"
      ],
      "type": "string",
      "description": "Pattern editor the draft opens in. Pick interviewer for conversations that LEARN something from a person (research calls, intake, retros) — pair it with workbench_flows_share_create so non-account humans can talk to it."
    },
    "model": {
      "type": "string",
      "description": "The model node slug the draft runs on, from workbench_node_catalog_get, that the workspace allows. For a classifier, a `decision` entry (Jev, Kev, Solar Decide); defaults to TypeSafe: Jev Latest. Otherwise an `llm` entry (e.g. an OpenAI, Anthropic, or Google model); defaults to Claude Haiku 4.5. Set it here rather than editing the flow afterwards."
    },
    "flowName": {
      "type": "string",
      "description": "Imperative + specific, ≤80 chars."
    },
    "stubNotes": {
      "type": "string",
      "description": "What's stubbed / missing / worth wiring next."
    },
    "variables": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The token's name, as in {{name}}."
          },
          "type": {
            "enum": [
              "string",
              "number",
              "boolean",
              "array",
              "object"
            ],
            "type": "string",
            "description": "Default string."
          },
          "description": {
            "type": "string",
            "description": "What the app passes in, e.g. 'The member's first name, from the CRM'."
          }
        }
      },
      "description": "agent / interviewer: types and descriptions for the {{tokens}} in systemPrompt. Every {{token}} becomes a variable on its own (the test pane and scenarios list it, the app fills it per user at run time); pass this only to set a type other than string or say what fills it."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "value"
        ],
        "properties": {
          "value": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "description": "classifier only: 2-12 buckets. The classifier asks the systemPrompt as one pick-one question with these as the options, and returns `values.category` plus `answers.category` (probabilities and confidence)."
    },
    "description": {
      "type": "string",
      "description": "1-2 sentences: what it does, where it fits."
    },
    "systemPrompt": {
      "type": "string",
      "description": "The draft's behavior — production-quality first attempt with [STUB: ...] / [FILL IN: ...] markers where reality is missing. Required for structurer and classifier. Leave it out of an agent to get the bare model with no instructions (a 'promptless' agent)."
    },
    "opportunityId": {
      "type": "string",
      "description": "Compass change (from compass_opportunities_list) this draft implements. Sets the flow ↔ change link; refused when the change already has a draft."
    },
    "inputDescription": {
      "type": "string",
      "description": "What the flow's single input carries."
    },
    "responseSchemaJson": {
      "type": "string",
      "description": "structurer only: the output JSON Schema, JSON-encoded as a string (object root, required fields, additionalProperties false)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "input"
  ],
  "properties": {
    "input": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "kind",
            "messages"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "chat"
            },
            "values": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            },
            "messages": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "role"
                ],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string"
                  },
                  "content": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "array",
                        "items": {}
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "tool_calls": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string"
                        },
                        "function": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "arguments": {}
                          },
                          "additionalProperties": {}
                        }
                      },
                      "additionalProperties": {}
                    }
                  },
                  "tool_call_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": {}
              }
            }
          }
        },
        {
          "type": "object",
          "required": [
            "kind",
            "values"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "form"
            },
            "values": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            }
          }
        }
      ],
      "description": "Fixed input envelope every run executes with — {\"kind\":\"chat\",\"messages\":[…]} or {\"kind\":\"form\",\"values\":{…}}, the same shape workbench_flows_run takes. Constant across runs."
    },
    "label": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "flowId": {
      "type": "string",
      "description": "Flow to schedule (id from workbench_flows_list)."
    },
    "delivery": {
      "enum": [
        "history",
        "notification",
        "email"
      ],
      "type": "string"
    },
    "interval": {
      "enum": [
        "hourly",
        "daily",
        "weekly"
      ],
      "type": "string",
      "description": "Plain cadence: hourly, daily, or weekly. Omit when passing recurrence."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "recurrence": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "freq",
            "timezone"
          ],
          "properties": {
            "ends": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "freq": {
              "enum": [
                "hourly",
                "daily",
                "weekly",
                "monthly",
                "yearly"
              ],
              "type": "string"
            },
            "skip": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "maxItems": 100
            },
            "every": {
              "type": "integer",
              "default": 1,
              "maximum": 366,
              "minimum": 1
            },
            "hours": {
              "type": "object",
              "required": [
                "from",
                "to"
              ],
              "properties": {
                "to": {
                  "type": "string",
                  "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
                },
                "from": {
                  "type": "string",
                  "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
                }
              }
            },
            "times": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
              },
              "maxItems": 24,
              "minItems": 1
            },
            "months": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 12,
                "minimum": 1
              },
              "maxItems": 12,
              "minItems": 1
            },
            "starts": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "minutes": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 59,
                "minimum": 0
              },
              "maxItems": 12,
              "minItems": 1
            },
            "timezone": {
              "type": "string",
              "maxLength": 64,
              "minLength": 1
            },
            "weekdays": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 6,
                "minimum": 0
              },
              "maxItems": 7,
              "minItems": 1
            },
            "monthDays": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 31,
                "minimum": -1
              },
              "maxItems": 31,
              "minItems": 1
            },
            "nthWeekdays": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "nth",
                  "weekdays"
                ],
                "properties": {
                  "nth": {
                    "type": "integer",
                    "maximum": 5,
                    "minimum": -1
                  },
                  "weekdays": {
                    "type": "array",
                    "items": {
                      "type": "integer",
                      "maximum": 6,
                      "minimum": 0
                    },
                    "maxItems": 7,
                    "minItems": 1
                  }
                }
              },
              "maxItems": 5,
              "minItems": 1
            }
          }
        },
        {
          "type": "null"
        }
      ],
      "description": "When it runs, like a calendar event repeats; use it for anything beyond a plain hourly/daily/weekly at one time (then omit interval). {\"freq\":\"hourly\"|\"daily\"|\"weekly\"|\"monthly\"|\"yearly\",\"every\":N,\"times\":[\"HH:MM\"],\"weekdays\":[0=Sun…6=Sat],\"monthDays\":[1…31,-1=last],\"nthWeekdays\":[{\"nth\":1…5|-1,\"weekdays\":[…]}],\"months\":[1…12],\"minutes\":[…],\"hours\":{\"from\",\"to\"},\"timezone\":\"<IANA>\",\"starts\",\"ends\",\"skip\":[\"YYYY-MM-DD\"]}. Examples: weekdays at 8 → {\"freq\":\"weekly\",\"weekdays\":[1,2,3,4,5],\"times\":[\"08:00\"],\"timezone\":\"America/Chicago\"}; the last business day of the month → {\"freq\":\"monthly\",\"nthWeekdays\":[{\"nth\":-1,\"weekdays\":[1,2,3,4,5]}],\"timezone\":\"…\"}; every other Friday → {\"freq\":\"weekly\",\"every\":2,\"weekdays\":[5],\"starts\":\"<a Friday>\",\"timezone\":\"…\"}. null clears it."
    },
    "scheduleTime": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
        },
        {
          "type": "null"
        }
      ]
    },
    "scheduleTimezone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "scheduleDayOfWeek": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 6,
          "minimum": 0
        },
        {
          "type": "null"
        }
      ]
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "flowId",
    "scheduleId"
  ],
  "properties": {
    "input": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "kind",
            "messages"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "chat"
            },
            "values": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            },
            "messages": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "role"
                ],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string"
                  },
                  "content": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "array",
                        "items": {}
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "tool_calls": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string"
                        },
                        "function": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "arguments": {}
                          },
                          "additionalProperties": {}
                        }
                      },
                      "additionalProperties": {}
                    }
                  },
                  "tool_call_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": {}
              }
            }
          }
        },
        {
          "type": "object",
          "required": [
            "kind",
            "values"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "form"
            },
            "values": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {}
            }
          }
        }
      ],
      "description": "New fixed input envelope — {\"kind\":\"chat\",\"messages\":[…]} or {\"kind\":\"form\",\"values\":{…}}."
    },
    "label": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "flowId": {
      "type": "string",
      "description": "Flow the schedule belongs to."
    },
    "enabled": {
      "type": "boolean",
      "description": "false pauses, true resumes."
    },
    "delivery": {
      "enum": [
        "history",
        "notification",
        "email"
      ],
      "type": "string"
    },
    "interval": {
      "enum": [
        "hourly",
        "daily",
        "weekly"
      ],
      "type": "string",
      "description": "New cadence: hourly, daily, or weekly."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "recurrence": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "freq",
            "timezone"
          ],
          "properties": {
            "ends": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "freq": {
              "enum": [
                "hourly",
                "daily",
                "weekly",
                "monthly",
                "yearly"
              ],
              "type": "string"
            },
            "skip": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
              },
              "maxItems": 100
            },
            "every": {
              "type": "integer",
              "default": 1,
              "maximum": 366,
              "minimum": 1
            },
            "hours": {
              "type": "object",
              "required": [
                "from",
                "to"
              ],
              "properties": {
                "to": {
                  "type": "string",
                  "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
                },
                "from": {
                  "type": "string",
                  "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
                }
              }
            },
            "times": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
              },
              "maxItems": 24,
              "minItems": 1
            },
            "months": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 12,
                "minimum": 1
              },
              "maxItems": 12,
              "minItems": 1
            },
            "starts": {
              "type": "string",
              "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
            },
            "minutes": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 59,
                "minimum": 0
              },
              "maxItems": 12,
              "minItems": 1
            },
            "timezone": {
              "type": "string",
              "maxLength": 64,
              "minLength": 1
            },
            "weekdays": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 6,
                "minimum": 0
              },
              "maxItems": 7,
              "minItems": 1
            },
            "monthDays": {
              "type": "array",
              "items": {
                "type": "integer",
                "maximum": 31,
                "minimum": -1
              },
              "maxItems": 31,
              "minItems": 1
            },
            "nthWeekdays": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "nth",
                  "weekdays"
                ],
                "properties": {
                  "nth": {
                    "type": "integer",
                    "maximum": 5,
                    "minimum": -1
                  },
                  "weekdays": {
                    "type": "array",
                    "items": {
                      "type": "integer",
                      "maximum": 6,
                      "minimum": 0
                    },
                    "maxItems": 7,
                    "minItems": 1
                  }
                }
              },
              "maxItems": 5,
              "minItems": 1
            }
          }
        },
        {
          "type": "null"
        }
      ],
      "description": "When it runs, like a calendar event repeats; use it for anything beyond a plain hourly/daily/weekly at one time (then omit interval). {\"freq\":\"hourly\"|\"daily\"|\"weekly\"|\"monthly\"|\"yearly\",\"every\":N,\"times\":[\"HH:MM\"],\"weekdays\":[0=Sun…6=Sat],\"monthDays\":[1…31,-1=last],\"nthWeekdays\":[{\"nth\":1…5|-1,\"weekdays\":[…]}],\"months\":[1…12],\"minutes\":[…],\"hours\":{\"from\",\"to\"},\"timezone\":\"<IANA>\",\"starts\",\"ends\",\"skip\":[\"YYYY-MM-DD\"]}. Examples: weekdays at 8 → {\"freq\":\"weekly\",\"weekdays\":[1,2,3,4,5],\"times\":[\"08:00\"],\"timezone\":\"America/Chicago\"}; the last business day of the month → {\"freq\":\"monthly\",\"nthWeekdays\":[{\"nth\":-1,\"weekdays\":[1,2,3,4,5]}],\"timezone\":\"…\"}; every other Friday → {\"freq\":\"weekly\",\"every\":2,\"weekdays\":[5],\"starts\":\"<a Friday>\",\"timezone\":\"…\"}. null clears it."
    },
    "scheduleId": {
      "type": "string",
      "description": "Schedule id, from workbench_flows_schedules_list."
    },
    "scheduleTime": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
        },
        {
          "type": "null"
        }
      ]
    },
    "scheduleTimezone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "scheduleDayOfWeek": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 6,
          "minimum": 0
        },
        {
          "type": "null"
        }
      ]
    }
  }
}