listAgentMemoryFiles
List Agent Memory Files
List the memory files stored for an agent.
agent_idrequired
io.github.duvoaiPublished by GitHub account duvoaiv2026-05-24Updated Oct 24, 2026
Governed retail, FMCG, and CPG operational tools: runs, cases, approvals, audit-ready execution.
Duvo MCP connects an assistant to a Duvo workspace for governed retail, FMCG and CPG operations, including agent memory, schedules, OAuth connections and Pulse
Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.
Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.
Read https://sourceweft.com/mcp/io.github.duvoai%2Fduvo/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.Add this to your client's mcpServers config.
{
"mcpServers": {
"duvo": {
"type": "http",
"url": "https://api.duvo.ai/v1/mcp",
"headers": {
"Authorization": "Bearer <YOUR_TOKEN>"
}
}
}
}This repository has no README.
List Agent Memory Files
List the memory files stored for an agent.
agent_idrequiredGet Agent Memory File
Get the contents of a single memory file for an agent.
pathrequiredagent_idrequiredList Plugin Catalog
List plugins that can be referenced by name in a build's plugins array. Builds may also reference any public GitHub repository URL (https://github.com/owner/repo) as a plugin; those are not enumerated here.
Takes no parameters.
Create Schedule
Create a schedule for an agent. The schedule fires against the agent's live build. The authenticated user owns the schedule. On a team with versions, a repeating schedule for an Agent in an automation joins that automation's versions: one matching a schedule the automation already runs fires at once, and a new one is saved to the automation's draft and fires once the draft is made active (see `pending_change`).
daycrontimeenabledrequiredagent_idrequiredtimezonerequiredfrequencyrequiredrecurringday_of_monthUpdate Schedule
Update fields on an existing schedule. Only supplied fields are changed; omitted fields retain their current values. Owners may update their own schedules; team superadmins may update any schedule on agents in the current team. A schedule that belongs to an automation with versions keeps firing as its automation's active version says: a change to its timing is saved to the automation's draft and takes effect when the draft is made active (see `pending_change`), while `enabled` applies at once.
daycrontimeenabledagent_idrequiredtimezonefrequencyrecurringschedule_idrequiredday_of_monthDelete Schedule
Delete a schedule. Owners may delete their own schedules; team superadmins may delete any schedule on agents in the current team. Deleting a schedule that belongs to an automation with versions stops it for its owner at once; the automation's versions keep the schedule for anyone else subscribed to it.
agent_idrequiredschedule_idrequiredGet Team
Get a team by ID. The caller must be scoped to the requested team.
team_idStart Native OAuth
Start an OAuth-based connection with a native provider (Gmail, Google Sheets, Outlook, etc.). The provider path parameter is the native OAuth provider key from listIntegrations, not the integration type. Returns an authorization URL that must be opened in a browser by a human end-user; once they grant consent, Duvo creates the matching connection and redirects the browser to the optional `return_url` (or the Duvo dashboard if none is provided). Poll `/v2/teams/:team_id/connections` to detect the new connection.
team_idproviderrequiredreturn_urlreconnect_instance_idAuthorize Mcp OAuth
Start an OAuth-based connection with a remote MCP server using Dynamic Client Registration. Returns an authorization URL the user must open in a browser; once they grant consent, Duvo creates the matching connection and redirects the browser to the optional `returnUrl`.
namerequiredteam_idreturn_urlmcp_server_urlrequiredoauth_client_idintegration_typeoauth_client_secretcustom_integration_idreconnect_instance_idCheck Mcp OAuth
Probe an MCP server URL to discover whether it supports OAuth Dynamic Client Registration. Returns the authorization endpoint and required scopes when supported. Useful as a precursor to `/v2/teams/:team_id/connections/oauth/mcp/start` or `/v2/teams/:team_id/connections`. Performs no writes.
mcp_server_urlrequiredList Pulse Dashboards
List your Duvo Pulse dashboards (live, agent-generated visualizations of your Duvo data). Ordered most recently updated first, except scope=automation, which is ordered by creation time (then id) so the whole scope can be read with the after_id cursor without a concurrent change shifting a page boundary.
limitscopeoffsetafter_idCreate Pulse Dashboard
Create a new Duvo Pulse dashboard from a natural-language prompt (e.g. 'open cases by queue this week') and dispatch the first generation turn. Generation is asynchronous — poll GET /artifacts/{artifactId} until status is completed. The dashboard is private to you unless you set visibility to 'team', which shares it with your whole team straight away — with permission 'view' (teammates see the dashboard) or 'edit' (teammates can also iterate on it).
messagerequiredpermissionvisibilityconnection_idsGet Pulse Dashboard
Get a Duvo Pulse dashboard's metadata and generation status. When status is completed and html_code_present is true, fetch the rendered HTML from GET /artifacts/{artifactId}/render; the conversation is served by GET /artifacts/{artifactId}/messages.
artifactIdrequiredList Pulse Data Sources
Discover queues the current editor may connect to this team-created Pulse before sampling data. Requires live dashboard edit permission and ordinary team data access. Module sources are installed with the Module. A queue ID in generated code does not grant access.
limitoffsetartifact_idrequiredConnect Pulse Data Source
Connect an authorized same-team queue to a team-created Pulse before sampling it. Idempotent. This bounds dashboard data access; it never grants Process membership or case-action authority. Requires both edit permission and ordinary team source access.
queue_idrequiredartifact_idrequiredDisconnect Pulse Data Source
Disconnect a source from a team-created dashboard. Subsequent dashboard reads and writes immediately lose access. Idempotent; does not delete the queue or cases.
queue_idrequiredartifact_idrequiredGet Pulse Dashboard Html
Serve a Duvo Pulse dashboard's rendered HTML document (text/html, not JSON). 404 until the first generation turn has produced HTML.
artifactIdrequiredGet Pulse Dashboard Pdf
Render a Duvo Pulse dashboard to a PDF document (application/pdf, not JSON). 404 until the first generation turn has produced HTML; 409 for an openui dashboard, whose substrate this exporter cannot render.
themeartifactIdrequiredExport Pulse Dashboard Html
Render a Duvo Pulse dashboard to a self-contained static HTML snapshot (text/html, data baked in). 404 until the first generation turn has produced HTML; 409 for an openui dashboard, whose substrate this exporter cannot render.
themeartifactIdrequiredUpdate Pulse Dashboard
Update a Duvo Pulse dashboard's settings — rename it. Only the creator can update it.
titlerequiredartifactIdrequiredPublish Pulse Dashboard
Publish (share) a Duvo Pulse dashboard to your whole team or your whole organization, or revert it to private (creator only). When publishing, set permission to 'view' (teammates see the dashboard) or 'edit' (teammates can also iterate on it); organization-wide viewers outside the team always get view-only access.
artifactIdrequiredpermissionvisibilityrequiredDelete Pulse Dashboard
Delete a Duvo Pulse dashboard. Only the creator can delete it.
artifactIdrequiredDuplicate Pulse Dashboard
Duplicate a Duvo Pulse dashboard, producing an idle clone of the current rendered dashboard. The conversation history, shares, and connections are not copied.
artifactIdrequiredSend Pulse Dashboard Message
Send an instruction to iterate on a Duvo Pulse dashboard (e.g. 'make it a bar chart', 'filter to last 14 days'). The creator can always iterate; teammates can too when the Pulse is published to the team with edit access. The agent regenerates asynchronously — poll GET /artifacts/{artifactId} for status.
messagerequiredartifactIdrequiredattachmentsfrom_revision_idselected_elementCreate Pulse Dashboard Attachment Upload Url
Issue a presigned upload URL for a file to attach to a Duvo Pulse dashboard message (e.g. an HTML dashboard to copy, or a screenshot to match). POST the file bytes to the returned upload_url as multipart form data under the field name 'file', then pass the returned attachment_id in the attachments array of POST /artifacts/{artifactId}/messages. The agent reads the file directly from its sandbox. Files live as long as the dashboard's sandbox (about 12 hours), so upload shortly before sending.
filenamerequiredmime_typerequiredartifactIdrequiredsize_bytesrequiredGet Pulse Dashboard Attachment Download Url
Mint a short-lived presigned URL to download or preview a file attached to a Duvo Pulse dashboard message. Returns 404 once the dashboard's sandbox has expired and the file is gone (about 12 hours).
artifactIdrequiredattachmentIdrequiredRefresh Pulse Dashboard
Trigger an on-demand data refresh of a Duvo Pulse dashboard. The dashboard regenerates its connection-sourced values in the background — poll GET /artifacts/{artifactId} for status.
artifactIdrequiredStop Pulse Dashboard Message
Stop an in-flight Duvo Pulse generation turn. Requires edit access to the dashboard. Flips the dashboard to 'interrupted' and keeps any streamed-so-far reply; stopping when nothing is generating is a successful no-op.
artifactIdrequiredpartial_textList Pulse Dashboard Connections
List the connections (data sources) attached to a Duvo Pulse dashboard (requires edit access).
artifactIdrequiredAttach Pulse Dashboard Connection
Attach one of your connections (data sources) to a Duvo Pulse dashboard so the agent can use its tools (requires edit access).
artifactIdrequiredconnection_idrequiredDetach Pulse Dashboard Connection
Detach a connection (data source) from a Duvo Pulse dashboard (requires edit access).
artifactIdrequiredconnectionIdrequiredAnswer Pulse Dashboard Question
Answer a pending question the Duvo Pulse agent asked and resume the paused run (creator or team editors). Use the toolCallId from the dashboard's message transcript.
answersrequiredartifactIdrequiredtoolCallIdrequiredList Pulse Dashboard Messages
List the chat transcript of a Duvo Pulse dashboard's live version (requires edit access). Returns the most recent page by default, oldest first within the page; pass `before` (a message id from a previous page) to walk back through older messages. Messages from other version branches are not included.
limitbeforeartifactIdrequiredList Pulse Dashboard Comments
List the comment threads on a Duvo Pulse dashboard (requires view access). Each thread carries its author, the dashboard element it is pinned to, its replies oldest-first, and whether it has been marked complete.
limitoffsetstatusartifactIdrequiredCreate Pulse Dashboard Comment
Start a comment thread on a Duvo Pulse dashboard (requires view access). Pass `element` — captured from the dashboard canvas — to pin the thread to one element; omit it for a comment on the dashboard as a whole.
bodyrequiredelementartifactIdrequiredrevision_idCreate Pulse Dashboard Comment Reply
Reply to a comment thread on a Duvo Pulse dashboard (requires view access). `commentId` must be a thread root; threads are one level deep. A thread already marked complete still accepts replies and stays complete.
bodyrequiredcommentIdrequiredartifactIdrequiredSet Pulse Dashboard Comment Resolution
Mark a Duvo Pulse dashboard comment thread complete, or reopen it (requires view access). Pass the target state in `resolved`; the call is idempotent, and the response carries the thread with `resolved_at` and `resolved_by` set or cleared.
resolvedrequiredcommentIdrequiredartifactIdrequiredDelete Pulse Dashboard Comment
Delete a comment or reply on a Duvo Pulse dashboard. Allowed for the comment's author and for the dashboard's creator. Deleting a thread root keeps its replies, rendered under a deleted opening comment.
commentIdrequiredartifactIdrequiredList Pulse Dashboard Versions
List the version history of a Duvo Pulse dashboard, newest first (requires edit access). Use the version id with the restore and version-render endpoints.
artifactIdrequiredGet Pulse Dashboard Version Html
Serve a specific version's rendered HTML document for a Duvo Pulse dashboard (text/html, requires edit access).
artifactIdrequiredrevisionIdrequiredRestore Pulse Dashboard Version
Restore a previous version of a Duvo Pulse dashboard, making it live again (requires edit access). Non-destructive — it moves the head pointer to the chosen version.
artifactIdrequiredrevisionIdrequiredCreate Sandbox
Create a new sandbox for file uploads. The returned sandbox_id can be passed to POST /v2/teams/:team_id/runs to stage data for a run.
Takes no parameters.
Create Sandbox Upload Url
Get a presigned URL for uploading a file into a sandbox. Use for files larger than 10MB; smaller files can be uploaded directly via POST /v2/sandboxes/:sandbox_id/files.
pathrequiredsandbox_idrequiredList Sandbox Files
List files in a sandbox directory.
pathsandbox_idrequiredUpload Sandbox File
Upload a file directly to the sandbox. Maximum file size is 10MB. For larger files, use POST /v2/sandboxes/:sandbox_id/upload-urls.
sandbox_idrequiredGet Run Evaluation
Get the latest evaluation analysis for a specific agent run (Run).
runIdrequiredagentIdrequiredGet Eval Scores
Aggregate evaluation counts and flag distribution for an Assignment's Jobs since the given timestamp.
scopesincerequiredagentIdrequiredrevision_idGet Eval Rubrics
List the evaluation rubrics a Run is scored against: the platform default rubrics plus the Agent-specific rubrics for a build. Defaults to the Agent's live build; pass build_id to target the revision a specific Run ran against.
agentIdrequiredbuild_idCreate Eval Rubric
Add one Agent-specific evaluation rubric to a build. A build may hold at most 5 custom rubrics by default (25 on teams with the newer rubric generator enabled); this fails with 409 once the build's ceiling is reached, and the error message states it. Defaults to the Agent's live build; pass build_id to target a specific revision.
titlerequiredagentIdrequiredbuild_iddescriptionrequiredselected_automation_revision_idReplace Eval Rubrics
Replace a build's entire Agent-specific evaluation rubric set in one call (at most 5 rubrics by default, 25 on teams with the newer rubric generator enabled). Existing custom rubrics are removed and the supplied list becomes the new set; pass an empty array to clear them. Defaults to the Agent's live build; pass build_id to target a specific revision.
agentIdrequiredrubricsrequiredbuild_idselected_automation_revision_idUpdate Eval Rubric
Edit a single Agent-specific evaluation rubric's title and/or description. The edit produces a NEW rubric (with a new id and slug) so previously scored Runs stay attributed to the original criterion; the response contains the new rubric.
titleagentIdrequiredrubricIdrequireddescriptionselected_automation_revision_idDelete Eval Rubric
Remove a single Agent-specific evaluation rubric. Future Runs on the build are no longer scored against it.
agentIdrequiredrubricIdrequiredselected_automation_revision_idList Agent Schedules
List the schedules you own on an agent. Returns only your own schedules, whoever you are. Callers with an elevated team role can read every member's schedules on the agent, including who created each one, via `GET /agents/{agent_id}/schedules/all`.
agent_idrequiredList All Agent Schedules
List every team member's schedules on an agent, including who created each one. Requires an elevated team role; callers without one receive 403 and should use `GET /agents/{agent_id}/schedules`, which returns only the schedules they own.
agent_idrequiredList Agent Case Triggers
List the case triggers configured for an agent. Each trigger automatically dispatches the agent to run cases added to a queue.
agent_idrequiredPreview Agent Case Trigger Conflicts
Preview which other agents would conflict with this agent's case trigger if it pointed at the given queue. Does not modify the trigger.
agent_idrequiredcase_queue_idrequiredGet Agent Case Trigger
Retrieve a single case trigger by id.
agent_idrequiredtrigger_idrequiredCreate Agent Case Trigger
Create a case trigger for an agent. An agent may have at most one case trigger; this returns 409 if one already exists.
enabledrequiredagent_idrequiredconcurrencycase_queue_idrequiredUpdate Agent Case Trigger
Update fields on a case trigger. Only the trigger creator or a builder/admin can disable an enabled trigger or change its queue, and only a builder/admin can change queue concurrency.
enabledagent_idrequiredtrigger_idrequiredconcurrencycase_queue_idDelete Agent Case Trigger
Delete a case trigger. Only the trigger creator or a builder/admin can delete it.
agent_idrequiredtrigger_idrequiredList Agent Triggers
List the trigger definitions the authenticated user owns on an agent (Agent in the Duvo UI). Triggers start a Run automatically when an external event fires (e.g. an email arrives or a Linear issue is created).
agentIdrequiredUpsert Agent Trigger
Create or update the authenticated user's trigger for an integration on an agent. The integration must already be connected to the agent (its OAuth connection set up in the Duvo dashboard). Set `enabled: false` to pause a trigger without deleting it. An agent holds one trigger per integration for a user, so a save with a different `trigger_type` replaces the existing one — except when that trigger is an @mention trigger, which is managed from the agent's mention setting and answers 409 (`mention_trigger_protected`) here. @mention triggers are best managed from that setting throughout: this route leaves an existing one's `filter_config` untouched, and refuses to create a `teams_mention` trigger without a `filter_config.tenantId` (400, `mention_trigger_workspace_required`) — a Slack mention trigger has no equivalent field to supply.
agentIdrequiredenabledtrigger_typerequiredfilter_configintegration_slugrequiredDelete Agent Trigger
Permanently delete one of your own event triggers on an agent. The agent stops starting Runs for that event and the trigger's filter config is lost. To keep the trigger but stop it firing, upsert it with `enabled: false` instead.
agentIdrequiredtriggerIdrequiredList Agent Trigger Types
List the trigger types available for an agent, grouped by integration. Use the returned `integration_slug` and `trigger_type` values when creating a trigger.
agentIdrequiredCreate Slack Channel Trigger
Create a Slack channel trigger on an agent (Agent in the Duvo UI): the agent starts a Run whenever a matching message is posted in the channel. An agent can carry one trigger per channel, so call this once per channel. The Slack workspace must be installed for the team AND bound to the agent's live build first (see the Slack bound-workspaces endpoint) — otherwise this returns 400.
agent_idrequiredchannel_idrequiredis_privatematch_rulerequiredchannel_namerequiredtrigger_typerequiredslack_team_idintegration_instance_idList Slack Channel Triggers
List the Slack channel triggers you own on an agent (Agent in the Duvo UI), oldest first. Each trigger's `filter_config` carries the watched `channelId`, `channelName`, Slack `workspaceId`, and `matchRule`. Capped at 100 triggers per agent.
agent_idrequiredUpdate Slack Channel Trigger
Update a Slack channel trigger you own — repoint it at another channel, change which messages match, or pause and resume it with `enabled`. Only the supplied fields change. Resuming a paused trigger requires the Slack connection it runs off to still be available on the agent; changing the channel resets the trigger's seen-message state.
enabledchannel_idis_privatematch_ruletrigger_idrequiredchannel_nameList Slack Workspaces Bound To An Agent
List the Slack workspaces bound to an agent build that you can create channel triggers for. Creating a Slack channel trigger for any other workspace is rejected, so start here to pick a valid `slack_team_id` and `integration_instance_id`.
agent_idrequiredbuild_idrequiredDelete Slack Channel Trigger
Permanently delete a Slack channel trigger you own. The agent stops starting Runs for that channel. To keep the trigger but stop it firing, update it with `enabled: false` instead.
trigger_idrequiredAccept Revision Generation
Accept the reviewed generated configuration and complete the builder run. The saved draft is not activated.
build_idrequiredbuilder_run_idrequiredexpected_started_atrequiredGenerate Revision
Generate agent instructions or code into a saved draft. Poll the returned builder run, answer questions if requested, then accept or decline the reviewed checkpoint. This never activates the revision.
promptrequiredrun_idbuild_idrequiredprocess_idconversationdraft_file_idinsight_indexdraft_file_idsprevious_build_idselected_automation_revision_idPromote Revision
Promote a draft or historic revision to the live version. The live revision is the one used by triggers and new runs. Fails if the revision is already live, or if a draft revision still has an active builder run.
build_idrequiredrevision_namerevision_descriptionResume Builder Run
Resume a builder run that is waiting for user input
answersrequiredbuilder_run_idrequiredCancel Builder Run
Cancel a running builder run and pause its sandbox
statusrequiredbuilder_run_idrequiredCreate Revision
Create a new revision for an existing agent.
namerequiredconfigagent_idrequiredhandover_tosource_build_idhandover_optionshandover_target_idsselected_automation_revision_idDecline Revision Generation
Discard generated changes by restoring checkpoint_config and completing the builder run. The saved draft is not activated.
build_idrequiredbuilder_run_idrequiredexpected_started_atrequiredGet Revision
Get a revision by ID.
agent_idrequiredbuild_idrequiredGet Builder Run
Get the status of a builder run
builder_run_idrequiredGet Revision Body
Read one section of a revision's config as plain text, in character ranges: the AOP (`input`) or the code-step program (`source`). Use it instead of getRevision when the text is large; listAgents with `config=light` reports each agent's `input_chars` and `source_chars`.
lengthoffsetsectionrequiredagent_idrequiredbuild_idrequiredList Agent Revisions
List revisions for an agent. Pass `config=light` to leave each revision's config out of the page and get its sizes instead; read the AOP with getRevisionBody.
limitconfigoffsetstatusagent_idrequiredUpdate Revision
Update a revision's configuration, name, description, or handover targets. Returns the updated revision.
configbuild_idrequiredhandoverTorevision_namehandoverOptionshandoverTargetIdsrevision_descriptionselected_automation_revision_idDuplicate Agent
Duplicate an existing agent into a new agent named "Copy of <name>", carrying over its configuration. Use the include_* flags in the (optional) body to control what is copied; all default on except memory. Requires the Lead Builder team role or above.
agent_idrequiredinclude_aopinclude_queueinclude_memoryinclude_pluginsinclude_connectionsinclude_skills_filesinclude_logins_secretsGet Agent
Get an agent by ID. The response carries no revision config: use listAgentRevisions and getRevision for a revision, and getRevisionBody to read a large AOP in character ranges.
agent_idrequiredUpdate Agent
Update an agent's display name or delivery settings.
namepinnedagent_idrequiredthread_idslack_enabledagentic_memory_enabledmicrosoft_teams_enabledcomputer_use_vpn_config_idcomputer_use_sandbox_template_idDelete Agent
Delete an agent and cascade-clean its schedules, case triggers, builder runs, and handover targets. Any active jobs are interrupted and their sandboxes paused.
agent_idrequiredMove Agent
Move an agent (and its connected workspace) to a different team. Pass dry_run=true to preview the closure without applying changes.
dry_runagent_idrequiredtarget_team_idrequiredbypass_standalone_gateGet Automation
Get a single automation with its agent and queue counts, the tab arrangement its detail view navigates by, and `links` to each tab it has right now.
automation_idrequiredUpdate Automation
Update an automation, e.g. rename it. Only the fields present in the body are changed.
nameautomation_idrequiredGet Automation Tabs
Get the automation detail view's tab arrangement, plus metadata for the Pulse dashboards pinned into it. Pinned dashboards are filtered to the ones the calling identity may see.
automation_idrequiredUpdate Automation Tabs
Replace the automation detail view's tab arrangement. Pinning, unpinning, reordering and hiding a tab are all expressed as a different arrangement.
orderrequiredhiddenrequiredautomation_idrequiredDelete Automation
Soft-delete an automation. Its member agents and queues stop dispatching and disappear from listings, but their underlying rows and run history are preserved (not erased) so the automation can be restored.
automation_idrequiredDuplicate Automation
Duplicate an automation into a new one named "Copy of <name>", copying what it runs today: its live agents and builds, its queues (empty), the routing and handovers between them, and each agent's Memory when the team holds Memory and the agent has it on. The caller's own triggers and schedules are copied switched off, so the copy starts no run until they turn them on; other members' triggers and schedules are not copied. An automation built by hand also gets its Policy: sections, questions, answers, and which agents read them. Cases and run history are not copied. A Module demo, and a Module automation with Policy questions, can't be duplicated.
automation_idrequiredGet Automation Current
Get what the automation is set up to do right now: its member agents with the builds that are live, its queues' routing, and the triggers and schedules firing for it. The revision-less counterpart of the revision detail — an automation without revisions is read here. `links` holds a link to each tab the automation has right now.
automation_idrequiredGet Automation Current Flow
Get the automation's flow graph as it stands right now: the agents and queues it currently wires together, plus the producer, consumer, and handover edges between them. The revision-less counterpart of the revision flow.
automation_idrequiredGet Automation Readiness
What still has to be set up before an automation can run on real work. Call this first for a readiness question ("what do I still need to set up", "is it ready to run", "why isn't it running") and before checking an automation's Connections, Logins or Secrets one by one. Each of `items` is `{ key, label, status: ok | missing | broken, detail, link, link_tab }` and covers one of: required Policy questions still open, Connections with no working account pinned or that need reconnecting, Logins and Secrets (present or missing, never their values), Queue slots with no Queue linked, Queues with routing off, no Agent or an Agent with no live version, what starts it (a Trigger, a Schedule, or Cases added to a routed Queue), the live revision and a pending draft, and whether it is still a demo. While a Module is being set up and its proposal has not been approved, `items` covers only its setup: required Policy questions, the current process map (`setup:process_map`) and the automation proposal (`setup:automation_proposal`), or, when its setup progress is unavailable, one `setup` item linked to the setup's Get started page, whose approval builds the automation; Connections, Queues and what starts it are checked again once the approved proposal is being built. Lead with what is `missing` or `broken`, each with its own `link` (named by `link_tab`); never build a link. Quote counts from `summary`, including `connections_to_fix`, rather than counting items. `ready` is null when the caller can't read the Policy; `note` then says what to tell the user. A Connection only the caller can see counts for the caller. When `links_note` is present, give no link to the automation at all. Each `link` is a path in the Duvo web app; give the user the full URL beside it (`url`, and `urls` for `links`).
automation_idrequiredRead Automation Dashboard Data
The figures a Module automation's Pulse dashboards show, computed server-side the same way the dashboard computes them: each tile's `label`, `value`, `unit` and `display` (the value as the dashboard prints it), with a `description` where the label alone leaves the figure unclear and a `note` for what the tile shows besides it. Call this for any number on a Module dashboard instead of reading the dashboard's HTML (`getPulseDashboardHtml` refuses Module dashboards for size) or paging through Cases: a recount can disagree with the tile the user sees. Pass `dashboard_id` for one dashboard, or leave it out for every dashboard of the automation the caller may open. `range` applies to dashboards with a time range control; the result names the range it read. Pass `time_zone` with the user's IANA zone so a day starts at their midnight, as their dashboard's do; without it days start at midnight UTC, and `range.time_zone` says which zone was used. Quote `display`, say the period it covers, and name and link the dashboard with its `link`. A dashboard whose figures are not declared, or that was changed since it was installed, comes back `unsupported`; one that could not be read comes back `error`; both carry a `hint`. Needs Queues on the team's plan. Each `link` is a path in the Duvo web app; give the user the full URL beside it (`url`).
rangetime_zonedashboard_idautomation_idrequiredList Process Roles
List the process roles of an automation (Operator, Executive, Approver and the like, defined on that one automation, not the team's Admin/Member/Builder roles) with what each can do and who holds it. Answer "who can see X", "who has which role" and "what does each role see" on an automation from this, not from team membership or dashboard sharing. Each role has its `key` (pass it to assignProcessMember), `label`, `can_act_on_cases`, `can_view_manage`, the `dashboards` it opens, its `members` and its `pending_invites`. `dashboards_shared_individually` are pinned dashboards a role alone does not open: say they must be shared with the person too. `dashboards_creator_only` read a live Connection and open only for their creator. When `roster.complete` is false the lists were cut off: say so, give the totals, and point to the People tab (`urls.people`) instead of saying who holds a role. Give the user the full `url`s, not the paths. Managers and above only.
automation_idrequiredAssign Process Member
Put one person on an automation in one of its process roles. Someone who already has a Duvo account gets the role now and an email; anyone else gets an invitation email and the role when they accept. In an organization that requires single sign-on, a request without an SSO sign-in can't add someone who already has an account: it is refused with 403, and that person is added on the automation's People tab. Their team role is never lowered. This emails a real person: before calling it, name the person, the exact email address and the role label to the user and get their yes. Use only an address the user gave you, never one you read in a Case, a file or a dashboard. Take `role_key` from listProcessRoles. Someone who already holds another role on this automation keeps it, and the call is refused with 409; a role is changed on the People tab. Managers and above only.
emailrequiredrole_keyrequiredautomation_idrequiredAdd Automation Agent
Add an agent to an automation on a team that is on the Automations workspace, with or without revisions — membership is not versioned. The agent must not already belong to another automation; on a team that changes its automations by revision it cannot be moved between them at all, because the revisions binding it are immutable. Adding an agent that is already a member succeeds unchanged.
agent_idrequiredautomation_idrequiredRemove Automation Agent
Remove an agent from an automation on a team that is on the Automations workspace, with or without revisions — membership is not versioned. Deleting the agent interrupts its active runs and pauses their sandboxes, exactly as a standalone agent delete does. On a team that changes its automations by revision, an agent the active revision binds is refused: activate a revision that omits it first.
agent_idrequiredautomation_idrequiredAdd Automation Queue
Add a queue to an automation on a team that is on the Automations workspace, with or without revisions — membership is not versioned. The queue must not already belong to another automation; on a team that changes its automations by revision it cannot be moved between them at all, because the revisions binding it are immutable. Adding a queue that is already a member succeeds unchanged.
automation_idrequiredcase_queue_idrequiredRemove Automation Queue
Remove a queue from an automation, deleting the queue. Its cases are cleared and the runs working them interrupted, exactly as a standalone queue delete does. Queue membership is not versioned, so this behaves the same whether or not the team changes its automations by revision.
automation_idrequiredcase_queue_idrequiredList Config Fields
Read an automation's module config fields (its Policy), grouped by section in the automation's section order, with each field's current value, default, and fill provenance.
automation_idrequiredinclude_hiddenRead Automation Policy
Read an automation's whole Policy before answering anything about it: every question by section, with its `id` (the field id updateConfigField takes), key, type, answer and who gave it; `counts.questions` as the Policy screen's header counts them (`required_open` is what still blocks a run) apart from the module's pre-filled `module_defaults`; answers proposed by interviews and waiting for review; accepted and pending process-context notes; the interviews assigned; and `pending_apply`, the structural answers and notes not yet written into an Agent. `running` says whether the automation runs on live work: there a changed answer reaches its Agents from their next run, so name the question, its current answer and the new one, and change it only after the user says yes. A question whose `bindings` include `structural` changes how the Agents run; propose the matching Agent change too. Never invent an answer for a question shown as open. Give the user the full URLs in `urls`.
automation_idrequiredinclude_hiddenAssign Policy Interview
Assign a Policy interview: a Clarity voice interview covering the automation's open Policy questions, whose answers are written back onto them. Pass `invited_email` to email it to someone, and `context` to say who they are; leave `invited_email` out to create an unassigned interview slot. This emails a real person: name them, give the exact address and say what the interview covers, and call this only after the user says yes. Use only an address the user gave you. Administrators and above only.
contextautomation_idrequiredinvited_emailUpdate Config Field
Set or clear a config field's value. `value: null` removes the answer and does not restore the module default, so a Run that reads the field is refused until it is answered again. To use the default, send `default_value` as `value`. On a running automation (`running` in readAutomationPolicy) the change reaches its Agents from their next run: name the question, its current answer and the new one, change it only after the user says yes, and pass the current answer you showed, not the new one, as `expected_value` so a change someone made in between is not overwritten. A compound question takes every part in one write. When the field's `bindings` include `structural`, the module's Agents also need a matching change; propose it.
valuerequiredfieldIdrequiredautomationIdrequiredexpected_valueAdd Config Field
Add a Policy question to this automation. Its key is `custom_` plus the label in snake_case, with `_2`, `_3` and so on appended when the key is taken, and it is placed at the end of its section. A module template reinstall never changes a field added here.
keytyperequiredlabelrequiredrolescolumnsexampleoptionssectionbindingsguidancequestionrequiredfill_mode+1 moreUpdate Config Field Definition
Edit a Policy question: its label, question, guidance, example answer, section, the roles that answer it, the options of a select or multiSelect field, and the columns of an unanswered table field a person added. A reworded question gets a new version, and a new section moves the field to that section's end. The type of a field added through the API can change while it has no answer; a field from the module template keeps its type. The answer is never changed, and a module template reinstall keeps the edit.
keytypelabelrolescolumnsexampleoptionssectionfield_idrequiredguidancequestionautomation_idrequiredHide Config Field
Hide a Policy question from the Policy screen, interviews and every agent's context. Nothing is deleted: the answer and its history stay, and the restore operation shows it again. Returns the agents whose live version still reads the field; hiding is never refused because of them. A module template reinstall keeps the field hidden.
field_idrequiredautomation_idrequiredRestore Config Field
Show a hidden Policy question again, with the answer it had.
field_idrequiredautomation_idrequiredList Config Sections
List the sections of an automation's Policy in display order, empty ones included, each with its key, name, origin and question count. No offset/limit params: this is the automation's whole set of sections.
automation_idrequiredAdd Config Section
Add an empty section to this automation's Policy, last or right after after_key. Its key is the name in lowercase words joined by hyphens, with `-2`, `-3` and so on appended when the key is taken. A name another section has, ignoring case, is refused with a 409. A module template reinstall never changes a section added here.
namerequiredafter_keyautomation_idrequiredRename Config Section
Rename a section of this automation's Policy. Its key and its questions stay as they are, and every reader shows the new name. A name another section has, ignoring case, is refused with a 409; the current name changes nothing. A module template reinstall keeps the rename.
namerequiredsection_keyrequiredautomation_idrequiredReorder Config Sections
Replace the display order of this automation's Policy sections. keys must list every section key of the automation exactly once, else a 400 names what is missing, unknown or repeated. Returns every section in its new order. A module template reinstall keeps the order of the sections moved here.
keysrequiredautomation_idrequiredRemove Config Section
Remove a section a person added to this automation's Policy, once it holds no question, hidden ones included. A section with questions, or one from the module template, is refused with a 409. Returns the removed section.
section_keyrequiredautomation_idrequiredList Revision Integrations
List integrations attached to an agent revision.
agent_idrequiredbuild_idrequiredAttach Revision Integrations
Attach one or more integrations to an agent revision. To pin specific connections after attachment, use pinRevisionIntegrationConnection. IMPORTANT for the case-queue-producer and case-queue-consumer integrations: attaching the integration alone is NOT enough — the slot points at no queue and will fail at runtime until you link at least one queue with replaceRevisionIntegrationQueues. After wiring up, call getRevisionCaseQueueSetup to confirm every case-queue slot has linked_queue_count > 0 before starting work.
agent_idrequiredbuild_idrequiredintegration_idsrequiredselected_automation_revision_idRemove Revision Integration
Remove an integration from an agent revision. Removes the slot for everyone on the revision, including all per-user connection pins. Requires edit permission on the agent.
agent_idrequiredbuild_idrequiredintegration_idrequiredselected_automation_revision_idList Revision Integration Connections
List the connections you have pinned to this build's integration slot. Multi-pin is supported: you can pin multiple connections to the same slot.
agent_idrequiredbuild_idrequiredintegration_idrequiredPin Revision Integration Connection
Pin one of your connections (from GET /v2/teams/:team_id/connections) to this build's integration slot. Multi-pin is supported: a single user can pin multiple connections to the same slot.
agent_idrequiredbuild_idrequiredconnection_idrequiredintegration_idrequiredUnpin Revision Integration Connection
Unpin one of your connections from this build's integration slot. The connection itself is not deleted; only the binding to this slot is removed.
agent_idrequiredbuild_idrequiredconnection_idrequiredintegration_idrequiredGet Revision Case Queue Setup
Check that this build's case-queue integration slots are wired up correctly. Returns, per case-queue-producer/consumer slot, how many queues are linked, plus whether any queue is available to bind (scoped to the agent's automation on a migrated team, team-wide otherwise). A slot with linked_queue_count of 0 is attached but points at no queue and will fail at runtime — link a queue with replaceRevisionIntegrationQueues before starting work.
agent_idrequiredbuild_idrequiredList Revision Integration Queues
List the queues linked to this build's case-queue integration slot. Only meaningful for case-queue-producer and case-queue-consumer integrations.
agent_idrequiredbuild_idrequiredintegration_idrequiredReplace Revision Integration Queues
Replace the set of queues linked to this build's case-queue integration slot. Send the full desired queue list — any queues not in the list will be unlinked. Requires edit permission on the agent. After linking, call getRevisionCaseQueueSetup to confirm the slot now reports linked_queue_count > 0.
agent_idrequiredbuild_idrequiredqueue_idsrequiredintegration_idrequiredselected_automation_revision_idList Agent Suggestions
List an Agent's suggestions. status=pending is the inbox; status=history is consumed/dismissed/auto-cleared. Reads lazily auto-clear stale pending items.
limitoffsetstatusagent_idrequiredGet Agent Suggestion
Fetch a single suggestion. Poll this after a 202 from consume: an AOP apply in flight reports payload.apply.state (running/failed); once consumed, applied_revision_id carries the draft revision the change was staged onto.
idrequiredConsume Agent Suggestion
Apply a suggestion: stage its change into the Agent's draft revision, then auto-clear any pending suggestions it makes moot.
idrequiredrevision_idcreate_new_draftselected_automation_revision_idReject Agent Suggestion
Dismiss a pending suggestion.
idrequiredList System Skills
List all system skills (skills available to all teams).
Takes no parameters.
Delete Skill
Delete a skill for the current team.
skill_idrequiredDownload Skill
Download a custom skill as a ZIP archive. Only custom (team-owned) skills can be downloaded.
skill_idrequiredList Skill Files
List all files in a skill.
skill_idrequiredGet Skill File Content
Get the content of a file in a skill.
pathrequiredskill_idrequiredUpdate Skill File
Update the content of a file in a skill, overwriting the active revision in place — the previous content is not recoverable. Prefer the non-destructive flow when you can: createSkillRevision to open a draft, updateSkillRevisionFile to edit it, promoteSkillRevision to activate it. Only team skills can be edited.
pathrequiredcontentrequiredskill_idrequiredUpdate Skill Ask Duvo
Mark a team skill as available in Ask Duvo, or take it back off. Every NEW Ask Duvo chat in the team starts with the marked skills on disk. A chat that is already open keeps the set it started with until its sandbox is replaced, and picks up the current set from then on.
skill_idrequireduse_in_ask_duvorequiredList Skill Assignments
List the agents in the current team whose live build references the given skill. Used to warn users that editing a skill will affect every agent that uses it.
skill_idrequiredList Skill Revisions
List a skill's version history. Each revision is a snapshot of the skill's files; at most one is active (live) at a time, plus at most one open draft.
limitoffsetskill_idrequiredCreate Skill Revision
Open a draft revision of a skill, copying its files from the active revision (or from `source_revision_id`). Edit the draft with updateSkillRevisionFile and deleteSkillRevisionFile, then activate it with promoteSkillRevision — the previously active revision stays intact and can be re-activated later. A skill has at most one open draft: if one already exists this returns it with `created: false`.
skill_idrequiredsource_revision_idPromote Skill Revision
Make a skill revision the active (live) one. The previously active revision becomes historic and can be re-activated later. Idempotent: promoting the already-active revision succeeds rather than erroring, and still applies any revision_name / revision_description supplied in the body.
revision_nameskill_revision_idrequiredrevision_descriptionList Skill Revision Files
List the files in a skill revision, one page at a time. When `has_more` is true, pass `next_cursor` back as `cursor` to fetch the next page.
limitcursorskill_revision_idrequiredGet Skill Revision File Content
Get the content of a text file in a skill revision.
pathrequiredskill_revision_idrequiredUpdate Skill Revision File
Write a text file into a skill revision. Writing into a draft leaves the active revision untouched until the draft is promoted; writing into the active revision changes what the skill runs immediately. Historic revisions are read-only: create a draft from one to edit it.
pathrequiredcontentrequiredskill_revision_idrequiredDelete Skill Revision File
Delete a file from a skill revision. Deleting from a draft leaves the active revision untouched until the draft is promoted; deleting from the active revision changes what the skill runs immediately. SKILL.md can't be deleted. Historic revisions are read-only: create a draft from one to edit it.
pathrequiredskill_revision_idrequiredUpdate Skill Revision
Rename a skill revision or change its description. Works for drafts, the active revision, and historic revisions.
revision_nameskill_revision_idrequiredrevision_descriptionDelete Skill Revision
Delete a draft or historic skill revision and its files. The active revision can't be deleted — activate another revision first.
skill_revision_idrequiredGet Profile
Get the profile of the authenticated user (the owner of the API key).
Takes no parameters.
Get Legacy Clarity Process
Get a legacy v1 Clarity process with process metadata, generated analysis, automation guidance, generation progress, and captures. Use this for rows from listClarityProcesses where version=1; v2 rows should use getClarityProcess and snapshot detail tools.
idrequiredUpdate Clarity Process
Update a Clarity process name, guidance, interview independence, visibility, or completion status. Team Builders can edit names, guidance, and interview independence, only the creator or a team manager can change visibility, and completing or reopening a process for review requires a Lead Builder role.
idrequirednamestatusvisibilitymapLanguagecustomPromptindependentInterviewsList Clarity Process Members
List users with accepted access to a clarity process, the people invited who have not accepted yet, and anyone else who has recorded a capture on it
idrequiredcontributorsAfterRemove Clarity Process Member
Remove accepted access to a clarity process
idrequiredinvitationIdrequiredDelete Clarity Process
Delete a Clarity process. The creator or a team admin can delete it unless capture analysis is still in progress, or a Module runs it — a Module's process is part of the Module, so the Module has to be removed first. An automation built from the process keeps running, with its setup answers and people, but is no longer linked to it.
idrequiredDuplicate Clarity Process
Duplicate a Clarity process with its analysis, captures, message history, and, for v2 processes, its live current map and automation proposal. Requires a team manager role.
idrequiredCreate Clarity Video Upload Url
Create a signed URL for uploading a video file directly to GCS
idrequiredfileNamerequiredcontentTyperequiredextraCaptureRequestIdComplete Clarity Video Upload
Complete a video capture after uploading to GCS via signed URL
idrequiredfileNamerequiredcaptureIdrequiredCreate Clarity Document Upload Url
Create a signed URL for uploading a PDF, Word (.docx), TXT, Markdown, BPMN, XLSX, or CSV document directly to GCS
idrequiredfileNamerequiredcontentTyperequiredextraCaptureRequestIdComplete Clarity Document Upload
Complete a document capture after uploading to GCS via signed URL
idrequiredfileNamerequiredcaptureIdrequiredCreate Clarity Image Upload Url
Create a signed URL for uploading a PNG, JPEG, WebP, or SVG image directly to GCS
idrequiredfileNamerequiredcontentTyperequiredextraCaptureRequestIdComplete Clarity Image Upload
Complete an image capture after uploading it to GCS via a signed URL
idrequiredfileNamerequiredcaptureIdrequiredInvite Clarity Meeting Notetaker
Invite the in-meeting notetaker bot (Recall.ai) to a live meeting; the recording lands as a 'meeting' capture on the process
idrequiredjoinAtmeetingUrlrequiredextraCaptureRequestIdDelete Clarity Capture
Delete a capture from a clarity process
idrequiredcaptureIdrequiredCreate Clarity Guidance
Create a new automation guidance message for a clarity process
idrequiredcontentrequiredUpdate Clarity Guidance
Update the automation guidance message for a clarity process
idrequiredcontentrequiredGet Clarity Process Sharing
Get the sharing status for a clarity process
idrequiredUpdate Clarity Process Sharing
Enable or disable sharing for a clarity process
idrequiredenabledrequiredproposalShareEnabledSend Clarity Interview Invites
Invite people to record an interview about this Clarity process, and email each of them. To invite people from the organization chart or landscape, first use the Clarity hierarchy people tools to find their names and email addresses, then pass them as invitees. Set includeProcessPeople to true to also invite everyone already listed as a person on this process. At most 25 unique recipients per call. Each invitee gets a Clarity process invitation, exactly as the Invite dialog creates one; someone already invited is sent their invitation again rather than a second one. Where the team has account-free interview links on, people without a Duvo account get a link that opens the interview directly and expires after 30 days; everyone else gets the normal invitation that asks them to sign in. Revoke a pending invitation with deleteTeamInvite.
idrequiredmessageinviteesincludeProcessPeopleList Clarity Interview Invites
List a Clarity process's pending and accepted invitations, newest first, with whether each was accepted, whether it was sent an account-free interview link, and whether the invitee has opened that link or submitted an interview. Paginate with limit and offset; total is the number of invitations. Revoke a pending invitation by passing its id to deleteTeamInvite.
idrequiredlimitoffsetGet Clarity Process Invite Link
Get the active interview invite link for a process.
idrequiredDelete Clarity Process Invite Link
Delete the active interview invite link for a process.
idrequiredGet Clarity Process Join Info
Get information about a clarity interview invite link (public).
tokenrequiredAccept Clarity Process Join
Accept a clarity interview invite link and gain process access.
tokenrequiredUpdate Clarity Landscape Node
Rename a process landscape node or update its owner label (team manager or above for team processes; organization admin for areas)
nameorgIdrequirednodeIdrequiredownerLabelAccept Clarity Landscape Node
Accept a proposed area folder into the active process landscape, so it stops being a proposal and becomes part of the real structure (organization admin+). Only area folders can be accepted; a proposed process becomes real through assignClarityLandscapeNodeTeam instead. Re-accepting an already-active area is a no-op.
orgIdrequirednodeIdrequiredDecline Clarity Landscape Node
Reject a proposed process landscape node while it is still a proposal, removing it and any proposed descendants. Real processes nested underneath survive and move back to Unsorted. Only proposals can be declined — an accepted node is removed with deleteClarityLandscapeNode.
orgIdrequirednodeIdrequiredDelete Clarity Landscape Node
Soft-delete a tree node and its descendants. Organization admins may delete any subtree; team managers may delete a childless process node owned by their team. The targeted node's linked clarity process and captures are deleted, while nested processes detach to the Unsorted bag.
orgIdrequirednodeIdrequiredSet Clarity Landscape Node Placement
Move a process landscape node (team builder or above for team processes; team manager or above for team proposals; organization admin for areas)
orgIdrequirednodeIdrequiredparentIdrequiredReorder Clarity Landscape Areas
Reorder a sibling group of the organization's process landscape area folders left-to-right — the top-level areas by default, or the folder children of parentId (organization admin+). This changes display order only; use setClarityLandscapeNodePlacement to move a node to a different parent.
orgIdrequiredparentIdorderedAreaIdsrequiredAssign Clarity Landscape Node Team
Set the owning team of a process in the process landscape (organization admin+). On a proposed process this accepts the proposal and creates the real process for that team; on an existing process it moves the process, its captures and its brief to another team.
orgIdrequiredintentnodeIdrequiredteamIdrequiredCreate Clarity Process Node
File an existing Clarity process into an area of the process landscape (team builder or organization admin+). Use this for a process that already exists but sits in Unsorted; use proposeClarityLandscapeProcess to create a brand-new one.
orgIdrequiredparentIdrequiredprocessIdrequiredPropose Clarity Landscape Process
Create a manual process in the organization's Process Landscape, either as an unassigned proposal or atomically assigned to an eligible team.
namerequiredorgIdrequiredteamIdparentIddescriptionmaterializationModeBatch Add Clarity Landscape Node People
Add one or more people to multiple Process Landscape nodes in a bounded batch. Email entries can create invitations; each node-person outcome reports success, conflict, or delivery failure.
orgIdrequiredpeoplerequirednodeIdsrequiredList Clarity Landscape Node People
List the people involved in the process behind one process landscape node. To read the people across the whole landscape in one request, use getClarityHierarchyPeople instead.
orgIdrequirednodeIdrequiredteamIdAdd Clarity Landscape Node Person
Add a person involved in the process behind a process landscape node. Name only records a placeholder; supplying an email also gives that person access to the process and emails them an invitation, so only pass an email the user asked you to invite.
nameroleemailorgIdrequirednodeIdrequiredteamIdteamRoleUpdate Clarity Landscape Node Person
Change the role a person plays in the process behind a process landscape node (for example "Approver"). Send role: null to clear it.
roleorgIdrequirednodeIdrequiredteamIdpersonIdrequiredRemove Clarity Landscape Node Person
Remove a person from the process behind a process landscape node, and revoke the process access they were granted when they were added.
orgIdrequirednodeIdrequiredteamIdpersonIdrequiredpendingOnlyAccept Clarity Team Assignment Suggestion
Accept a pending Process Landscape team-assignment suggestion and durably assign the suggested team (manager+).
nodeIdrequiredsuggestionIdrequiredDismiss Clarity Team Assignment Suggestion
Dismiss a pending Process Landscape team-assignment suggestion without changing the node's owner (manager+).
nodeIdrequiredsuggestionIdrequiredList Clarity Landscape Node Interviews
List Clarity interviews linked to a process folder
limitorgIdrequirednodeIdrequiredoffsetDelete Clarity Landscape Node Interview
Delete an organization-scoped folder interview
orgIdrequirednodeIdrequiredinterviewIdrequiredGet Clarity Process
Get the v2 read model for a clarity process: the process row (with operational fields like generation_error, generation_progress, generation_started_at, generation_last_activity_at, custom_prompt), its captures, and the lightweight version arrays for both snapshot tabs. The full payload of any specific snapshot is fetched lazily via the unified per-snapshot detail endpoint (`GET .../snapshots/:kind/:id`); this read model deliberately doesn't carry it so the response stays small.
capturesprocess_idrequiredGet Clarity Capture
Get a single Clarity v2 capture including full transcript and video transcript. Use this when the process was loaded with captures=lite, or when only one capture's transcript is needed.
capture_idrequiredprocess_idrequiredPostprocess Clarity Snapshot
Re-run postprocessing agents on an existing v2 clarity snapshot. Targets either the current-process snapshot or the automation proposal snapshot, identified by id in the body. Flips the process status to `generating` and returns 202 immediately; agents run asynchronously and flip the status back to `review` once they settle.
typerequiredprocess_idrequiredcurrent_process_idtransformation_proposal_idList Clarity Step Frames
Return one representative screenshare frame for each current-process step. Explicit frame evidence wins. Otherwise, a timestamped screenshare transcript source selects the closest persisted frame at or after that timestamp, with the closest earlier frame as fallback. Pass `window` (1-5) to also receive that many neighbouring frames on each side as candidates, for recovering when the selected frame does not show the step. Pass `size=thumb` for 768px copies that are cheaper to download and inspect. Signed URLs are short-lived and can be null when signing is unavailable.
sizewindowstep_idsprocess_idrequiredsnapshot_idrequiredBuild Clarity Automation
Hand an automation proposal for a v2 clarity process off to the workflow-builder pipeline. Builds from `transformation_proposal_id` when supplied, otherwise from the process's live proposal. The proposal id is the durable idempotency key, so retries return the same run and a different proposal starts a new run. Returns 202 while the LLM run completes asynchronously, or 409 when the resolved proposal is still being written.
process_idrequiredtransformation_proposal_idList Clarity Extra Capture Requests
List active extra-capture requests for a given automation proposal of a Clarity v2 process. The caller is expected to know the proposal id from the V2 read model and skip the call when no proposal exists yet.
limitoffsetprocess_idrequiredtransformation_proposal_idrequiredAssign Clarity Extra Capture Request
Assign (or unassign, with `user_id: null`) a team member to fulfil an extra-capture request. Restricted to Lead Builders and above.
user_idrequiredprocess_idrequiredrequest_idrequiredtransformation_proposal_idrequiredCreate Clarity Invite Link
Create or regenerate a process-scoped Clarity interview invite link. Only the process creator or team managers can create invite links; creating a new link invalidates any prior active link for the process.
process_idrequiredCreate Clarity Artifact Import Upload Url
Create a signed upload URL for importing a Miro export into a Clarity v2 process. Supports SVG, XML, PNG, and JPEG exports. The caller must upload the file to the returned URL, then complete the import.
file_namerequiredprocess_idrequiredcontent_typerequiredextra_capture_request_idComplete Clarity Artifact Import
Complete a Miro artifact import after uploading to the signed URL. The uploaded bytes are validated before the import becomes a usable Clarity capture.
file_namerequiredcapture_idrequiredprocess_idrequiredcontent_typerequiredList Clarity Artifact Chat Conversations
List the current user's recent non-deleted artifact-chat conversations for a Clarity v2 process and snapshot kind.
process_idrequiredsnapshot_kindrequiredGet Clarity Artifact Chat Messages
Load the latest artifact-chat messages for one active conversation, returned oldest-first.
process_idrequiredconversation_idrequired75% of the applicable checks met
How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.
Declare a GitHub repository with a README, or serve resource_documentation in the OAuth protected-resource metadata.
Declare a license in the repository or the registry entry.