# Complete reference (/cli/reference) Every command on one page, generated from the CLI itself. Start at the [overview](/cli/commands) to browse; this page is for searching and for tools. Append `.mdx` to any page for its raw Markdown — [`/cli/reference.mdx`](/cli/reference.mdx) is this page as plain text. The docs are also published as [`/llms.txt`](/llms.txt) and [`/llms-full.txt`](/llms-full.txt). ## Global options [#global-options] These apply to every command, and may be written before or after it. | Option | Description | | ---------------------- | --------------------------------------------------------------------------------- | | `-P, --profile ` | Profile to use (env: AGENT\_SERVE\_PROFILE). | | `--endpoint ` | Deployment to talk to (env: AGENT\_SERVE\_BASE\_URL). | | `-w, --workspace ` | Workspace to target (env: AGENT\_SERVE\_WORKSPACE). | | `--output ` | Output format for this command. Accepted values: `table`, `json`, `yaml`, `text`. | ## agentserve login [#agentserve-login] Log in through the browser and store the login for the profile ```bash agentserve login [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--method ` | No | Credential to obtain: oauth requires OAuth support; api-key creates a permanent key through pairing (auto-selects when omitted). Accepted values: `oauth`, `api-key`. | | `--no-browser` | No | Print the approval URL without opening it (either login method). | | `--read-only` | No | Ask only for permission to read, never to change anything. | | `--callback-port ` | No | Pin the local port the browser returns to. | | `-y, --yes` | No | Overwrite an existing API-key profile without prompting. | ## agentserve logout [#agentserve-logout] Sign out and remove the profile's stored login ```bash agentserve logout [options] ``` **Options** | Option | Required | Description | | ------- | -------- | ---------------------------------------------------- | | `--all` | No | Remove the profile entirely, including its settings. | ## agentserve whoami [#agentserve-whoami] Show the resolved profile, where each setting came from, and whether it works ```bash agentserve whoami [options] ``` **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------------------------- | | `--no-verify` | No | Skip the API check and only print the resolved settings. | ## agentserve configure [#agentserve-configure] Switch a profile's default workspace, or set its endpoint or output format ```bash agentserve configure [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------ | | `--set-endpoint ` | No | Agent Serve deployment to talk to. | | `--set-workspace ` | No | Default workspace for workspace-scoped commands. | | `--set-output ` | No | Default output format (table \| json \| yaml \| text). | | `--unset ` | No | Remove settings (endpoint, workspace, output). | ## agentserve update [#agentserve-update] Update this global CLI installation to the newest release on its channel ```bash agentserve update [options] ``` **Options** | Option | Required | Description | | ----------------------------- | -------- | ---------------------------------------------------------------------------------------- | | `--package-manager ` | No | Package manager that installed this copy. Accepted values: `npm`, `pnpm`, `bun`, `yarn`. | ## agentserve chat [#agentserve-chat] Ask Agent Serve and print the reply ```bash agentserve chat [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------- | | `message` | Yes | What to ask Agent Serve | **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------- | | `-c, --conversation ` | No | Continue the conversation with this ID. | ## agentserve profiles [#agentserve-profiles] Also spelled `agentserve profile`. ### agentserve profiles list [#agentserve-profiles-list] List configured profiles ```bash agentserve profiles list ``` ### agentserve profiles add [#agentserve-profiles-add] Add a workspace profile that shares the active stored login ```bash agentserve profiles add [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------ | | `name` | Yes | Name for the new profile | **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------- | | `-w, --workspace ` | No | Existing workspace to use; omit for an interactive picker. | ## agentserve telemetry [#agentserve-telemetry] ### agentserve telemetry status [#agentserve-telemetry-status] Show whether usage reporting is on, and why not if it is off ```bash agentserve telemetry status ``` ### agentserve telemetry enable [#agentserve-telemetry-enable] Turn usage reporting on for this machine ```bash agentserve telemetry enable ``` ### agentserve telemetry disable [#agentserve-telemetry-disable] Turn usage reporting off for this machine ```bash agentserve telemetry disable ``` ## agentserve runner [#agentserve-runner] ### agentserve runner link [#agentserve-runner-link] Link this machine to a workspace with a one-time code ```bash agentserve runner link [options] ``` **Options** | Option | Required | Description | | --------------- | -------- | ----------------------------------------------------- | | `--name ` | No | name shown in Settings → Runners (default: hostname). | | `--force` | No | link again even if this machine is already linked. | ### agentserve runner run [#agentserve-runner-run] Take and run jobs until stopped ```bash agentserve runner run [options] ``` **Options** | Option | Required | Description | | ------------------- | -------- | ------------------------------------- | | `--concurrency ` | No | jobs to run at once. Defaults to `2`. | ### agentserve runner status [#agentserve-runner-status] Show whether this machine is linked and approved ```bash agentserve runner status ``` ### agentserve runner unlink [#agentserve-runner-unlink] Forget this machine’s runner token ```bash agentserve runner unlink ``` ## agentserve cli [#agentserve-cli] ### agentserve cli search [#agentserve-cli-search] Find the command for a task, described in plain words ```bash agentserve cli search ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------------------------- | | `query...` | Yes | What you want to do, e.g. "cancel a workflow run" | ## agentserve model [#agentserve-model] ### agentserve model pull [#agentserve-model-pull] Write the published model, or your draft, to agentserve.model.yaml (OAuth login or personal API key required) ```bash agentserve model pull [options] ``` **Options** | Option | Required | Description | | ------------------- | -------- | ----------------------------------------------------------------------- | | `--draft` | No | Pull your own draft instead of the published model. | | `-f, --file ` | No | File to write; - writes to stdout. Defaults to `agentserve.model.yaml`. | ### agentserve model diff [#agentserve-model-diff] Show what the model file would change in the published model or your draft (OAuth login or personal API key required) ```bash agentserve model diff [options] ``` **Options** | Option | Required | Description | | ------------------- | -------- | -------------------------------------------------------------------------------------- | | `-f, --file ` | No | Model file to compare; - reads stdin. Defaults to `agentserve.model.yaml`. | | `--against ` | No | Model to compare with. Accepted values: `published`, `draft`. Defaults to `published`. | ### agentserve model push [#agentserve-model-push] Write the model file into your draft (starting one if needed); never publishes (OAuth login or personal API key required) ```bash agentserve model push [options] ``` **Options** | Option | Required | Description | | ------------------- | -------- | ----------------------------------------------------------------------- | | `-f, --file ` | No | Model file to push; - reads stdin. Defaults to `agentserve.model.yaml`. | ## agentserve app [#agentserve-app] ### agentserve app init [#agentserve-app-init] Create a new app from a starter template ```bash agentserve app init [dir] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------------------- | | `dir` | No | Folder to create the app in | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `-t, --template ` | No | Starter template. Accepted values: `blank`, `sales-cockpit`, `field-visit-logger`, `deal-desk`, `support-triage`, `ops-exceptions`, `knowledge-assistant`. Defaults to `blank`. | | `--name ` | No | App name in the manifest; defaults to the folder name. | | `--title ` | No | App title people see; defaults to one made from the name. | | `--force` | No | Add the app to a folder that already has other files. | | `--list` | No | List the starter templates and exit. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app dev [#agentserve-app-dev] Build the app and run it locally in the same sandboxed frame the workspace uses, with your own access (OAuth login or personal API key required) ```bash agentserve app dev [dir] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ----------- | | `dir` | No | App folder | **Options** | Option | Required | Description | | --------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | | `-p, --port ` | No | Port for the local host page. Defaults to `5175`. | | `--page ` | No | Page to open first. | | `--launch ` | No | What launch.get answers, as a plugin command or action opens the page: \{"kind":"command","name":"brief","args":\{"file":"q3"}}. | | `--build-command ` | No | Command that builds the app (default: \ run build). | | `--no-build` | No | Do not build; serve the existing output and reload when it changes. | | `--no-open` | No | Do not open a browser. | ### agentserve app deploy [#agentserve-app-deploy] Build the app, pack it and upload it as a draft version (OAuth login or personal API key required) ```bash agentserve app deploy [dir] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ----------- | | `dir` | No | App folder | **Options** | Option | Required | Description | | --------------------------- | -------- | -------------------------------------------------------------------- | | `--build-command ` | No | Command that builds the app (default: \ run build). | | `--no-build` | No | Upload the existing build output without building. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app publish [#agentserve-app-publish] Publish a draft version so workspaces can install it (admin) (OAuth login or personal API key required) ```bash agentserve app publish [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | -------------------------------------------- | | `version` | Yes | Version to publish, such as 1.2.0, or its id | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--rollout` | No | Also move this workspace's install to the version. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app rollback [#agentserve-app-rollback] Move this workspace's install to an earlier published version (admin) (OAuth login or personal API key required) ```bash agentserve app rollback [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | -------------------------------------------------- | | `version` | Yes | Published version to run, such as 1.1.0, or its id | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app install [#agentserve-app-install] Install a published app in the workspace (admin); pick it with -w, --workspace (OAuth login or personal API key required) ```bash agentserve app install [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--to-version ` | No | Published version to install; defaults to the highest. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app logs [#agentserve-app-logs] Show the install's audit trail, oldest first; --follow keeps watching (OAuth login or personal API key required) ```bash agentserve app logs [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `-f, --follow` | No | Keep polling for new entries until Ctrl-C. | | `--interval ` | No | Seconds between polls with --follow. Defaults to `5`. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app usage [#agentserve-app-usage] Show this month's spend against the app's budget, by source (OAuth login or personal API key required) ```bash agentserve app usage [options] ``` **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app permissions [#agentserve-app-permissions] Show what the app may reach, installed and in the local manifest (OAuth login or personal API key required) ```bash agentserve app permissions [dir] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------ | | `dir` | No | App folder whose manifest to compare | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app secrets set [#agentserve-app-secrets-set] Set a secret; prompts without echo when --value is not given (OAuth login or personal API key required) ```bash agentserve app secrets set [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `name` | Yes | Secret name, such as API\_TOKEN | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------- | | `--value ` | No | Secret value. Inline values land in shell history; @path reads a file and @- stdin, verbatim. | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app secrets list [#agentserve-app-secrets-list] List secret names and when each was set (OAuth login or personal API key required) ```bash agentserve app secrets list [options] ``` **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--json` | No | Print machine-readable JSON (same as --output json). | ### agentserve app secrets delete [#agentserve-app-secrets-delete] Delete a secret (OAuth login or personal API key required) ```bash agentserve app secrets delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ----------- | | `name` | Yes | Secret name | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------------------------------------------- | | `--app ` | No | App to act on; defaults to the name in ./agentserve.app.yaml. | | `--json` | No | Print machine-readable JSON (same as --output json). | ## agentserve apps [#agentserve-apps] ### agentserve apps secrets delete [#agentserve-apps-secrets-delete] Delete App Secret (OAuth login or personal API key required) ```bash agentserve apps secrets delete [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | | `name` | Yes | Secret name. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve apps secrets list [#agentserve-apps-secrets-list] List App Secrets (OAuth login or personal API key required) ```bash agentserve apps secrets list ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | ### agentserve apps secrets update [#agentserve-apps-secrets-update] Set App Secret (OAuth login or personal API key required) ```bash agentserve apps secrets update [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | | `name` | Yes | Secret name. | **Options** | Option | Required | Description | | ----------------- | -------- | ---------------------------------------------- | | `--value ` | Yes | Write-only secret value. It is never returned. | ### agentserve apps get [#agentserve-apps-get] Get App (OAuth login or personal API key required) ```bash agentserve apps get ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------- | | `appId` | Yes | App identifier. | ### agentserve apps deployments get [#agentserve-apps-deployments-get] Get App Deployment (OAuth login or personal API key required) ```bash agentserve apps deployments get ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `appId` | Yes | App identifier. | | `deploymentId` | Yes | Deployment identifier. | ### agentserve apps deployments list [#agentserve-apps-deployments-list] List App Deployments (OAuth login or personal API key required) ```bash agentserve apps deployments list ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------- | | `appId` | Yes | App identifier. | ### agentserve apps deployments publish [#agentserve-apps-deployments-publish] Publish App Deployment (OAuth login or personal API key required) ```bash agentserve apps deployments publish ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `appId` | Yes | App identifier. | | `deploymentId` | Yes | Deployment identifier. | ### agentserve apps installs get [#agentserve-apps-installs-get] Get App Install (OAuth login or personal API key required) ```bash agentserve apps installs get ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | ### agentserve apps installs create [#agentserve-apps-installs-create] Install App (OAuth login or personal API key required) ```bash agentserve apps installs create [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------- | | `--app-id ` | Yes | App to install. | | `--version-id ` | No | A published version; omit to install the highest published version. | ### agentserve apps installs list [#agentserve-apps-installs-list] List App Installs (OAuth login or personal API key required) ```bash agentserve apps installs list ``` ### agentserve apps installs delete [#agentserve-apps-installs-delete] Uninstall App (OAuth login or personal API key required) ```bash agentserve apps installs delete [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve apps installs update [#agentserve-apps-installs-update] Update App Install (OAuth login or personal API key required) ```bash agentserve apps installs update [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | **Options** | Option | Required | Description | | ------------------------------------- | -------- | ------------------------------------------------------------------------------------- | | `--version-id ` | No | A published version to run instead — an upgrade or a roll back. | | `--pinned-for ` | No | Who sees the app as its own rail icon. (JSON, or @path / @- to read a file or stdin). | | `--budget-monthly-usd ` | No | Monthly budget in USD; null falls back to the manifest budget. | | `--status ` | No | Turn the app on or off. Accepted values: `active`, `disabled`. | ### agentserve apps activity list [#agentserve-apps-activity-list] Get App Install Activity (OAuth login or personal API key required) ```bash agentserve apps activity list ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | ### agentserve apps repos list [#agentserve-apps-repos-list] List App Repositories (OAuth login or personal API key required) ```bash agentserve apps repos list ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------- | | `appId` | Yes | App identifier. | ### agentserve apps list [#agentserve-apps-list] List Apps (OAuth login or personal API key required) ```bash agentserve apps list ``` ### agentserve apps tools list [#agentserve-apps-tools-list] List App Tools (OAuth login or personal API key required) ```bash agentserve apps tools list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------- | | `--install-id ` | No | Only the tools of this install. | ### agentserve apps publish create [#agentserve-apps-publish-create] Publish App Version (OAuth login or personal API key required) ```bash agentserve apps publish create [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `appId` | Yes | App identifier. | | `versionId` | Yes | Version identifier. | **Options** | Option | Required | Description | | -------------- | -------- | ------------------------------------------------------------- | | `--rollout` | No | Also move this workspace's install of the app to the version. | | `--no-rollout` | No | Send --rollout as false. | ### agentserve apps rebuild create [#agentserve-apps-rebuild-create] Rebuild App Deployment (OAuth login or personal API key required) ```bash agentserve apps rebuild create ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `appId` | Yes | App identifier. | | `deploymentId` | Yes | Deployment identifier. | ### agentserve apps retire create [#agentserve-apps-retire-create] Retire App Version (OAuth login or personal API key required) ```bash agentserve apps retire create [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `appId` | Yes | App identifier. | | `versionId` | Yes | Version identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve apps run create [#agentserve-apps-run-create] Run App Tool (OAuth login or personal API key required) ```bash agentserve apps run create [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | ------------------- | | `installId` | Yes | Install identifier. | | `toolName` | Yes | Tool name. | **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `--input ` | No | The tool's input; validated against its input schema. (JSON, or @path / @- to read a file or stdin). | ### agentserve apps versions create [#agentserve-apps-versions-create] Upload App Version (OAuth login or personal API key required) ```bash agentserve apps versions create ``` ## agentserve audit-logs [#agentserve-audit-logs] Also spelled `agentserve audit-log`. ### agentserve audit-logs get [#agentserve-audit-logs-get] Get Audit Log (OAuth login or personal API key required) ```bash agentserve audit-logs get [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `auditLogId` | Yes | Audit-log entry identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | No | Organization ID; defaults to your only organization, and is required when your account belongs to more than one (OAuth login or personal API key required). | ### agentserve audit-logs list [#agentserve-audit-logs-list] List Audit Logs (OAuth login or personal API key required) ```bash agentserve audit-logs list [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--action ` | No | Filter by exact action name. | | `--resource-type ` | No | Filter by resource type. Accepts a comma-separated set; members are trimmed and deduplicated, and member order affects neither the result nor the cursor. | | `--resource-id ` | No | Filter by exact resource identifier. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--include-departed` | No | Include actions by users who have left the organization. | | `--no-include-departed` | No | Send --include-departed as false. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--organization ` | No | Organization ID; defaults to your only organization, and is required when your account belongs to more than one (OAuth login or personal API key required). | | `--actor-email ` | No | Filter by actor email address. | | `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). | ## agentserve billing [#agentserve-billing] ### agentserve billing status [#agentserve-billing-status] Show billing status, credits spent this period, and storage used (credits and storage require an OAuth login or personal API key) ```bash agentserve billing status [options] ``` **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------- | | `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). | ### agentserve billing logs [#agentserve-billing-logs] List credit usage events (an OAuth login or personal API key reports only your events; a workspace API key reports every member's in aggregate, unattributed) ```bash agentserve billing logs [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--source ` | No | Filter by usage source; agentserve-chat covers Chat in the workspace and in the editor. Accepted values: `workflow`, `wand`, `agentserve-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`, `api-tool`, `dataset-refresh`, `dataset-query`, `voice-mode`, `app-tool`, `app-build`, `app-ide`, `app-ai`, `slides`. | | `--period ` | No | Billing period. Accepted values: `1d`, `7d`, `30d`, `all`, `custom`. | | `--start-date ` | No | Custom period start (ISO 8601). | | `--end-date ` | No | Custom period end (ISO 8601). | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--all-workspaces` | No | Do not filter to the configured workspace (OAuth login or personal API key required for account-wide access). | ## agentserve blocks [#agentserve-blocks] ### agentserve blocks get [#agentserve-blocks-get] Get Block ```bash agentserve blocks get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------ | | `blockId` | Yes | Block type identifier. An unversioned base type resolves to the newest version, and the response echoes the resolved id. | ### agentserve blocks list [#agentserve-blocks-list] List Blocks ```bash agentserve blocks list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the block id, name, and description. | | `--category ` | No | Restrict to one toolbar category. Accepted values: `blocks`, `tools`, `triggers`. | | `--capability ` | No | Restrict to blocks that can start a workflow — the `triggers` category, blocks declaring `triggerAllowed`, and blocks with trigger-mode fields. Accepted values: `trigger`. | | `--source ` | No | Restrict to built-in blocks or this workspace's deployed custom blocks. Accepted values: `builtin`, `custom`. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `id`, `name`, `category`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## agentserve chat-deployments [#agentserve-chat-deployments] ### agentserve chat-deployments list [#agentserve-chat-deployments-list] List Chat Deployments ```bash agentserve chat-deployments list [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------- | | `--workflow-id ` | No | Restrict to deployments of one workflow. | | `--is-active` | No | Restrict to active or inactive deployments. | | `--no-is-active` | No | Send --is-active as false. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `identifier`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## agentserve connector-types [#agentserve-connector-types] ### agentserve connector-types list [#agentserve-connector-types-list] List Connector Types ```bash agentserve connector-types list [options] ``` **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------ | | `--search ` | No | Case-insensitive substring match against the connector name. | ## agentserve credentials [#agentserve-credentials] Also spelled `agentserve credential`. ### agentserve credentials delete [#agentserve-credentials-delete] Disconnect Credential (OAuth login or personal API key required) ```bash agentserve credentials delete [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------- | | `credentialId` | Yes | Credential to disconnect. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve credentials members list [#agentserve-credentials-members-list] List Credential Members (OAuth login or personal API key required) ```bash agentserve credentials members list [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | -------------------------------------------- | | `credentialId` | Yes | Credential whose sharing grants are managed. | **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `email`, `name`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve credentials members remove [#agentserve-credentials-members-remove] Remove Credential Member (OAuth login or personal API key required) ```bash agentserve credentials members remove [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | -------------------------------------------- | | `credentialId` | Yes | Credential whose sharing grants are managed. | | `userId` | Yes | User whose explicit grant will be revoked. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve credentials members upsert [#agentserve-credentials-members-upsert] Upsert Credential Member (OAuth login or personal API key required) ```bash agentserve credentials members upsert [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | -------------------------------------------- | | `credentialId` | Yes | Credential whose sharing grants are managed. | **Options** | Option | Required | Description | | ---------------- | -------- | --------------------------------------------------------------------------------------------------------- | | `--user ` | Yes | Existing workspace member to grant or change access for. | | `--role ` | Yes | Credential role to grant; workspace administrators cannot be demoted. Accepted values: `admin`, `member`. | ### agentserve credentials providers list [#agentserve-credentials-providers-list] List Credential Providers ```bash agentserve credentials providers list [options] ``` **Options** | Option | Required | Description | | ------------------ | -------- | ---------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the credential provider name. | ### agentserve credentials list [#agentserve-credentials-list] List Credentials ```bash agentserve credentials list [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------- | | `--type ` | No | Restrict results to this credential type. Accepted values: `oauth`, `service_account`. | | `--provider-id ` | No | Restrict results to credentials for this integration provider. | | `--search ` | No | Case-insensitive substring match against the credential display name. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `displayName`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve credentials update [#agentserve-credentials-update] Update Credential (OAuth login or personal API key required) ```bash agentserve credentials update [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | --------------------- | | `credentialId` | Yes | Credential to update. | **Options** | Option | Required | Description | | ---------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `--display-name ` | No | New name shown for the credential in Agent Serve. | | `--description ` | No | New credential description. Send null to clear the stored one. (--description null sends the word, not JSON null). | | `--service-account-json ` | No | Write-only provider service-account JSON configuration, including Oracle Database connection fields. | | `--api-token ` | No | Write-only provider API token. | | `--domain ` | No | Provider account domain. | | `--atlassian-product ` | No | Atlassian product to verify; defaults to Jira on create and preserves the saved product on reconnect. Accepted values: `jira`, `confluence`. | | `--signing-secret ` | No | Write-only webhook signing secret. | | `--bot-token ` | No | Write-only bot token. | | `--client-id ` | No | OAuth client identifier. | | `--client-secret ` | No | Write-only OAuth client secret. | | `--certificate-id ` | No | Provider certificate mapping identifier. | | `--org-id ` | No | Provider organization ID. | | `--data-center ` | No | Provider data center. | | `--auth-method ` | No | Provider authentication method. | | `--private-key ` | No | Write-only PEM private key. | | `--username ` | No | Provider run-as username. | | `--tenancy-ocid ` | No | OCI tenancy OCID. | | `--user-ocid ` | No | OCI user OCID. | | `--fingerprint ` | No | OCI API-key fingerprint. | | `--private-key-passphrase ` | No | Write-only OCI private-key passphrase. | | `--region ` | No | OCI home region. | | `--name ` | No | Alias for --display-name. | ### agentserve credentials create [#agentserve-credentials-create] Create a service-account credential using its discovered provider schema (OAuth login or personal API key required) ```bash agentserve credentials create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------------------------------- | | `providerId` | Yes | Service-account provider to create a credential for | **Options** | Option | Required | Description | | ----------------------------- | -------- | --------------------------------------------------------------------- | | `--name ` | Yes | Name shown for the credential in Agent Serve. | | `--credentials ` | Yes | Provider credentials as JSON (or @path / @- to read a file or stdin). | | `--description ` | No | Optional credential description. | | `--id ` | No | Client-generated credential ID when provider discovery requires it. | ### agentserve credentials connect [#agentserve-credentials-connect] Create a short-lived link for connecting an OAuth provider (OAuth login or personal API key required) ```bash agentserve credentials connect [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ------------------------- | | `providerId` | Yes | OAuth provider to connect | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------- | | `--name ` | Yes | Name shown for the new credential in Agent Serve. | ### agentserve credentials reconnect [#agentserve-credentials-reconnect] Create a short-lived link for reconnecting an OAuth credential (OAuth login or personal API key required) ```bash agentserve credentials reconnect ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ----------------------------------------- | | `credentialId` | Yes | Existing OAuth credential to re-authorize | ## agentserve custom-tools [#agentserve-custom-tools] Also spelled `agentserve custom-tool`. ### agentserve custom-tools create [#agentserve-custom-tools-create] Create Custom Tool ```bash agentserve custom-tools create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--title ` | Yes | Display title, unique within the workspace. | | `--schema ` | Yes | OpenAI function schema: \{"type":"function","function":\{"name":"...","parameters":\{"type":"object","properties":\{}}}} (JSON, or @path / @- to read a file or stdin). | | `--code ` | Yes | Tool implementation executed in the sandboxed function runtime. | ### agentserve custom-tools delete [#agentserve-custom-tools-delete] Delete Custom Tool ```bash agentserve custom-tools delete [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------------ | | `customToolId` | Yes | Unique custom tool identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve custom-tools get [#agentserve-custom-tools-get] Get Custom Tool ```bash agentserve custom-tools get ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------------ | | `customToolId` | Yes | Unique custom tool identifier. | ### agentserve custom-tools list [#agentserve-custom-tools-list] List Custom Tools ```bash agentserve custom-tools list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the tool title. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `title`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve custom-tools update [#agentserve-custom-tools-update] Update Custom Tool ```bash agentserve custom-tools update [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ------------------------------ | | `customToolId` | Yes | Unique custom tool identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--title ` | No | New display title for the tool. | | `--schema ` | No | OpenAI function schema: \{"type":"function","function":\{"name":"...","parameters":\{"type":"object","properties":\{}}}} (JSON, or @path / @- to read a file or stdin). | | `--code ` | No | Replacement tool implementation. | ## agentserve files [#agentserve-files] Also spelled `agentserve file`. ### agentserve files batch-delete [#agentserve-files-batch-delete] Delete several files at once ```bash agentserve files batch-delete [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | | `--file-ids ` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve files copy [#agentserve-files-copy] POST /api/v2/files/copy ```bash agentserve files copy [options] ``` **Options** | Option | Required | Description | | ----------------------------- | -------- | --------------------------------------------------------------------------------------------- | | `--source ` | Yes | Source owner and selected fileIds or folderIds (JSON, or @path / @- to read a file or stdin). | | `--destination ` | Yes | Destination owner and optional folderId (JSON, or @path / @- to read a file or stdin). | ### agentserve files create [#agentserve-files-create] Create File ```bash agentserve files create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | File name, including its extension. Path separators and dot segments are rejected. | | `--content-type ` | No | MIME type. When omitted, it is inferred from the file extension. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--content ` | No | Initial file content. Omit or send an empty string for a zero-byte file. The 70,000,000-character bound guards the JSON envelope; the decoded bytes must be at most 50 MiB, and a longer base64 payload is rejected with `413`. Use an upload session for anything larger. | | `--encoding ` | No | Encoding of the content field. Accepted values: `utf-8`, `base64`. | ### agentserve files folders create [#agentserve-files-folders-create] Create a file folder at a path ```bash agentserve files folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve files folders delete [#agentserve-files-folders-delete] Delete Folder ```bash agentserve files folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve files folders list [#agentserve-files-folders-list] List folders ```bash agentserve files folders list [options] ``` Also available as `agentserve files folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--scope ` | No | Which lifecycle set to list: `active` (default) returns live folders only; `archived` returns folders a recursive delete soft-deleted, which is how a caller finds a path to hand to the folder restore. Authorization is identical for both. Accepted values: `active`, `archived`. | | `--recursive ` | No | Whether parentPath includes every descendant instead of direct children only. Accepted values: `true`, `1`, `yes`, `on`, `y`, `enabled`, `false`, `0`, `no`, `off`, `n`, `disabled`. | | `--depth ` | No | Deepest level below parentPath to include when recursive is true. | ### agentserve files folders move [#agentserve-files-folders-move] Rename or move a file folder ```bash agentserve files folders move ``` Also available as `agentserve files folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | | `destination` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve files folders restore [#agentserve-files-folders-restore] Restore an archived file folder ```bash agentserve files folders restore ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve files delete [#agentserve-files-delete] Delete File ```bash agentserve files delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve files versions delete [#agentserve-files-versions-delete] Permanently delete a previous version of a file ```bash agentserve files versions delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | | `version` | Yes | Version number. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve files versions describe [#agentserve-files-versions-describe] Show the metadata of one version of a file ```bash agentserve files versions describe ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | | `version` | Yes | Version number. | ### agentserve files versions list [#agentserve-files-versions-list] List the recorded versions of a file ```bash agentserve files versions list [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------------------------- | | `--sort-by ` | No | Field used to sort the result. Accepted values: `version`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve files versions read [#agentserve-files-versions-read] Read the text content of one version of a file ```bash agentserve files versions read [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | | `version` | Yes | Version number. | **Options** | Option | Required | Description | | --------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `--max-bytes ` | No | Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit. | | `--offset ` | No | First line to return, 1-based; 0 also starts at the first line. Absent starts at the first line. | | `--limit ` | No | How many lines to return from `offset`. Absent reads to the end. | ### agentserve files versions revert [#agentserve-files-versions-revert] Make a previous version of a file current again ```bash agentserve files versions revert [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | | `version` | Yes | Version number. | **Options** | Option | Required | Description | | ------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--expected-current-version ` | No | Revert only while this is still the current version; otherwise the request fails with `409`. Omit to revert whatever is current. Collaborative edits and repeated workflow writes that fold into the current version keep its number, so prefer `expectedRevision` to guard content. | | `--expected-revision ` | No | Revert only while the file still holds the content this revision names, as returned by Get File Metadata or an earlier write; otherwise the request fails with `409`. Unlike a version number, it also catches edits that folded into the current version. | ### agentserve files versions download [#agentserve-files-versions-download] Download the content of one version of a file ```bash agentserve files versions download [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | | `version` | Yes | Version number. | **Options** | Option | Required | Description | | -------------------------- | -------- | --------------------------------------------- | | `-o, --output-file ` | No | Write content to a file instead of stdout. | | `--force` | No | Overwrite --output-file if it already exists. | ### agentserve files edit [#agentserve-files-edit] Apply one exact or anchor-based edit to a text file ```bash agentserve files edit [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--edit ` | Yes | One edit object: \{"mode":"search\_replace","search":"old","content":"new","replaceAll":false}, \{"mode":"replace\_between","beforeAnchor":"start line","afterAnchor":"end line","content":"new"}, \{"mode":"insert\_after","anchor":"line","content":"new"}, or \{"mode":"delete\_between","startAnchor":"first line deleted","endAnchor":"ending line kept"}. Anchored modes also accept occurrence starting at 1 (JSON, or @path / @- to read a file or stdin). | | `--expected-revision ` | No | Revision from Get File Metadata or an earlier write; the request is refused with `409` when the content moved on. | ### agentserve files describe [#agentserve-files-describe] Show file metadata and sharing status ```bash agentserve files describe [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--scope ` | No | Which lifecycle set to read from: `active` (default) resolves live files only and returns `404` for a file a delete soft-deleted; `archived` also resolves soft-deleted files, so metadata stays readable before the file is restored. Authorization is identical for both. Accepted values: `active`, `archived`. | ### agentserve files share get [#agentserve-files-share-get] Show a file’s share settings ```bash agentserve files share get ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | ### agentserve files share set [#agentserve-files-share-set] Enable or disable sharing for a file (OAuth login or personal API key required) ```bash agentserve files share set [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--is-active ` | Yes | Whether the share should resolve. Disabling preserves the token and the whole access configuration, so re-enabling restores the share as it was; enabling rewrites the credentials the resulting mode does not use. Accepted values: `true`, `false`. | | `--auth-type ` | No | How access to the share is gated. The stored mode is kept when omitted. Enabling `public` clears the stored password and empties `allowedEmails`; `password` empties `allowedEmails`; `email` and `sso` clear the stored password. Accepted values: `public`, `password`, `email`, `sso`. | | `--password ` | No | Password for a password-gated share. Kept when omitted; enabling `password` with neither a supplied nor a stored password is a 400. | | `--allowed-emails ` | No | Allowed addresses or `@domain` patterns for email and SSO shares. Kept when omitted; enabling `email` or `sso` with an empty resulting list is a 400. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### agentserve files list [#agentserve-files-list] List Files ```bash agentserve files list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--recursive` | No | Include subfolders in the folder filter. Defaults to true when searching and false otherwise. Ignored without a folder filter. | | `--no-recursive` | No | Send --recursive as false. | | `--scope ` | No | Which lifecycle set to list: `active` (default) for live files, `archived` for files a delete soft-deleted. `folderPath` resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. | | `--search ` | No | Case-insensitive substring match against the file name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `size`, `uploadedAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve files move [#agentserve-files-move] Move files into another folder ```bash agentserve files move [options] ``` Also available as `agentserve files mv`. **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | | `--file-ids ` | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--to ` | No | Destination folder path; omit for root. | ### agentserve files read [#agentserve-files-read] Read a file’s text content as JSON or YAML ```bash agentserve files read [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | --------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `--max-bytes ` | No | Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit. | | `--offset ` | No | First line to return, 1-based; 0 also starts at the first line. Absent starts at the first line. | | `--limit ` | No | How many lines to return from `offset`. Absent reads to the end. | ### agentserve files rename [#agentserve-files-rename] Rename a file ```bash agentserve files rename [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ---------------- | -------- | --------------------------------------- | | `--name ` | Yes | New file name, including its extension. | ### agentserve files restore [#agentserve-files-restore] Restore an archived file ```bash agentserve files restore ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | ### agentserve files search [#agentserve-files-search] Search File Content ```bash agentserve files search [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--query ` | Yes | Regular expression, or exact text when `mode` is `exact`. | | `--mode ` | No | How `query` is read. Accepted values: `exact`, `regex`. | | `--max-results ` | No | Maximum matching lines to return. | | `--folder ` | No | Folders to search, by path as shown in the app; omit to search the whole workspace (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--include-subfolders` | No | Whether each folder scope includes nested folders; on by default. | | `--no-include-subfolders` | No | Send --include-subfolders as false. | ### agentserve files unzip [#agentserve-files-unzip] Unzip an archive into a new folder beside it ```bash agentserve files unzip [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve files set-content [#agentserve-files-set-content] Replace a file’s contents ```bash agentserve files set-content [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------- | | `fileId` | Yes | File identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--content ` | Yes | Complete replacement content for the file. The 70,000,000-character bound guards the JSON envelope; the decoded bytes must be at most 50 MiB, and a longer base64 payload is rejected with `413`. | | `--encoding ` | No | Content encoding. Accepted values: `utf-8`, `base64`. | | `--expected-revision ` | No | Revision from Get File Metadata or an earlier write; the request is refused with `409` when the content moved on. | ### agentserve files upload [#agentserve-files-upload] Upload a file to the workspace ```bash agentserve files upload [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | -------------------- | | `path` | Yes | Local file to upload | **Options** | Option | Required | Description | | ----------------- | -------- | ------------------------------------------------------------- | | `--folder ` | No | Folder path as shown in the app; defaults to the root folder. | | `--name ` | No | Store it under a different name. | ### agentserve files get [#agentserve-files-get] Download a file’s content to stdout or a local file ```bash agentserve files get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | -------------------------- | | `fileId` | Yes | File whose content to read | **Options** | Option | Required | Description | | -------------------------- | -------- | --------------------------------------------- | | `-o, --output-file ` | No | Write content to a file instead of stdout. | | `--force` | No | Overwrite --output-file if it already exists. | ### agentserve files ls [#agentserve-files-ls] List file resources and child folders together ```bash agentserve files ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### agentserve files mkdir [#agentserve-files-mkdir] Create a file directory at a path ```bash agentserve files mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## agentserve knowledge [#agentserve-knowledge] Also spelled `agentserve kb`. ### agentserve knowledge from-workspace-files create [#agentserve-knowledge-from-workspace-files-create] Index files the workspace already stores (OAuth login or personal API key required) ```bash agentserve knowledge from-workspace-files create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | | `--file ` | Yes | Workspace file ID or key (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### agentserve knowledge tags save [#agentserve-knowledge-tags-save] Declare the tag definitions a knowledge base needs (OAuth login or personal API key required) ```bash agentserve knowledge tags save [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `--definitions ` | Yes | Tag definitions: \[\{"tagSlot":"tag1","displayName":"category","fieldType":"text"}] (JSON, or @path / @- to read a file or stdin). | ### agentserve knowledge tags create [#agentserve-knowledge-tags-create] Create Tag (OAuth login or personal API key required) ```bash agentserve knowledge tags create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--display-name ` | Yes | Name tag filters and document reads use for this tag. | | `--field-type ` | No | Value type stored in the slot; it decides which slots are usable and which filter operators apply. Defaults to text, so a number, date, or boolean slot must name its type here. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`. | | `--tag-slot ` | No | Slot to store the tag in. Omit to take the next free slot for the field type; a slot that does not belong to the field type, or one already in use, is rejected. Accepted values: `tag1`, `tag2`, `tag3`, `tag4`, `tag5`, `tag6`, `tag7`, `number1`, `number2`, `number3`, `number4`, `number5`, `date1`, `date2`, `boolean1`, `boolean2`, `boolean3`. | ### agentserve knowledge tags delete [#agentserve-knowledge-tags-delete] Delete Tag (OAuth login or personal API key required) ```bash agentserve knowledge tags delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `tagId` | Yes | Unique tag definition identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge tags cleanup [#agentserve-knowledge-tags-cleanup] Remove tag definitions no document still uses (OAuth login or personal API key required) ```bash agentserve knowledge tags cleanup [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--unused` | No | Whether to remove only the tag definitions no document in the knowledge base still carries a value for. Defaults to true. Pass --no-unused to delete every definition on the knowledge base, which also clears its slot on every document and chunk and is not recoverable. | | `--no-unused` | No | Send --unused as false. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge tags next-slot [#agentserve-knowledge-tags-next-slot] Show which tag slot a create would take for a field type (OAuth login or personal API key required) ```bash agentserve knowledge tags next-slot [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--field-type ` | Yes | Value type stored in the slot; it decides which slots are usable and which filter operators apply. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`. | ### agentserve knowledge tags list [#agentserve-knowledge-tags-list] List Tags ```bash agentserve knowledge tags list ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### agentserve knowledge tags usage [#agentserve-knowledge-tags-usage] Show how many documents and chunks carry each tag (OAuth login or personal API key required) ```bash agentserve knowledge tags usage ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### agentserve knowledge tags update [#agentserve-knowledge-tags-update] Update Tag (OAuth login or personal API key required) ```bash agentserve knowledge tags update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `tagId` | Yes | Unique tag definition identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------- | | `--display-name ` | No | New tag display name. | | `--field-type ` | No | New value type for the tag. Accepted values: `text`, `number`, `date`, `boolean`. | ### agentserve knowledge chunks batch-update [#agentserve-knowledge-chunks-batch-update] Enable, disable, or delete many chunks at once (OAuth login or personal API key required) ```bash agentserve knowledge chunks batch-update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--operation ` | Yes | What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`. | | `--chunk ` | Yes | Chunks to operate on, by identifier. An id naming no chunk in the document is reported in errors and does not fail the request. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge chunks create [#agentserve-knowledge-chunks-create] Create Chunk (OAuth login or personal API key required) ```bash agentserve knowledge chunks create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | ------------------- | -------- | ------------------------------------------------------------------------------- | | `--content ` | Yes | Text to embed. It is embedded on write, so the chunk is searchable immediately. | | `--enabled` | No | Whether the new chunk participates in search. | | `--no-enabled` | No | Send --enabled as false. | ### agentserve knowledge chunks delete [#agentserve-knowledge-chunks-delete] Delete Chunk (OAuth login or personal API key required) ```bash agentserve knowledge chunks delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | | `chunkId` | Yes | Unique chunk identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge chunks get [#agentserve-knowledge-chunks-get] Get Chunk (OAuth login or personal API key required) ```bash agentserve knowledge chunks get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | | `chunkId` | Yes | Unique chunk identifier. | ### agentserve knowledge chunks list [#agentserve-knowledge-chunks-list] List Chunks (OAuth login or personal API key required) ```bash agentserve knowledge chunks list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against chunk content. | | `--enabled ` | No | Restrict to enabled or disabled chunks. `all` returns both. Accepted values: `true`, `false`, `all`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `chunkIndex`, `tokenCount`, `enabled`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve knowledge chunks update [#agentserve-knowledge-chunks-update] Update Chunk (OAuth login or personal API key required) ```bash agentserve knowledge chunks update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | | `chunkId` | Yes | Unique chunk identifier. | **Options** | Option | Required | Description | | ------------------- | -------- | ------------------------------------------------------------------------------------------------ | | `--content ` | No | Replacement text. Changing it re-embeds the chunk and re-derives its token and character counts. | | `--enabled` | No | Whether the chunk participates in search. Disabling keeps it indexed. | | `--no-enabled` | No | Send --enabled as false. | ### agentserve knowledge documents batch-update [#agentserve-knowledge-documents-batch-update] Enable or disable every matching document (OAuth login or personal API key required) ```bash agentserve knowledge documents batch-update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | | `--operation ` | Yes | Whether the selected documents become enabled or disabled for search. Accepted values: `enable`, `disable`. | | `--document ` | No | Documents to update, by identifier. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--select-all` | No | Apply to every document in the knowledge base. | | `--enabled-filter ` | No | With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`. | ### agentserve knowledge documents delete [#agentserve-knowledge-documents-delete] Delete a document from a knowledge base ```bash agentserve knowledge documents delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge documents get [#agentserve-knowledge-documents-get] Get Document ```bash agentserve knowledge documents get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | ### agentserve knowledge documents list [#agentserve-knowledge-documents-list] List Documents ```bash agentserve knowledge documents list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--search ` | No | Case-insensitive substring match against the document filename. | | `--enabled-filter ` | No | Filter by whether documents are enabled for search. Accepted values: `all`, `enabled`, `disabled`. | | `--sort-by ` | No | Field used to sort the result. Sorting by `filename` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `filename`, `fileSize`, `tokenCount`, `chunkCount`, `uploadedAt`, `processingStatus`, `enabled`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--tag-filters ` | No | A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: `[{"tagName":"category","operator":"eq","value":"billing"}]`. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored. | ### agentserve knowledge documents update [#agentserve-knowledge-documents-update] Update Document (OAuth login or personal API key required) ```bash agentserve knowledge documents update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `documentId` | Yes | Unique knowledge document identifier. | **Options** | Option | Required | Description | | -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--filename ` | No | New filename for the document. | | `--enabled` | No | Whether the document participates in search. Disabling keeps it indexed. | | `--no-enabled` | No | Send --enabled as false. | | `--tag1 ` | No | New value for tag slot 1. | | `--tag2 ` | No | New value for tag slot 2. | | `--tag3 ` | No | New value for tag slot 3. | | `--tag4 ` | No | New value for tag slot 4. | | `--tag5 ` | No | New value for tag slot 5. | | `--tag6 ` | No | New value for tag slot 6. | | `--tag7 ` | No | New value for tag slot 7. | | `--number1 ` | No | New value for number tag slot 1. | | `--number2 ` | No | New value for number tag slot 2. | | `--number3 ` | No | New value for number tag slot 3. | | `--number4 ` | No | New value for number tag slot 4. | | `--number5 ` | No | New value for number tag slot 5. | | `--date1 ` | No | New value for date tag slot 1, formatted YYYY-MM-DD. | | `--date2 ` | No | New value for date tag slot 2, formatted YYYY-MM-DD. | | `--boolean1` | No | New value for boolean tag slot 1. | | `--no-boolean1` | No | Send --boolean1 as false. | | `--boolean2` | No | New value for boolean tag slot 2. | | `--no-boolean2` | No | Send --boolean2 as false. | | `--boolean3` | No | New value for boolean tag slot 3. | | `--no-boolean3` | No | Send --boolean3 as false. | | `--retry-processing` | No | Requeue a failed or stuck document for processing. Send it alone — no other field may accompany it — and it answers with a queue acknowledgement rather than the document. | ### agentserve knowledge documents upload [#agentserve-knowledge-documents-upload] Upload a document to a knowledge base ```bash agentserve knowledge documents upload [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ----------------------------- | | `knowledgeBaseId` | Yes | Knowledge base to upload into | | `path` | Yes | Local file to upload | **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------------------ | | `--name ` | No | Store it under a different name. | | `--tag ` | No | Document tags, in tag1 through tag7 order. | | `--recipe ` | No | Document processing recipe. Accepted values: `default`, `plain`, `markdown`, `code`. | | `--lang ` | No | Document language tag: hyphen-separated letter and digit subtags, for example en or en-US. | ### agentserve knowledge create [#agentserve-knowledge-create] Create Knowledge Base ```bash agentserve knowledge create [options] ``` **Options** | Option | Required | Description | | --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Human-readable knowledge base name. | | `--description ` | No | Optional knowledge base description. | | `--chunking-config ` | No | Chunking configuration; defaults are applied when omitted. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### agentserve knowledge connectors create [#agentserve-knowledge-connectors-create] Create Knowledge Connector (OAuth login or personal API key required) ```bash agentserve knowledge connectors create [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | --------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | `--connector-type ` | Yes | Registered connector type. | | `--credential-id ` | No | OAuth credential identifier for connectors that require OAuth. | | `--api-key ` | No | Write-only API key for connectors that use API-key authentication. | | `--source-config ` | Yes | Connector-specific source selection and filtering configuration. (JSON, or @path / @- to read a file or stdin). | | `--sync-interval-minutes ` | No | Scheduled synchronization interval in minutes; zero disables scheduling. | ### agentserve knowledge connectors delete [#agentserve-knowledge-connectors-delete] Delete Knowledge Connector (OAuth login or personal API key required) ```bash agentserve knowledge connectors delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------- | | `--delete-documents` | No | Also permanently delete documents produced by this connector. | | `--no-delete-documents` | No | Send --delete-documents as false. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge connectors get [#agentserve-knowledge-connectors-get] Get Knowledge Connector (OAuth login or personal API key required) ```bash agentserve knowledge connectors get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | ### agentserve knowledge connectors documents list [#agentserve-knowledge-connectors-documents-list] List Knowledge Connector Documents (OAuth login or personal API key required) ```bash agentserve knowledge connectors documents list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ----------------------- | -------- | -------------------------------------------------------------- | | `--include-excluded` | No | Include documents explicitly excluded by a user. | | `--no-include-excluded` | No | Send --include-excluded as false. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve knowledge connectors documents update [#agentserve-knowledge-connectors-documents-update] Update Knowledge Connector Documents (OAuth login or personal API key required) ```bash agentserve knowledge connectors documents update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `--operation ` | Yes | Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`. | | `--document ` | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### agentserve knowledge connectors list [#agentserve-knowledge-connectors-list] List Knowledge Connectors (OAuth login or personal API key required) ```bash agentserve knowledge connectors list [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------ | | `--sort-by ` | No | Field used to sort the result. Accepted values: `connectorType`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve knowledge connectors sync [#agentserve-knowledge-connectors-sync] Queue a knowledge connector synchronization (OAuth login or personal API key required) ```bash agentserve knowledge connectors sync [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | ---------------- | -------- | -------------------------------------------------------- | | `--rehydrate` | No | Re-fetch and re-index every existing connector document. | | `--no-rehydrate` | No | Send --rehydrate as false. | ### agentserve knowledge connectors update [#agentserve-knowledge-connectors-update] Update Knowledge Connector (OAuth login or personal API key required) ```bash agentserve knowledge connectors update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------------- | | `knowledgeBaseId` | Yes | Knowledge base that owns the connector. | | `connectorId` | Yes | Connector selected for the operation. | **Options** | Option | Required | Description | | --------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--source-config ` | No | Replacement source selection and filtering configuration. Updating a runnable connector queues synchronization; paused connectors remain paused. (JSON, or @path / @- to read a file or stdin). | | `--sync-interval-minutes ` | No | New scheduled synchronization interval in minutes. | | `--status ` | No | New connector state. Accepted values: `active`, `paused`. | ### agentserve knowledge folders create [#agentserve-knowledge-folders-create] Create a knowledge folder at a path ```bash agentserve knowledge folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve knowledge folders delete [#agentserve-knowledge-folders-delete] Delete Folder ```bash agentserve knowledge folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge folders list [#agentserve-knowledge-folders-list] List knowledge folders ```bash agentserve knowledge folders list [options] ``` Also available as `agentserve knowledge folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve knowledge folders move [#agentserve-knowledge-folders-move] Rename or move a knowledge folder ```bash agentserve knowledge folders move ``` Also available as `agentserve knowledge folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | | `destination` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve knowledge delete [#agentserve-knowledge-delete] Delete Knowledge Base ```bash agentserve knowledge delete [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve knowledge get [#agentserve-knowledge-get] Get Knowledge Base ```bash agentserve knowledge get ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### agentserve knowledge list [#agentserve-knowledge-list] List Knowledge Bases ```bash agentserve knowledge list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Lifecycle scope: active or archived knowledge bases. Use Restore Knowledge Base to recover archived entries. Folder paths resolve only active folders, so filtering by an archived folder returns no matches. Accepted values: `active`, `archived`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--search ` | No | Case-insensitive substring match against the resource name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve knowledge restore [#agentserve-knowledge-restore] Restore an archived knowledge base ```bash agentserve knowledge restore ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | ### agentserve knowledge search [#agentserve-knowledge-search] Search Knowledge ```bash agentserve knowledge search [options] ``` **Options** | Option | Required | Description | | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--kb ` | Yes | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--query ` | No | Text to search for. | | `--top-k ` | No | Maximum number of search results to return. Must be a whole number between 1 and 100. | | `--tag-filters ` | No | Tag filters as \[\{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin). | | `--search-mode ` | No | Search algorithm. Accepted values: `vector`, `hybrid`. | | `--reranker-enabled` | No | Re-order retrieved chunks with a reranking model before truncating to `topK`. Ignored for a tag-only search, and billed per rerank call on top of the search. Reranking is best-effort — a provider failure falls back to vector ordering, so check `rerankerStatus` on the response. A model your organization's model policy does not allow (including its zero-data-retention requirement) is rejected with 403. | | `--no-reranker-enabled` | No | Send --reranker-enabled as false. | | `--reranker-model ` | No | Reranking model to use when `rerankerEnabled` is true: a Cohere id (`rerank-v4.0-pro`, `rerank-v4.0-fast`, `rerank-v3.5`) or an OpenRouter rerank model as `openrouter/<maker>/<model>`, e.g. `openrouter/voyageai/rerank-2.5`. Defaults to `rerank-v4.0-fast`. (JSON, or @path / @- to read a file or stdin). | | `--reranker-input-count ` | No | How many candidate chunks to retrieve before reranking. Defaults to four times `topK`, capped at 100. A larger pool costs more retrieval work but gives the reranker more to choose from. | ### agentserve knowledge update [#agentserve-knowledge-update] Update Knowledge Base ```bash agentserve knowledge update [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | --------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | **Options** | Option | Required | Description | | --------------------------------- | -------- | ----------------------------------------------------------------------------------- | | `--name ` | No | New knowledge base name. | | `--description ` | No | New knowledge base description. | | `--chunking-config ` | No | New document chunking configuration. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### agentserve knowledge mv [#agentserve-knowledge-mv] Move a knowledge base to a folder ```bash agentserve knowledge mv ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ---------------------------------------------------------- | | `knowledgeBaseId` | Yes | Unique knowledge base identifier. | | `folder` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve knowledge export [#agentserve-knowledge-export] Export a knowledge base as a .agentservekb.zip bundle ```bash agentserve knowledge export [options] ``` **Arguments** | Argument | Required | Description | | ----------------- | -------- | ------------------------ | | `knowledgeBaseId` | Yes | Knowledge base to export | **Options** | Option | Required | Description | | -------------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | `-o, --output-file ` | No | Write the bundle to this path instead of the name the server suggests; pass - to stream it to stdout. | | `--force` | No | Overwrite --output-file if it already exists. | | `--no-vectors` | No | Leave chunk vectors out of the bundle, so an import re-embeds every chunk. | ### agentserve knowledge ls [#agentserve-knowledge-ls] List knowledge resources and child folders together ```bash agentserve knowledge ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### agentserve knowledge mkdir [#agentserve-knowledge-mkdir] Create a knowledge directory at a path ```bash agentserve knowledge mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## agentserve logs [#agentserve-logs] Also spelled `agentserve log`. ### agentserve logs get [#agentserve-logs-get] Show run diagnostics ```bash agentserve logs get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `--include-workflow-state` | No | Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged. | | `--no-include-workflow-state` | No | Send --include-workflow-state as false. | | `--trace` | No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. | ### agentserve logs stats [#agentserve-logs-stats] Summarize run counts, failures and latency over a window ```bash agentserve logs stats [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | No | Comma-separated workflow identifiers to include. At most 200 entries. An empty entry is rejected. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--trigger ` | No | Comma-separated trigger types to include. An empty entry is rejected. The vocabulary is open, so an unrecognized member selects no runs; the literal `all` disables this filter. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--level ` | No | Severity level to include. Accepted values: `info`, `error`. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--segment-count ` | No | Number of time buckets, up to 500. Exactly this many are returned, each at least one minute wide. Short windows extend past the requested end and include empty trailing buckets. | ### agentserve logs list [#agentserve-logs-list] List run logs, such as failed or errored runs, by workflow, trigger or time ```bash agentserve logs list [options] ``` **Options** | Option | Required | Description | | --------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | No | Comma-separated workflow identifiers to include. An empty entry is rejected. At most 200 entries. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--trigger ` | No | Comma-separated, lowercase trigger types or webhook provider IDs. Matching is exact and case-sensitive; unknown values select no runs. An empty entry is rejected. The sentinel `all` disables this filter, even when listed with other values. At most 100 entries. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--level ` | No | Severity level to include. Accepted values: `info`, `error`. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--min-duration-ms ` | No | Minimum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected. | | `--max-duration-ms ` | No | Maximum total execution duration in milliseconds. Whole milliseconds from 0 to 2147483647; the stored duration is a 32-bit integer, so a fractional or out-of-range bound is rejected. | | `--min-cost ` | No | Minimum execution cost in USD, from 0 to 1000000. A run is never charged a negative amount, so a negative bound is rejected rather than treated as a filter that matches every run. | | `--max-cost ` | No | Maximum execution cost in USD, from 0 to 1000000. A run is never charged a negative amount, so a negative bound is rejected rather than treated as a filter that matches every run. | | `--model ` | No | AI model used during execution. | | `--details ` | No | Response detail level; full is requested by default to name each run’s workflow. Accepted values: `basic`, `full`. | | `--include-trace-spans` | No | Include trace spans in JSON or YAML output (implies full detail). | | `--include-final-output` | No | Include final output in JSON or YAML output (implies full detail). | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--status ` | No | Comma-separated execution statuses to include, from `pending` \| `running` \| `paused` \| `redacting` \| `completed` \| `failed` \| `cancelled`. An empty entry is rejected. ANDed with `level`, which reports severity rather than lifecycle. | | `--workflow-name ` | No | Case-insensitive substring match against the run's workflow name. Runs whose workflow has been deleted match nothing, because the name is no longer joinable. | | `--include-job-runs` | No | Include Chat and Agent Serve agent jobs alongside workflow runs. Jobs use `kind: "job"` and have no workflow or cost ledger. Workflow, folder, model, or status filters exclude jobs. This option is valid only when sorting by `startedAt`. | | `--no-include-job-runs` | No | Send --include-job-runs as false. | | `--run-id ` | No | Exact run identifier to match. | | `--sort-by ` | No | Field used to sort the result. `durationMs` and `cost` are null until a run settles; those runs sort before recorded values in ascending order and after them in descending order. Only `startedAt` can order Chat and Agent Serve agent job runs, so any other value is rejected when job runs are included. Accepted values: `startedAt`, `durationMs`, `cost`, `status`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### agentserve logs follow [#agentserve-logs-follow] Watch runs live as they arrive, printing each new run once ```bash agentserve logs follow [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ | | `--workflow ` | No | Only follow runs of this workflow (repeatable). | | `--folder ` | No | Only follow runs of workflows in this folder (repeatable). | | `--trigger ` | No | Only follow runs with this trigger type (repeatable). | | `--level ` | No | Only follow runs at this severity. Accepted values: `info`, `error`. | | `--details ` | No | Response detail level; full names each run’s workflow. Accepted values: `basic`, `full`. Defaults to `full`. | | `-n, --lines ` | No | Recent runs to print before watching. Defaults to `10`. | | `--interval ` | No | Seconds between polls. Defaults to `3`. | ## agentserve mcp-servers [#agentserve-mcp-servers] Also spelled `agentserve mcp-server`. ### agentserve mcp-servers create [#agentserve-mcp-servers-create] Create MCP Server ```bash agentserve mcp-servers create [options] ``` **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Server display name. | | `--description ` | No | Optional server description. | | `--transport ` | No | Transport protocol. Defaults to `streamable-http` on creation. Accepted values: `streamable-http`. | | `--url ` | Yes | Absolute HTTP or HTTPS endpoint URL without `{{ENV_VAR}}` references. It determines server identity and is immutable: delete and recreate the server to change endpoints. | | `--auth-type ` | No | Authentication method. When omitted, and no `headers` are sent, registration probes the endpoint once to classify it, falling back to `headers` when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as `oauth`, and headers configured afterwards will not authenticate — send this field explicitly to pin the method. Accepted values: `none`, `headers`, `oauth`. | | `--headers ` | No | Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin). | | `--timeout ` | No | Per-request timeout in milliseconds. Defaults to 30000 on creation. | | `--retries ` | No | Number of retries per request. Defaults to 3 on creation. | | `--enabled` | No | Whether workflows can use the server's tools. Defaults to true on creation. | | `--no-enabled` | No | Send --enabled as false. | | `--oauth-client-id ` | No | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization. | | `--oauth-client-secret ` | No | Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null). | ### agentserve mcp-servers delete [#agentserve-mcp-servers-delete] Delete MCP Server ```bash agentserve mcp-servers delete [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve mcp-servers get [#agentserve-mcp-servers-get] Get MCP Server ```bash agentserve mcp-servers get ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | ### agentserve mcp-servers list [#agentserve-mcp-servers-list] List MCP Servers ```bash agentserve mcp-servers list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the server name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve mcp-servers tools list [#agentserve-mcp-servers-tools-list] List MCP Server Tools (OAuth login or personal API key required) ```bash agentserve mcp-servers tools list [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | **Options** | Option | Required | Description | | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `--refresh` | No | Refresh tools using your credentials. Otherwise results may reuse another workspace member's recent discovery and omit newly added tools. | | `--no-refresh` | No | Send --refresh as false. | ### agentserve mcp-servers update [#agentserve-mcp-servers-update] Update MCP Server ```bash agentserve mcp-servers update [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ----------------------------- | | `mcpServerId` | Yes | Unique MCP server identifier. | **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | Server display name. | | `--description ` | No | Optional server description. | | `--transport ` | No | Transport protocol. Defaults to `streamable-http` on creation. Accepted values: `streamable-http`. | | `--url ` | No | Immutable server URL. When provided, it must equal the current URL; use delete and create to change endpoints. | | `--auth-type ` | No | Authentication method. When omitted, and no `headers` are sent, registration probes the endpoint once to classify it, falling back to `headers` when the probe fails or the server does not advertise OAuth. A server publishing RFC 9728 metadata is therefore stored as `oauth`, and headers configured afterwards will not authenticate — send this field explicitly to pin the method. Accepted values: `none`, `headers`, `oauth`. | | `--headers ` | No | Write-only request headers sent to the server. Replaced wholesale rather than merged on update: sending this field drops every stored header it does not repeat. (JSON, or @path / @- to read a file or stdin). | | `--timeout ` | No | Per-request timeout in milliseconds. Defaults to 30000 on creation. | | `--retries ` | No | Number of retries per request. Defaults to 3 on creation. | | `--enabled` | No | Whether workflows can use the server's tools. Defaults to true on creation. | | `--no-enabled` | No | Send --enabled as false. | | `--oauth-client-id ` | No | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization. | | `--oauth-client-secret ` | No | Write-only pre-registered OAuth client secret. Sending it on update as null or a new value revokes the stored OAuth grant and forces reauthorization, as does switching away from OAuth authentication. (--oauth-client-secret null sends the word, not JSON null). | ## agentserve meta [#agentserve-meta] ### agentserve meta status [#agentserve-meta-status] Show what this API supports and which limits apply ```bash agentserve meta status ``` ## agentserve organizations [#agentserve-organizations] ### agentserve organizations domains add [#agentserve-organizations-domains-add] Add Organization Domain (OAuth login or personal API key required) ```bash agentserve organizations domains add [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ---------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--domain ` | Yes | Domain to claim and verify through a DNS TXT record. | ### agentserve organizations domains list [#agentserve-organizations-domains-list] List Organization Domains (OAuth login or personal API key required) ```bash agentserve organizations domains list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------ | | `--organization ` | Yes | Organization identifier. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `domain`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve organizations domains remove [#agentserve-organizations-domains-remove] Remove Organization Domain (OAuth login or personal API key required) ```bash agentserve organizations domains remove [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ---------------------------------------- | | `domainId` | Yes | Domain claim owned by this organization. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve organizations domains verify [#agentserve-organizations-domains-verify] Verify Organization Domain (OAuth login or personal API key required) ```bash agentserve organizations domains verify [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ---------------------------------------- | | `domainId` | Yes | Domain claim owned by this organization. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations access-requests cancel [#agentserve-organizations-access-requests-cancel] Cancel Organization Access Request (OAuth login or personal API key required) ```bash agentserve organizations access-requests cancel [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `requestId` | Yes | Access request identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations access-requests create [#agentserve-organizations-access-requests-create] Create Organization Access Request (OAuth login or personal API key required) ```bash agentserve organizations access-requests create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--target ` | Yes | Target returned by Discover Workspace Access Requests or Discover Organization Access Requests. The target must currently be requestable. (JSON, or @path / @- to read a file or stdin). | | `--reason ` | No | Why the acting user needs this access. | ### agentserve organizations access-requests discover [#agentserve-organizations-access-requests-discover] Discover Organization Access Requests (OAuth login or personal API key required) ```bash agentserve organizations access-requests discover [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--organization ` | Yes | Organization identifier. | | `--search ` | No | Case-insensitive substring match against the access item label. | | `--target-kind ` | No | Category of access to discover. Accepted values: `feature`, `integration`, `provider`, `model`, `tool`, `knowledge_connector`, `file_share_auth`, `chat_deploy_auth`, `usage_limit`. | | `--state ` | No | Filter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: `allowed`, `requestable`, `unavailable`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `label`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve organizations access-requests settings get [#agentserve-organizations-access-requests-settings-get] Get Organization Access Request Settings (OAuth login or personal API key required) ```bash agentserve organizations access-requests settings get [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations access-requests settings update [#agentserve-organizations-access-requests-settings-update] Update Organization Access Request Settings (OAuth login or personal API key required) ```bash agentserve organizations access-requests settings update [options] ``` **Options** | Option | Required | Description | | -------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--allow-requests ` | Yes | Allow new requests and approvals. Disabling requests preserves history and still allows cancellation and decline. Accepted values: `true`, `false`. | ### agentserve organizations access-requests mine [#agentserve-organizations-access-requests-mine] List My Organization Access Requests (OAuth login or personal API key required) ```bash agentserve organizations access-requests mine [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--status ` | No | Filter by request status; omit to include all statuses. Accepted values: `pending`, `fulfilled`, `declined`, `cancelled`, `closed`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `createdAt`, `targetLabel`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve organizations access-requests list [#agentserve-organizations-access-requests-list] List Organization Access Requests (OAuth login or personal API key required) ```bash agentserve organizations access-requests list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--status ` | No | Filter by request status; omit to include all statuses. Accepted values: `pending`, `fulfilled`, `declined`, `cancelled`, `closed`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `createdAt`, `targetLabel`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--search ` | No | Case-insensitive substring match against the target label or requester name or email. | ### agentserve organizations access-requests preview [#agentserve-organizations-access-requests-preview] Preview Organization Access Request (OAuth login or personal API key required) ```bash agentserve organizations access-requests preview [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `requestId` | Yes | Access request identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations access-requests resolve [#agentserve-organizations-access-requests-resolve] Resolve Organization Access Request (OAuth login or personal API key required) ```bash agentserve organizations access-requests resolve [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `requestId` | Yes | Access request identifier. | **Options** | Option | Required | Description | | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--action ` | Yes | apply: Apply the reviewed change to the governing group or member credit cap. decline: Decline the request without changing permissions or credit limits. Accepted values: `apply`, `decline`. | | `--expected-fingerprint ` | No | Fingerprint from Preview Organization Access Request. Review its changes and impact before applying; a stale preview returns a conflict. Available when action is apply. Required when action is apply. | | `--new-limit-credits ` | No | Required only for a usage-limit request: a whole-number credit cap greater than the current cap. Omit for permission requests. Available when action is apply. | | `--reason ` | No | Required explanation for declining this request. Available when action is decline. Required when action is decline. | ### agentserve organizations invitations create [#agentserve-organizations-invitations-create] Create Organization Invitation (OAuth login or personal API key required) ```bash agentserve organizations invitations create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--email ` | Yes | Email address of the person to invite. | | `--role ` | No | Organization role to offer. Defaults to member; grants no workspace-specific permissions. Accepted values: `member`, `admin`. | ### agentserve organizations invitations get [#agentserve-organizations-invitations-get] Get Organization Invitation (OAuth login or personal API key required) ```bash agentserve organizations invitations get [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `invitationId` | Yes | Invitation identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations invitations list [#agentserve-organizations-invitations-list] List Organization Invitations (OAuth login or personal API key required) ```bash agentserve organizations invitations list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--search ` | No | Case-insensitive substring match against the invitee email. | | `--status ` | No | Filter by current invitation status. Omit to include all statuses. Accepted values: `pending`, `accepted`, `rejected`, `cancelled`, `expired`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `email`, `createdAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve organizations invitations workspaces [#agentserve-organizations-invitations-workspaces] List Organization Invitation Workspaces (OAuth login or personal API key required) ```bash agentserve organizations invitations workspaces [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `invitationId` | Yes | Invitation identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--search ` | No | Case-insensitive substring match against the workspace name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `id`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve organizations invitations resend [#agentserve-organizations-invitations-resend] Resend Organization Invitation (OAuth login or personal API key required) ```bash agentserve organizations invitations resend [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `invitationId` | Yes | Invitation identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations invitations revoke [#agentserve-organizations-invitations-revoke] Revoke Organization Invitation (OAuth login or personal API key required) ```bash agentserve organizations invitations revoke [options] ``` **Arguments** | Argument | Required | Description | | -------------- | -------- | ---------------------- | | `invitationId` | Yes | Invitation identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve organizations sso providers delete [#agentserve-organizations-sso-providers-delete] Delete SSO Provider (OAuth login or personal API key required) ```bash agentserve organizations sso providers delete [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ----------------------------- | | `providerId` | Yes | Identity provider identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve organizations sso providers get [#agentserve-organizations-sso-providers-get] Get SSO Provider (OAuth login or personal API key required) ```bash agentserve organizations sso providers get [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ----------------------------- | | `providerId` | Yes | Identity provider identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations sso providers list [#agentserve-organizations-sso-providers-list] List SSO Providers (OAuth login or personal API key required) ```bash agentserve organizations sso providers list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `providerId`, `domain`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve organizations sso providers save [#agentserve-organizations-sso-providers-save] Save SSO Provider (OAuth login or personal API key required) ```bash agentserve organizations sso providers save [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--organization ` | Yes | Organization identifier. | | `--provider-type ` | Yes | oidc: Configure an OpenID Connect identity provider. saml: Configure a SAML identity provider. Accepted values: `oidc`, `saml`. | | `--provider-id ` | Yes | Globally unique provider ID; saving an existing provider replaces its supplied configuration. | | `--issuer ` | Yes | Identity provider issuer URL. | | `--domain ` | Yes | Email domain already verified by this organization. | | `--jit-provisioning-enabled` | No | Allow SSO sign-in to provision organization membership, subject to eligibility and available seats. | | `--no-jit-provisioning-enabled` | No | Send --jit-provisioning-enabled as false. | | `--mapping ` | No | Identity-provider claims mapped to user fields. (JSON, or @path / @- to read a file or stdin). | | `--client-id ` | No | Identity provider client identifier. Available when providerType is oidc. Required when providerType is oidc. | | `--client-secret ` | No | Write-only OIDC client secret; the redacted marker from providers get preserves an existing secret. Passing it inline exposes it to shell history and process listings. Required when --provider-type is oidc (@path / @- reads a file or stdin verbatim, including trailing newlines; @@value for a literal leading @). | | `--scopes ` | No | OIDC scopes; offline\_access is omitted. Available when providerType is oidc. (JSON, or @path / @- to read a file or stdin). | | `--pkce` | No | Use PKCE for the authorization flow. Available when providerType is oidc. | | `--no-pkce` | No | Send --pkce as false. | | `--authorization-endpoint ` | No | Optional authorization endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc. | | `--token-endpoint ` | No | Optional token endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc. | | `--user-info-endpoint ` | No | Optional UserInfo endpoint. Available when providerType is oidc. | | `--skip-user-info-endpoint` | No | Read identity claims from the ID token instead of calling UserInfo. Available when providerType is oidc. | | `--no-skip-user-info-endpoint` | No | Send --skip-user-info-endpoint as false. | | `--jwks-endpoint ` | No | Optional signing-key endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc. | | `--entry-point ` | No | Identity provider SAML sign-in endpoint. Available when providerType is saml. Required when providerType is saml. | | `--cert ` | No | Identity provider signing certificate. Available when providerType is saml. Required when providerType is saml. | | `--callback-url ` | No | SAML callback URL; defaults to this provider’s Agent Serve callback. Available when providerType is saml. | | `--audience ` | No | SAML audience; omission preserves the saved value. Available when providerType is saml. | | `--want-assertions-signed` | No | Require signed assertions; omission preserves the saved value. Available when providerType is saml. | | `--no-want-assertions-signed` | No | Send --want-assertions-signed as false. | | `--signature-algorithm ` | No | Signature algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml. | | `--digest-algorithm ` | No | Digest algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml. | | `--identifier-format ` | No | SAML NameID format; omission clears the saved value. Available when providerType is saml. | | `--idp-metadata ` | No | Identity provider metadata XML; omission clears the saved document. Available when providerType is saml. | ### agentserve organizations sso providers primary [#agentserve-organizations-sso-providers-primary] Set Primary SSO Provider (OAuth login or personal API key required) ```bash agentserve organizations sso providers primary [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ----------------------------- | | `providerId` | Yes | Identity provider identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations sso policy get [#agentserve-organizations-sso-policy-get] Get SSO Policy (OAuth login or personal API key required) ```bash agentserve organizations sso policy get [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations sso policy update [#agentserve-organizations-sso-policy-update] Update SSO Policy (OAuth login or personal API key required) ```bash agentserve organizations sso policy update [options] ``` **Options** | Option | Required | Description | | ----------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--require-sso ` | Yes | Require organization SSO on future sign-ins; existing sessions remain active. Accepted values: `true`, `false`. | ### agentserve organizations get [#agentserve-organizations-get] Get Organization (OAuth login or personal API key required) ```bash agentserve organizations get ``` **Arguments** | Argument | Required | Description | | ---------------- | -------- | ------------------------ | | `organizationId` | Yes | Organization identifier. | ### agentserve organizations members usage-limit get [#agentserve-organizations-members-usage-limit-get] Get Organization Member Credit Limit (OAuth login or personal API key required) ```bash agentserve organizations members usage-limit get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `userId` | Yes | User ID of an organization member or external collaborator with workspace access in this organization. Use List Organization Members or List Workspace Members to find it. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve organizations members usage-limit update [#agentserve-organizations-members-usage-limit-update] Update Organization Member Credit Limit (OAuth login or personal API key required) ```bash agentserve organizations members usage-limit update [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `userId` | Yes | User ID of an organization member or external collaborator with workspace access in this organization. Use List Organization Members or List Workspace Members to find it. | **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--credit-limit ` | Yes | Credit cap for this person. Send null to clear the cap or 0 to prevent further credit-consuming usage. Organization limits still apply. | ### agentserve organizations members list [#agentserve-organizations-members-list] List Organization Members (OAuth login or personal API key required) ```bash agentserve organizations members list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--search ` | No | Case-insensitive substring match against member name or email. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `email`, `joinedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve organizations members remove [#agentserve-organizations-members-remove] Remove Organization Member (OAuth login or personal API key required) ```bash agentserve organizations members remove [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------- | | `userId` | Yes | User identifier of the organization member. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve organizations members update [#agentserve-organizations-members-update] Update Organization Member (OAuth login or personal API key required) ```bash agentserve organizations members update [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------- | | `userId` | Yes | User identifier of the organization member. | **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--role ` | Yes | New organization role. Ownership transfers use a separate operation. Accepted values: `member`, `admin`. | ### agentserve organizations usage breakdown [#agentserve-organizations-usage-breakdown] Get Organization Usage Breakdown (OAuth login or personal API key required) ```bash agentserve organizations usage breakdown [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--preset ` | No | Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`. | | `--start-date ` | No | First calendar date included, in the selected timezone. Requires preset=custom. | | `--end-date ` | No | Last calendar date included, in the selected timezone. Requires preset=custom. | | `--timezone ` | No | IANA timezone for calendar boundaries; defaults to UTC. | | `--dimension ` | Yes | Usage grouping dimension. Accepted values: `member`, `workspace`, `workflow`, `model`, `byok`, `source`. | | `--limit ` | No | Maximum ranked groups to return. Remaining usage is summarized in other. Must be a whole number from 1 to 100. Defaults to 50. | ### agentserve organizations usage summary [#agentserve-organizations-usage-summary] Get Organization Usage Summary (OAuth login or personal API key required) ```bash agentserve organizations usage summary [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--preset ` | No | Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`. | | `--start-date ` | No | First calendar date included, in the selected timezone. Requires preset=custom. | | `--end-date ` | No | Last calendar date included, in the selected timezone. Requires preset=custom. | | `--timezone ` | No | IANA timezone for calendar boundaries; defaults to UTC. | ### agentserve organizations usage events [#agentserve-organizations-usage-events] List Organization Usage Events (OAuth login or personal API key required) ```bash agentserve organizations usage events [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--preset ` | No | Reporting window. Custom requires startDate and endDate and is capped at 92 days; other presets reject those bounds. Resolved billing windows are capped at 366 days. Accepted values: `current-period`, `previous-period`, `7d`, `30d`, `custom`. | | `--start-date ` | No | First calendar date included, in the selected timezone. Requires preset=custom. | | `--end-date ` | No | Last calendar date included, in the selected timezone. Requires preset=custom. | | `--timezone ` | No | IANA timezone for calendar boundaries; defaults to UTC. | | `--source ` | No | Restrict events to one product surface. Accepted values: `workflow`, `wand`, `agentserve-chat`, `mcp_copilot`, `mothership_block`, `knowledge-base`, `voice-input`, `enrichment`, `voice-output`, `api-tool`, `dataset-refresh`, `dataset-query`, `voice-mode`, `app-tool`, `app-build`, `app-ide`, `app-ai`, `slides`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `createdAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve organizations list [#agentserve-organizations-list] List Organizations (OAuth login or personal API key required) ```bash agentserve organizations list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the organization name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve organizations workspaces [#agentserve-organizations-workspaces] List Organization Workspaces (OAuth login or personal API key required) ```bash agentserve organizations workspaces [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--search ` | No | Case-insensitive substring match against the workspace name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `id`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## agentserve permission-groups [#agentserve-permission-groups] Also spelled `agentserve permission-group`. ### agentserve permission-groups members add [#agentserve-permission-groups-members-add] Add Permission Group Member (OAuth login or personal API key required) ```bash agentserve permission-groups members add [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------ | | `--organization ` | Yes | Organization identifier. | | `--group ` | Yes | Permission group identifier. | | `--user ` | Yes | Existing organization member to add. | ### agentserve permission-groups members batch-add [#agentserve-permission-groups-members-batch-add] Bulk Add Permission Group Members (OAuth login or personal API key required) ```bash agentserve permission-groups members batch-add [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--group ` | Yes | Permission group identifier. | | `--user ` | No | User IDs to add; cannot be combined with --all-members (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--all-members` | No | Add every current organization member; cannot be combined with --user. | ### agentserve permission-groups members list [#agentserve-permission-groups-members-list] List Permission Group Members (OAuth login or personal API key required) ```bash agentserve permission-groups members list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--group ` | Yes | Permission group identifier. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `assignedAt`, `userId`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve permission-groups members remove [#agentserve-permission-groups-members-remove] Remove Permission Group Member (OAuth login or personal API key required) ```bash agentserve permission-groups members remove [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------- | | `userId` | Yes | User identifier of the member to remove. | **Options** | Option | Required | Description | | ------------------------ | -------- | ---------------------------- | | `--organization ` | Yes | Organization identifier. | | `--group ` | Yes | Permission group identifier. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve permission-groups create [#agentserve-permission-groups-create] Create Permission Group (OAuth login or personal API key required) ```bash agentserve permission-groups create [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--name ` | Yes | Group name, unique within the organization. | | `--description ` | No | Optional group description. | | `--config ` | No | Group settings to set. Omitted keys use the default permission configuration. (JSON, or @path / @- to read a file or stdin). | | `--default` | No | Whether the group is the organization default. Only one group can be the default. | | `--no-default` | No | Send --default as false. | | `--workspace-ids ` | No | Workspace IDs targeted by a non-default group. Required when creating a non-default group; omit for a default group. (JSON, or @path / @- to read a file or stdin). | | `--applies-to-roles ` | No | Workspace roles a non-default group applies to. Empty applies it to every member of its workspaces; listed roles narrow it to members holding one of them. An explicit member assignment takes precedence over a role, and a role over a workspace-wide group. (JSON, or @path / @- to read a file or stdin). | ### agentserve permission-groups delete [#agentserve-permission-groups-delete] Delete Permission Group (OAuth login or personal API key required) ```bash agentserve permission-groups delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `groupId` | Yes | Permission group identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve permission-groups get [#agentserve-permission-groups-get] Get Permission Group (OAuth login or personal API key required) ```bash agentserve permission-groups get [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `groupId` | Yes | Permission group identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------ | | `--organization ` | Yes | Organization identifier. | ### agentserve permission-groups list [#agentserve-permission-groups-list] List Permission Groups (OAuth login or personal API key required) ```bash agentserve permission-groups list [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--search ` | No | Case-insensitive substring match against the group name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve permission-groups update [#agentserve-permission-groups-update] Update Permission Group (OAuth login or personal API key required) ```bash agentserve permission-groups update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `groupId` | Yes | Permission group identifier. | **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--organization ` | Yes | Organization identifier. | | `--name ` | No | Group name, unique within the organization. | | `--description ` | No | Group description. Null or an empty string clears it; omission leaves it unchanged. (--description null sends the word, not JSON null). | | `--config ` | No | Patch of group settings. Omitted keys remain unchanged; each supplied array replaces that entire list. (JSON, or @path / @- to read a file or stdin). | | `--default` | No | Whether the group is the organization default. Only one group can be the default. | | `--no-default` | No | Send --default as false. | | `--workspace-ids ` | No | Workspace identifiers for a non-default group. Required on creation; an empty update makes the group inactive. (JSON, or @path / @- to read a file or stdin). | | `--applies-to-roles ` | No | Workspace roles a non-default group applies to. Empty applies it to every member of its workspaces; listed roles narrow it to members holding one of them. An explicit member assignment takes precedence over a role, and a role over a workspace-wide group. (JSON, or @path / @- to read a file or stdin). | ## agentserve relays [#agentserve-relays] ### agentserve relays tasks create [#agentserve-relays-tasks-create] Assign Relay Task (OAuth login or personal API key required) ```bash agentserve relays tasks create [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------- | | `--relay ` | Yes | The Relay, by name (unique within the workspace). | | `--title ` | Yes | Short title of the task. | | `--objective ` | Yes | What the Relay should do. | | `--acceptance ` | No | How to tell the task is done. | ## agentserve sandboxes [#agentserve-sandboxes] Also spelled `agentserve sandbox`. ### agentserve sandboxes create [#agentserve-sandboxes-create] Create Sandbox (OAuth login or personal API key required) ```bash agentserve sandboxes create [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Display name, unique within the workspace; 1 to 64 characters. | | `--language ` | Yes | Dependency ecosystem: `javascript` installs from npm, `python` from PyPI. Accepted values: `javascript`, `python`. | | `--dependencies ` | No | Package specifiers installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | | `--cli-tools ` | No | Pinned managed CLI ids installed into the sandbox, at most 10, no duplicates. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--system-packages ` | No | Debian packages installed into the sandbox, one per entry. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | ### agentserve sandboxes delete [#agentserve-sandboxes-delete] Delete Sandbox (OAuth login or personal API key required) ```bash agentserve sandboxes delete [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `sandboxId` | Yes | Unique sandbox identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve sandboxes get [#agentserve-sandboxes-get] Get Sandbox ```bash agentserve sandboxes get ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `sandboxId` | Yes | Unique sandbox identifier. | ### agentserve sandboxes list [#agentserve-sandboxes-list] List Sandboxes ```bash agentserve sandboxes list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the sandbox name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve sandboxes update [#agentserve-sandboxes-update] Update Sandbox (OAuth login or personal API key required) ```bash agentserve sandboxes update [options] ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `sandboxId` | Yes | Unique sandbox identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | New display name, unique within the workspace; 1 to 64 characters. | | `--language ` | No | Replacement dependency ecosystem. The whole spec is revalidated against it, so a Python dependency list does not survive a switch to JavaScript. Accepted values: `javascript`, `python`. | | `--dependencies ` | No | Replacement package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | | `--cli-tools ` | No | Replacement managed CLI list; replaces the whole list. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--system-packages ` | No | Replacement Debian package list; replaces the whole list. (space-separated, or @path / @- with one value per line; in a file, blank lines and # comments are ignored, while inline values are sent as typed and may not be empty; @@value for a literal leading @). | ## agentserve secrets [#agentserve-secrets] Also spelled `agentserve secret`. ### agentserve secrets delete [#agentserve-secrets-delete] Delete Secret (OAuth login or personal API key required) ```bash agentserve secrets delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ----------------- | | `name` | Yes | Secret to delete. | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | Yes | Whether the secret belongs to the workspace or to the caller. A personal secret belongs to the caller across every workspace, not to one workspace. Accepted values: `workspace`, `personal`. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve secrets list [#agentserve-secrets-list] List Secrets (OAuth login or personal API key required) ```bash agentserve secrets list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Restrict results to one ownership scope. Accepted values: `workspace`, `personal`. | | `--search ` | No | Case-insensitive substring match against the secret name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve secrets set [#agentserve-secrets-set] Create or replace a named secret, such as an API key or environment variable (OAuth login or personal API key required) ```bash agentserve secrets set [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------------------------------- | | `name` | Yes | Secret name, as referenced in workflows | **Options** | Option | Required | Description | | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | Yes | Secret ownership scope. Accepted values: `workspace`, `personal`. | | `--value ` | No | Secret value. Passing it inline exposes it to shell history and process listings; @path reads it from a file and @- from stdin, verbatim — a trailing newline is part of the value, so write the file with printf rather than echo. Prefix a literal leading @ with a second one. | | `--description ` | No | What the secret is for, shown to teammates; workspace scope only. Omit to leave an existing description unchanged. | | `--unredacted` | No | Opt the workspace secret out of redaction: its value then appears in plaintext in run logs, model-visible content, and files, including publicly shared log links. Workspace scope only — sending it for a personal secret is rejected. Omit it to leave the current setting untouched. Pass --no-unredacted to restore redaction. | | `--no-unredacted` | No | Send --unredacted as false. | ## agentserve selectors [#agentserve-selectors] ### agentserve selectors get [#agentserve-selectors-get] Get Selector Option (OAuth login or personal API key required) ```bash agentserve selectors get [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--selector-key ` | Yes | Registered selector key for discovering this field’s destination options. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.databases`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `agentserve.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`, `providers.openrouterImageModels`, `providers.openrouterVideoModels`, `providers.openrouterSpeechModels`, `providers.openrouterMusicModels`, `providers.openrouterMediaAspectRatios`, `providers.openrouterMediaResolutions`, `providers.openrouterMediaDurations`, `providers.openrouterSpeechVoices`, `providers.openrouterTranscriptionModels`, `decisions.models`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. (JSON, or @path / @- to read a file or stdin). | | `--id ` | Yes | Resource identifier. | ### agentserve selectors list [#agentserve-selectors-list] List Selector Options (OAuth login or personal API key required) ```bash agentserve selectors list [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--selector-key ` | Yes | Registered selector key for discovering this field’s destination options. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.databases`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `agentserve.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`, `providers.openrouterImageModels`, `providers.openrouterVideoModels`, `providers.openrouterSpeechModels`, `providers.openrouterMusicModels`, `providers.openrouterMediaAspectRatios`, `providers.openrouterMediaResolutions`, `providers.openrouterMediaDurations`, `providers.openrouterSpeechVoices`, `providers.openrouterTranscriptionModels`, `decisions.models`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. (JSON, or @path / @- to read a file or stdin). | | `--search ` | No | Provider option search text. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | ## agentserve semantic-model [#agentserve-semantic-model] ### agentserve semantic-model query [#agentserve-semantic-model-query] Query Semantic Model (OAuth login or personal API key required) ```bash agentserve semantic-model query [options] ``` **Options** | Option | Required | Description | | ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--source ` | No | Which model to query. Omit it to query the model you read in the app: your draft while draft mode is on, otherwise the published model. Accepted values: `published`, `draft`. | | `--measures ` | Yes | Measures to compute. (JSON, or @path / @- to read a file or stdin). | | `--dimensions ` | No | Attributes to group by. (JSON, or @path / @- to read a file or stdin). | | `--where ` | No | Equality conditions keyed by `entity.attribute`, all of which must hold. (JSON, or @path / @- to read a file or stdin). | | `--sort ` | No | Sort order of the result rows. (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Most rows to return. Defaults to 100. | ## agentserve skills [#agentserve-skills] Also spelled `agentserve skill`. ### agentserve skills create [#agentserve-skills-create] Create Skill (OAuth login or personal API key required) ```bash agentserve skills create [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ---------------------------------------------------------------------------------- | | `--name ` | Yes | Kebab-case name, unique within the workspace and not reserved by a built-in skill. | | `--description ` | Yes | One-line summary of when the skill applies. | | `--content ` | Yes | Skill body containing the instructions given to the agent. | ### agentserve skills delete [#agentserve-skills-delete] Delete Skill (OAuth login or personal API key required) ```bash agentserve skills delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve skills get [#agentserve-skills-get] Get Skill ```bash agentserve skills get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | ### agentserve skills editors create [#agentserve-skills-editors-create] Grant Skill Editor (OAuth login or personal API key required) ```bash agentserve skills editors create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------------- | -------- | -------------------------------------------- | | `--email ` | Yes | Email address of a current workspace member. | ### agentserve skills editors list [#agentserve-skills-editors-list] List Skill Editors ```bash agentserve skills editors list [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `email`, `name`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve skills editors delete [#agentserve-skills-editors-delete] Revoke Skill Editor (OAuth login or personal API key required) ```bash agentserve skills editors delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------------- | -------- | -------------------------------------------- | | `--email ` | Yes | Email address of a current workspace member. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve skills list [#agentserve-skills-list] List Skills ```bash agentserve skills list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the skill name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve skills update [#agentserve-skills-update] Update Skill (OAuth login or personal API key required) ```bash agentserve skills update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `skillId` | Yes | Unique skill identifier. A built-in skill is `builtin-` followed by its name, for example `builtin-research`. | **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------------------------- | | `--name ` | No | New kebab-case skill name. | | `--description ` | No | New one-line summary of when the skill applies. | | `--content ` | No | Replacement skill body. | ## agentserve slides [#agentserve-slides] ### agentserve slides export [#agentserve-slides-export] Export Presentation ```bash agentserve slides export [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------- | | `docId` | Yes | The deck to export. | **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------------- | | `--format ` | Yes | `pptx` for PowerPoint, `pdf` for a PDF of the slides. Accepted values: `pptx`, `pdf`. | ### agentserve slides jobs get [#agentserve-slides-jobs-get] Get Slides Job ```bash agentserve slides jobs get ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------- | | `jobId` | Yes | Job identifier. | ### agentserve slides templates list [#agentserve-slides-templates-list] List Slides Templates ```bash agentserve slides templates list ``` ### agentserve slides presentations create [#agentserve-slides-presentations-create] Start Presentation (OAuth login or personal API key required) ```bash agentserve slides presentations create [options] ``` **Options** | Option | Required | Description | | -------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--space-id ` | Yes | Space the new deck is created in. | | `--title ` | Yes | Title of the new deck. | | `--content ` | Yes | What the deck should say: the audience, the story and the facts to use. | | `--n-slides ` | No | How many slides to write. The Slides AI decides when omitted. | | `--template-id ` | No | Template to lay the deck out with, from List Slides Templates. Default `general`. | | `--language ` | No | Language to write the slides in, for example `English` or `Deutsch`. | | `--tone ` | No | Tone of the writing, for example `formal` or `casual`. | | `--instructions ` | No | Further instructions for the Slides AI. | | `--file-ids ` | No | Workspace files whose text the deck should draw on. Upload them with the Files operations first; you need read access to each. (JSON, or @path / @- to read a file or stdin). | | `--export ` | No | Also export the finished deck to a file saved in the workspace Files. `none` skips the export. Accepted values: `pptx`, `pdf`, `none`. | ## agentserve spaces [#agentserve-spaces] ### agentserve spaces docs get [#agentserve-spaces-docs-get] Get Space Doc ```bash agentserve spaces docs get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------- | | `spaceId` | Yes | Space identifier. | | `docId` | Yes | Doc identifier. | ### agentserve spaces docs list [#agentserve-spaces-docs-list] List Space Docs ```bash agentserve spaces docs list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------- | | `spaceId` | Yes | Space identifier. | ### agentserve spaces list [#agentserve-spaces-list] List Spaces ```bash agentserve spaces list ``` ## agentserve tables [#agentserve-tables] Also spelled `agentserve table`. ### agentserve tables columns create [#agentserve-tables-columns-create] Add Column ```bash agentserve tables columns create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------ | | `--column ` | Yes | Column definition to add. (JSON, or @path / @- to read a file or stdin). | ### agentserve tables columns delete [#agentserve-tables-columns-delete] Delete Column ```bash agentserve tables columns delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------- | | `--column-name ` | Yes | Name of the column to delete. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables columns update [#agentserve-tables-columns-update] Update Column ```bash agentserve tables columns update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------- | | `--column-name ` | Yes | Current name of the column to update. | | `--updates ` | Yes | Mutable column fields. (JSON, or @path / @- to read a file or stdin). | ### agentserve tables groups create [#agentserve-tables-groups-create] Add Workflow Group ```bash agentserve tables groups create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | -------------------------------- | -------- | ------------------------------------------------------------------------------------------ | | `--group ` | Yes | Workflow or enrichment producer definition. (JSON, or @path / @- to read a file or stdin). | | `--output-columns ` | Yes | Columns created for producer outputs. (JSON, or @path / @- to read a file or stdin). | | `--auto-run` | No | Whether to schedule existing rows after group creation. | | `--no-auto-run` | No | Send --auto-run as false. | ### agentserve tables groups delete [#agentserve-tables-groups-delete] Delete Workflow Group ```bash agentserve tables groups delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | -------------------- | -------- | ------------------------- | | `--group-id ` | Yes | Workflow group to delete. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables groups list [#agentserve-tables-groups-list] List Workflow Groups ```bash agentserve tables groups list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### agentserve tables groups update [#agentserve-tables-groups-update] Update Workflow Group ```bash agentserve tables groups update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--group-id ` | Yes | Workflow group to update. | | `--workflow-id ` | No | Replacement backing workflow identifier. | | `--name ` | No | Replacement workflow-group display name. | | `--dependencies ` | No | Replacement input dependencies. (JSON, or @path / @- to read a file or stdin). | | `--outputs ` | No | Replacement producer outputs. (JSON, or @path / @- to read a file or stdin). | | `--new-output-columns ` | No | Columns to add for new outputs. (JSON, or @path / @- to read a file or stdin). | | `--mapping-updates ` | No | Existing output-column mapping changes. (JSON, or @path / @- to read a file or stdin). | | `--input-mappings ` | No | Replacement workflow input mappings. (JSON, or @path / @- to read a file or stdin). | | `--deployment-mode ` | No | Replacement workflow execution mode. Accepted values: `live`, `deployed`. | | `--type ` | No | Workflow-group producer type. Must match the group's stored type — a group's producer cannot be changed after creation. Accepted values: `manual`, `enrichment`. | | `--auto-run` | No | Replacement automatic-run setting. | | `--no-auto-run` | No | Send --auto-run as false. | ### agentserve tables batch-delete [#agentserve-tables-batch-delete] Bulk Delete Tables and Folders ```bash agentserve tables batch-delete [options] ``` **Options** | Option | Required | Description | | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `--table-ids ` | No | Tables to archive, by identifier. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables rows update-each [#agentserve-tables-rows-update-each] Apply a distinct patch to each listed row ```bash agentserve tables rows update-each [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------- | | `--updates ` | Yes | One merge patch per row. Each row identifier may appear at most once. (JSON, or @path / @- to read a file or stdin). | ### agentserve tables rows create [#agentserve-tables-rows-create] Create Rows ```bash agentserve tables rows create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------- | | `--data ` | No | One row keyed by column name (JSON, or @path / @-; choose exactly one body flag). | | `--rows ` | No | Several rows keyed by column name (JSON, or @path / @-; choose exactly one body flag). | ### agentserve tables rows delete [#agentserve-tables-rows-delete] Delete Row ```bash agentserve tables rows delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables rows batch-delete [#agentserve-tables-rows-batch-delete] Delete rows matching a filter, or an explicit list of ids ```bash agentserve tables rows batch-delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Maximum matching rows to delete. (caps a --filter match only; omit it to act on every match, and note 0 is not accepted). | | `--row ` | No | Explicit row identifiers to delete. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables rows get [#agentserve-tables-rows-get] Get Row ```bash agentserve tables rows get [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------- | | `--include-run-state` | No | Include per-workflow-group run state on the returned row. Off by default. | | `--no-include-run-state` | No | Send --include-run-state as false. | ### agentserve tables rows list [#agentserve-tables-rows-list] List Rows ```bash agentserve tables rows list [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--include-run-state` | No | Include per-workflow-group run state on every returned row. Off by default: run state is a separate sidecar read and its `blockErrors` are unbounded, so a full page carries it only when asked. Caps `limit` at 200. | | `--no-include-run-state` | No | Send --include-run-state as false. | ### agentserve tables rows query [#agentserve-tables-rows-query] Query rows with a filter and sort ```bash agentserve tables rows query [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--filter ` | No | Condition: \{"field":"status","op":"eq","value":"active"}. Groups: \{"all":\[\{"field":"status","op":"eq","value":"active"}]} or \{"any":\[\{"field":"status","op":"eq","value":"active"}]}; group entries may also be nested groups. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--sort ` | No | Ordered sort keys: \[\{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--include-run-state` | No | Include per-workflow-group run state on every returned row. Off by default: run state is a separate sidecar read and its `blockErrors` are unbounded, so a full page carries it only when asked. Incompatible with `limit: 0`, and caps `limit` at 200. | | `--no-include-run-state` | No | Send --include-run-state as false. | ### agentserve tables rows count [#agentserve-tables-rows-count] Count rows matching a filter ```bash agentserve tables rows count [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--filter ` | No | Condition: \{"field":"status","op":"eq","value":"active"}. Groups: \{"all":\[\{"field":"status","op":"eq","value":"active"}]} or \{"any":\[\{"field":"status","op":"eq","value":"active"}]}; group entries may also be nested groups. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | ### agentserve tables rows enrich [#agentserve-tables-rows-enrich] Run one row’s enrichment group ```bash agentserve tables rows enrich ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------ | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | | `groupId` | Yes | Workflow or enrichment group to run. | ### agentserve tables rows search [#agentserve-tables-rows-search] Search cells for a value and return their coordinates ```bash agentserve tables rows search [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--query ` | Yes | Value to search for. | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--sort ` | No | Ordered sort keys: \[\{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin). | ### agentserve tables rows batch-update [#agentserve-tables-rows-batch-update] Update every row matching a filter ```bash agentserve tables rows batch-update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--filter ` | Yes | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--data ` | Yes | Row-data patch applied to every matching row. (JSON, or @path / @- to read a file or stdin). | | `--limit ` | No | Maximum matching rows to update. (caps a --filter match only; omit it to act on every match, and note 0 is not accepted). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables rows update [#agentserve-tables-rows-update] Update Row ```bash agentserve tables rows update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------- | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------- | | `--data ` | Yes | Partial row-data patch keyed by column name. (JSON, or @path / @- to read a file or stdin). | ### agentserve tables dispatches cancel [#agentserve-tables-dispatches-cancel] Cancel a running dispatch ```bash agentserve tables dispatches cancel [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ------------------------------------- | | `tableId` | Yes | Unique table identifier. | | `dispatchId` | Yes | Unique table run-dispatch identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables dispatches create [#agentserve-tables-dispatches-create] Start a column or enrichment run ```bash agentserve tables dispatches create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--group-ids ` | Yes | Workflow or enrichment groups to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--run-mode ` | No | Whether to run all or only incomplete cells. Accepted values: `all`, `incomplete`. | | `--row-ids ` | No | Explicit row subset to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--exclude-row-ids ` | No | Rows excluded from a select-all run scope. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--max-rows ` | No | Stop after this many eligible rows have run (1-1,000,000). Omit for an unbounded run. | ### agentserve tables dispatches get [#agentserve-tables-dispatches-get] Get Run Dispatch ```bash agentserve tables dispatches get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ------------------------------------- | | `tableId` | Yes | Unique table identifier. | | `dispatchId` | Yes | Unique table run-dispatch identifier. | ### agentserve tables dispatches list [#agentserve-tables-dispatches-list] List Active Run Dispatches ```bash agentserve tables dispatches list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### agentserve tables exports cancel [#agentserve-tables-exports-cancel] Stop a running export ```bash agentserve tables exports cancel ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `tableId` | Yes | Unique table identifier. | | `exportId` | Yes | Unique table-export identifier. | ### agentserve tables exports create [#agentserve-tables-exports-create] Create Table Export ```bash agentserve tables exports create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | --------------------------------------------------- | | `--format ` | No | Export file format. Accepted values: `csv`, `json`. | ### agentserve tables exports get [#agentserve-tables-exports-get] Get Table Export ```bash agentserve tables exports get ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `tableId` | Yes | Unique table identifier. | | `exportId` | Yes | Unique table-export identifier. | ### agentserve tables exports download [#agentserve-tables-exports-download] Get the download URL for a finished export ```bash agentserve tables exports download ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `tableId` | Yes | Unique table identifier. | | `exportId` | Yes | Unique table-export identifier. | ### agentserve tables imports cancel [#agentserve-tables-imports-cancel] Stop a running import ```bash agentserve tables imports cancel [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `importId` | Yes | Unique table-import identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables imports get [#agentserve-tables-imports-get] Get Table Import ```bash agentserve tables imports get ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | ------------------------------- | | `importId` | Yes | Unique table-import identifier. | ### agentserve tables cancel-runs [#agentserve-tables-cancel-runs] Stop every running column job ```bash agentserve tables cancel-runs [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | Yes | Whether to cancel across the table or one row. Accepted values: `all`, `row`. | | `--row-id ` | No | Row whose runs should be canceled for row scope. | | `--filter ` | No | Predicate: \{"all":\[\{"field":"status","op":"eq","value":"active"}]}; groups use all/any. Operators: eq, ne, gt, gte, lt, lte, in, nin, contains, ncontains, startsWith, endsWith, like, ilike, nlike, nilike, isEmpty, isNotEmpty, isNull, isNotNull (JSON, or @path / @- to read a file or stdin). | | `--exclude-row-ids ` | No | Rows excluded from an all-scope cancellation. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables create [#agentserve-tables-create] Create Table ```bash agentserve tables create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Identifier: letters, numbers, and underscores; cannot start with a number. | | `--description ` | No | Optional table description. | | `--schema ` | Yes | Table schema: \{"columns":\[\{"name":"email","type":"string"}]} (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### agentserve tables folders create [#agentserve-tables-folders-create] Create a table folder at a path ```bash agentserve tables folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve tables folders delete [#agentserve-tables-folders-delete] Delete Folder ```bash agentserve tables folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables folders list [#agentserve-tables-folders-list] List table folders ```bash agentserve tables folders list [options] ``` Also available as `agentserve tables folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve tables folders move [#agentserve-tables-folders-move] Rename or move a table folder ```bash agentserve tables folders move ``` Also available as `agentserve tables folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | | `destination` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve tables folders restore [#agentserve-tables-folders-restore] Restore an archived table folder ```bash agentserve tables folders restore ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve tables views create [#agentserve-tables-views-create] Create View ```bash agentserve tables views create [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ------------------------ | -------- | --------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Saved-view display name. | | `--config ` | Yes | Saved filter, sort, and column-layout configuration. (JSON, or @path / @- to read a file or stdin). | ### agentserve tables views delete [#agentserve-tables-views-delete] Delete View ```bash agentserve tables views delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------------- | | `tableId` | Yes | Unique table identifier. | | `viewId` | Yes | Unique saved-view identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables views get [#agentserve-tables-views-get] Get View ```bash agentserve tables views get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------------- | | `tableId` | Yes | Unique table identifier. | | `viewId` | Yes | Unique saved-view identifier. | ### agentserve tables views list [#agentserve-tables-views-list] List Views ```bash agentserve tables views list ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### agentserve tables views update [#agentserve-tables-views-update] Update View ```bash agentserve tables views update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ----------------------------- | | `tableId` | Yes | Unique table identifier. | | `viewId` | Yes | Unique saved-view identifier. | **Options** | Option | Required | Description | | ------------------------------ | -------- | ------------------------------------------------------------------------------------------------ | | `--name ` | No | Replacement saved-view display name. | | `--config ` | No | Complete replacement saved-view configuration. (JSON, or @path / @- to read a file or stdin). | | `--config-patch ` | No | Saved-view configuration fields to shallow-merge. (JSON, or @path / @- to read a file or stdin). | | `--default` | No | Whether to promote this view to the table default. | | `--no-default` | No | Send --default as false. | ### agentserve tables delete [#agentserve-tables-delete] Delete Table ```bash agentserve tables delete [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve tables enrichment get [#agentserve-tables-enrichment-get] Get Enrichment Run Detail ```bash agentserve tables enrichment get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------------------ | | `tableId` | Yes | Unique table identifier. | | `rowId` | Yes | Unique table row identifier. | | `groupId` | Yes | Workflow or enrichment group to run. | ### agentserve tables get [#agentserve-tables-get] Get Table ```bash agentserve tables get ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### agentserve tables list [#agentserve-tables-list] List Tables ```bash agentserve tables list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Which lifecycle set to list: `active` (default) for live tables, `archived` for tables a delete archived and a table restore can bring back. `folderPath` resolves against active folders only, so pairing it with `scope=archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--search ` | No | Case-insensitive substring match against the resource name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve tables move [#agentserve-tables-move] Move Tables and Folders ```bash agentserve tables move [options] ``` **Options** | Option | Required | Description | | --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--table-ids ` | No | Tables to move, by identifier. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Table folders to move, by path as shown in the app; the leading / is optional (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--to ` | No | Destination folder path; omit for root. | ### agentserve tables restore [#agentserve-tables-restore] Restore an archived table ```bash agentserve tables restore ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | ### agentserve tables update [#agentserve-tables-update] Update Table ```bash agentserve tables update [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------- | | `--name ` | No | Identifier: letters, numbers, and underscores; cannot start with a number. | | `--description ` | No | Replacement table description, or null to clear it. (--description null sends the word, not JSON null). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### agentserve tables mv [#agentserve-tables-mv] Move a table to a folder ```bash agentserve tables mv ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ---------------------------------------------------------- | | `tableId` | Yes | Unique table identifier. | | `folder` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve tables upsert [#agentserve-tables-upsert] Insert a row, or update the one that conflicts on a unique column ```bash agentserve tables upsert [options] ``` **Arguments** | Argument | Required | Description | | --------- | -------- | ------------------------ | | `tableId` | Yes | Unique table identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--data ` | Yes | Complete set of row cells keyed by column name. On the update branch this REPLACES the matched row: any column not present here is cleared, unlike a single-row update, which merges. (JSON, or @path / @- to read a file or stdin). | | `--on ` | No | Unique column to resolve the conflict against. | ### agentserve tables import [#agentserve-tables-import] Import a CSV, into a new table by default ```bash agentserve tables import [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | --------------------------------------------------- | | `path` | No | Local CSV file to import; omit when using --file-id | **Options** | Option | Required | Description | | -------------------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | `--name ` | No | Identifier for the new table: letters, numbers, and underscores; defaults to the sanitized file name. | | `--table-id ` | No | Import into this existing table instead of creating one. | | `--mode ` | No | How to write into --table-id (default: append). Accepted values: `append`, `replace`. | | `--folder ` | No | Folder path for the new table, as shown in the app. | | `--file-id ` | No | Import a file already in the workspace instead of a local path. | | `--mapping ` | No | Column mapping (--table-id only). | | `--create-columns ` | No | Columns to create (--table-id only). | | `--timezone ` | No | Timezone for date parsing, e.g. America/New\_York. | | `-y, --yes` | No | Confirm this destructive operation (required with --mode replace). | | `--no-wait` | No | Return once the import is queued instead of watching it. | ### agentserve tables ls [#agentserve-tables-ls] List table resources and child folders together ```bash agentserve tables ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### agentserve tables mkdir [#agentserve-tables-mkdir] Create a table directory at a path ```bash agentserve tables mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## agentserve tools [#agentserve-tools] ### agentserve tools execute [#agentserve-tools-execute] Run one built-in tool and print what it produced (OAuth login or personal API key required) ```bash agentserve tools execute [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `toolId` | Yes | Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id. | **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `--input ` | No | Tool arguments as JSON, keyed by the parameter ids `agentserve tools get <toolId>` lists (JSON, or @path / @- to read a file or stdin). | | `--credential-id ` | No | Credential to authenticate with, required for OAuth tools. | | `--timeout ` | No | Seconds to wait before abandoning the call. | ### agentserve tools get [#agentserve-tools-get] Get Tool ```bash agentserve tools get ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------------------------------------------------------------------- | | `toolId` | Yes | Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id. | ### agentserve tools list [#agentserve-tools-list] List Tools ```bash agentserve tools list [options] ``` **Options** | Option | Required | Description | | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--search ` | No | Case-insensitive substring match against the tool id, name, and description. | | `--hosted-api-key ` | No | Restrict to tools by how their API key is supplied. Accepted values: `always`, `conditional`, `none`. | | `--oauth-provider ` | No | Restrict to tools that authenticate against this OAuth service. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `id`, `name`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ## agentserve workflow-mcp-servers [#agentserve-workflow-mcp-servers] ### agentserve workflow-mcp-servers create [#agentserve-workflow-mcp-servers-create] Create Workflow MCP Server (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers create [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Server display name, shown to connecting MCP clients. | | `--description ` | No | Optional server description. | | `--is-public` | No | Whether the server answers MCP clients without an Agent Serve API key. Defaults to false — a public server executes the workflows it publishes for anyone holding its URL. | | `--no-is-public` | No | Send --is-public as false. | | `--workflow ` | No | Deployed workflows to publish as tools on the new server. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | ### agentserve workflow-mcp-servers delete [#agentserve-workflow-mcp-servers-delete] Delete Workflow MCP Server (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers delete [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflow-mcp-servers tools create [#agentserve-workflow-mcp-servers-tools-create] Publish Workflow As MCP Tool (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers tools create [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | **Options** | Option | Required | Description | | ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow-id ` | Yes | Deployed workflow to publish. The workflow must already be deployed. | | `--tool-name ` | No | Name MCP clients call. Normalized to the MCP tool-name grammar, and derived from the workflow name when omitted. | | `--tool-description ` | No | Description shown to MCP clients. Derived from the workflow name when omitted. | | `--parameter-descriptions ` | No | Per-field description overrides applied to the schema generated from the deployed workflow inputs, as \[\{"name":"email","description":"Customer email address"}]. A name matching no input field is ignored (JSON, or @path / @- to read a file or stdin). | ### agentserve workflow-mcp-servers tools list [#agentserve-workflow-mcp-servers-tools-list] List Workflow MCP Tools (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers tools list ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | ### agentserve workflow-mcp-servers tools delete [#agentserve-workflow-mcp-servers-tools-delete] Unpublish Workflow MCP Tool (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers tools delete [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | -------------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | | `workflowId` | Yes | Workflow published as a tool on this server. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflow-mcp-servers get [#agentserve-workflow-mcp-servers-get] Get Workflow MCP Server (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers get ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | ### agentserve workflow-mcp-servers list [#agentserve-workflow-mcp-servers-list] List Workflow MCP Servers (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve workflow-mcp-servers update [#agentserve-workflow-mcp-servers-update] Update Workflow MCP Server (OAuth login or personal API key required) ```bash agentserve workflow-mcp-servers update [options] ``` **Arguments** | Argument | Required | Description | | ---------- | -------- | -------------------------------------- | | `serverId` | Yes | Unique workflow-MCP server identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------ | | `--name ` | No | Server display name, shown to connecting MCP clients. | | `--description ` | No | New server description, or null to clear it. (--description null sends the word, not JSON null). | | `--is-public` | No | Whether the server answers MCP clients without an Agent Serve API key. | | `--no-is-public` | No | Send --is-public as false. | ## agentserve workflows [#agentserve-workflows] Also spelled `agentserve workflow`. ### agentserve workflows activate create [#agentserve-workflows-activate-create] Activate Workflow Version (OAuth login or personal API key required) ```bash agentserve workflows activate create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows operations apply [#agentserve-workflows-operations-apply] Edit a workflow’s blocks, connections and settings with a batch of operations (OAuth login or personal API key required) ```bash agentserve workflows operations apply [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--dry-run` | No | Validate and lint without persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified. | | `--no-dry-run` | No | Send --dry-run as false. | | `--operations ` | Yes | Edits to apply, in a single batch, keyed by operation\_type: \[\{"operation\_type":"add","block\_id":"my-fn","params":\{"type":"function","name":"My Fn","inputs":\{"code":"return \{ok:true}"}}},\{"operation\_type":"edit","block\_id":"\","params":\{"name":"Renamed","connections":\{"success":"my-fn"}}},\{"operation\_type":"delete","block\_id":"\"}]. Also extract\_from\_subflow, whose params carry \{"subflowId":"\"}, and insert\_into\_subflow, which creates a block and so takes an add’s params plus that subflowId (JSON, or @path / @- to read a file or stdin). | | `--atomic` | No | Fail the whole batch when any operation is declined or any block input would be dropped. The default applies what it can and reports the rest in `skipped` and `inputValidationErrors`; `true` writes nothing and answers `409` instead. | | `--no-atomic` | No | Send --atomic as false. | | `--layout ` | No | Whether to reposition blocks the batch touched. `targeted` (default) nudges only the affected subgraph; `none` leaves every position exactly as supplied. Accepted values: `targeted`, `none`. | | `--set-block-enabled ` | No | Blocks to enable or disable, applied after --operations: \[\{"block\_id":"\","enabled":false}]. Disabling a loop or parallel cascades to its unlocked descendants; enabling a block whose container is disabled is declined (JSON, or @path / @- to read a file or stdin). | | `-y, --yes` | No | Confirm this operation (required unless --dry-run). | ### agentserve workflows variables update [#agentserve-workflows-variables-update] Update Workflow Variables ```bash agentserve workflows variables update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--operations ` | Yes | Variable changes to apply in order, keyed by operation: \[\{"operation":"add","name":"my\_var","type":"string","value":"hello"},\{"operation":"edit","name":"my\_var","value":"updated"},\{"operation":"delete","name":"my\_var"}] (JSON, or @path / @- to read a file or stdin). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows runs cancel [#agentserve-workflows-runs-cancel] Cancel a running workflow run ```bash agentserve workflows runs cancel [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | ------------ | | `--workflow ` | Yes | Workflow ID. | ### agentserve workflows runs get [#agentserve-workflows-runs-get] Show run status (requested outputs are included in JSON or YAML output) ```bash agentserve workflows runs get [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ---------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--include-output` | No | Include the final output in JSON or YAML output. | | `--select-output ` | No | Include blockId or blockId.path values in JSON or YAML output; block names are not resolved on a finished run (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--include-file-base64` | No | Inline each produced file's bytes as base64. Requires `includeOutput`. A file above the inline ceiling answers `413` naming its download path; fetch large files from `downloadPath` instead. | | `--no-include-file-base64` | No | Send --include-file-base64 as false. | | `--base64-max-bytes ` | No | Per-file inline ceiling, lowering but never raising the server limit of 16 MiB. | ### agentserve workflows runs list [#agentserve-workflows-runs-list] List runs for a workflow ```bash agentserve workflows runs list [options] ``` **Options** | Option | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--status ` | No | Filter by run status. Accepted values: `pending`, `running`, `completed`, `failed`, `cancelled`, `paused`. | | `--trigger ` | No | Filter by trigger type. | | `--start-date ` | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--end-date ` | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. `2026-08-06T00:00:00Z`. A date without a time, or a timestamp carrying a UTC offset instead of `Z`, is rejected, as is year `0000`, which names no storable instant. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--order ` | No | Sort direction by run start time. This list is sortable only by run start time, so it takes `order` in place of `sortBy`/`sortOrder`, which it rejects. Accepted values: `asc`, `desc`. | ### agentserve workflows runs resume [#agentserve-workflows-runs-resume] Resume a paused run (output is included in JSON or YAML output) ```bash agentserve workflows runs resume [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | ------------------------- | -------- | ------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--context ` | Yes | Pause context ID returned by run status. | | `--input ` | No | Resume input as JSON (JSON, or @path / @- to read a file or stdin). | ### agentserve workflows runs wait [#agentserve-workflows-runs-wait] Wait for a run to reach a terminal state, then show it ```bash agentserve workflows runs wait [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------- | | `runId` | Yes | Unique workflow run identifier. | **Options** | Option | Required | Description | | -------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow ID. | | `--wait-timeout ` | No | Give up after this many seconds, or 0 to wait indefinitely (default: 3600). Bounds the whole wait; AGENT\_SERVE\_TIMEOUT\_SECONDS bounds one request. | ### agentserve workflows versions compare [#agentserve-workflows-versions-compare] Compare Workflow Versions ```bash agentserve workflows versions compare [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------- | | `--base ` | Yes | Deployment version to compare from. | | `--target ` | Yes | Deployment version to compare to, in the same workflow. | ### agentserve workflows versions get [#agentserve-workflows-versions-get] Get Workflow Version ```bash agentserve workflows versions get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version. | ### agentserve workflows versions list [#agentserve-workflows-versions-list] List Workflow Versions ```bash agentserve workflows versions list [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | -------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve workflows versions update [#agentserve-workflows-versions-update] Update Workflow Version ```bash agentserve workflows versions update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version. | **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | New label for the deployment version. | | `--description ` | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). | ### agentserve workflows create [#agentserve-workflows-create] Create Workflow ```bash agentserve workflows create [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------------------- | | `--name ` | Yes | Workflow name. | | `--description ` | No | Optional workflow description. | | `--folder ` | No | Existing folder path (leading / optional); create it first with agentserve workflows mkdir \. | ### agentserve workflows folders create [#agentserve-workflows-folders-create] Create a workflow folder at a path ```bash agentserve workflows folders create ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve workflows folders delete [#agentserve-workflows-folders-delete] Delete Workflow Folder ```bash agentserve workflows folders delete [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | **Options** | Option | Required | Description | | ------------- | -------- | -------------------------------------- | | `--recursive` | No | Delete the folder and its descendants. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows folders list [#agentserve-workflows-folders-list] List workflow folders ```bash agentserve workflows folders list [options] ``` Also available as `agentserve workflows folders ls`. **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--parent ` | No | Direct parent folder path. | | `--search ` | No | Case-insensitive substring match against the folder name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve workflows folders move [#agentserve-workflows-folders-move] Rename or move a workflow folder ```bash agentserve workflows folders move ``` Also available as `agentserve workflows folders mv`. **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------------- | | `path` | Yes | Folder path as shown in the app; the leading / is optional | | `destination` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve workflows delete [#agentserve-workflows-delete] Delete Workflow ```bash agentserve workflows delete [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows chat unpublish [#agentserve-workflows-chat-unpublish] Take a workflow’s chat deployment offline (OAuth login or personal API key required) ```bash agentserve workflows chat unpublish [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows chat status [#agentserve-workflows-chat-status] Show a workflow’s chat deployment (OAuth login or personal API key required) ```bash agentserve workflows chat status ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### agentserve workflows chat publish [#agentserve-workflows-chat-publish] Publish or replace a workflow’s chat deployment (OAuth login or personal API key required) ```bash agentserve workflows chat publish [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--identifier ` | Yes | URL slug the deployed chat answers on. Must be free across live deployments. | | `--title ` | Yes | Title shown to visitors. | | `--description ` | No | Description shown to visitors. Omitted clears it. | | `--customizations ` | No | Presentation overrides. Omitted fields take platform defaults. (JSON, or @path / @- to read a file or stdin). | | `--auth-type ` | No | How visitors are gated. `public` leaves the chat open to anyone holding the URL. Accepted values: `public`, `password`, `email`, `sso`. | | `--password ` | No | Write-only password. Required whenever `authType` is `password`, and rejected otherwise. Never readable back. | | `--allowed-emails ` | No | Email addresses or domains admitted under `email` and `sso` gating. At least one is required for those modes. (JSON, or @path / @- to read a file or stdin). | | `--output-configs ` | No | Block outputs to surface to visitors. Omitted surfaces none. (JSON, or @path / @- to read a file or stdin). | | `--include-thinking` | No | Allow visitors to receive provider thinking events. | | `--no-include-thinking` | No | Send --include-thinking as false. | | `--include-tool-calls` | No | Allow visitors to receive tool lifecycle events. | | `--no-include-tool-calls` | No | Send --include-tool-calls as false. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows deploy [#agentserve-workflows-deploy] Deploy Workflow (OAuth login or personal API key required) ```bash agentserve workflows deploy [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------- | | `--name ` | No | Optional label for the deployment version. | | `--description ` | No | Optional release note for the deployment version. | ### agentserve workflows duplicate create [#agentserve-workflows-duplicate-create] Duplicate Workflow ```bash agentserve workflows duplicate create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------ | -------- | ------------------------------------------------------------------------------- | | `--name ` | No | Name for the copy. Defaults to the source name, deduplicated within the folder. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### agentserve workflows run [#agentserve-workflows-run] Run a deployed workflow or execute saved state manually ```bash agentserve workflows run [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--input ` | No | Trigger input as JSON (JSON, or @path / @- to read a file or stdin). | | `--async` | No | Queue the run and return immediately. | | `--execution-timeout-seconds ` | No | Maximum duration of an asynchronous run, in seconds, capped by the plan's execution timeout. Requires `async: true`; otherwise returns `400`. | | `--select-output ` | No | Return streamed outputs as blockName.path or childWorkflowId.blockName.path; selecting a child workflow applies to every invocation, requires --follow (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--include-file-base64` | No | Inline eligible output files as base64 content. Rejected when `async` is true. | | `--no-include-file-base64` | No | Send --include-file-base64 as false. | | `--base64-max-bytes ` | No | Maximum total bytes of file content to inline as base64, lowering but never raising the server limit of 16 MiB. Rejected when `async` is true. | | `--run-id ` | No | One-shot identifier for this run; NOT an idempotency key — reusing a claimed value fails with RUN\_ID\_CONFLICT instead of replaying the first result, and a fresh value starts another run. | | `--manual` | No | Run the current saved workflow state instead of the active deployment. | | `--trigger ` | No | Enter a manual run through this runnable trigger (requires --manual). | | `--mock-payload` | No | Use the selected trigger's server-derived mock payload (requires --manual). | | `--from-block ` | No | Run manually from this saved workflow block. | | `--source-run ` | No | Prior run whose persisted state supplies upstream outputs (requires --from-block). | | `--stop-after ` | No | Stop the run after this saved block, failing it if the run takes a path that skips the block; with --from-block on the same block, re-runs only that block (implies --manual). | | `--follow` | No | Stream the run as it happens; progress on stderr, result on stdout. The stream reports only success and output, so the result omits the run id and timings a non-streaming run returns. | | `--include-thinking` | No | Show model reasoning while following (requires --follow). | | `--include-tool-calls` | No | Show tool calls while following (requires --follow). | ### agentserve workflows export [#agentserve-workflows-export] Print a workflow as a portable JSON document ```bash agentserve workflows export [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------- | | `--include-references` | No | Include non-secret resource identities for mapped import. | ### agentserve workflows get [#agentserve-workflows-get] Get Workflow ```bash agentserve workflows get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### agentserve workflows deployment status [#agentserve-workflows-deployment-status] Show a workflow’s current deployment ```bash agentserve workflows deployment status ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### agentserve workflows deployment update [#agentserve-workflows-deployment-update] Update Workflow Public API Access (OAuth login or personal API key required) ```bash agentserve workflows deployment update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- | | `--is-public-api ` | Yes | Whether the deployed workflow should accept unauthenticated public API execution. Accepted values: `true`, `false`. | ### agentserve workflows state get [#agentserve-workflows-state-get] Get Workflow State ```bash agentserve workflows state get ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### agentserve workflows state replace [#agentserve-workflows-state-replace] Replace Workflow State (OAuth login or personal API key required) ```bash agentserve workflows state replace [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--dry-run` | No | Validate and lint without persisting. The response is identical to the committed write of the same body, so a caller can inspect `lint` and then re-send the request for real. Nothing is written, no audit entry is recorded, and collaborators are not notified. | | `--no-dry-run` | No | Send --dry-run as false. | | `--blocks ` | Yes | Blocks keyed by block id. (JSON, or @path / @- to read a file or stdin). | | `--edges ` | Yes | Directed connections between blocks. (JSON, or @path / @- to read a file or stdin). | | `--loops ` | No | Ignored on write: loop containers are recomputed from `blocks`. (JSON, or @path / @- to read a file or stdin). | | `--parallels ` | No | Ignored on write: parallel containers are recomputed from `blocks`. (JSON, or @path / @- to read a file or stdin). | | `--variables ` | No | Replacement variable set. Omit to leave the stored variables untouched. (JSON, or @path / @- to read a file or stdin). | | `-y, --yes` | No | Confirm this operation (required unless --dry-run). | ### agentserve workflows import [#agentserve-workflows-import] Import Workflow ```bash agentserve workflows import [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--name ` | No | Override for the imported workflow name. | | `--description ` | No | Override for the imported workflow description. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--bindings ` | No | Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | No | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | No | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | ### agentserve workflows list [#agentserve-workflows-list] List Workflows ```bash agentserve workflows list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--scope ` | No | Which lifecycle set to list: `active` (default) for live workflows, `archived` for workflows a `DELETE` archived. The folder filter resolves against active folders only, so pairing it with `archived` returns an empty page when the containing folder was archived too. Accepted values: `active`, `archived`. | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--deployed-only` | No | Return only workflows with an active deployment when true. | | `--no-deployed-only` | No | Send --deployed-only as false. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | | `--search ` | No | Case-insensitive substring match against the resource name. | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `position`, `name`, `createdAt`, `updatedAt`, `runCount`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | ### agentserve workflows move [#agentserve-workflows-move] Move Workflows ```bash agentserve workflows move [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflows to move. Duplicates are collapsed. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--to ` | Yes | Destination folder path; / moves the workflows to the workspace root. | ### agentserve workflows import-preview [#agentserve-workflows-import-preview] Preview Workflow Import ```bash agentserve workflows import-preview [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | | `--name ` | No | Override for the imported workflow name. | | `--description ` | No | Override for the imported workflow description. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--bindings ` | No | Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | ### agentserve workflows restore [#agentserve-workflows-restore] Restore an archived workflow ```bash agentserve workflows restore ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | ### agentserve workflows revert create [#agentserve-workflows-revert-create] Revert Workflow To Version (OAuth login or personal API key required) ```bash agentserve workflows revert create [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ----------------------------------------------------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `version` | Yes | Numeric deployment version, or `active` for the currently live version. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows rollback [#agentserve-workflows-rollback] Rollback Workflow (OAuth login or personal API key required) ```bash agentserve workflows rollback [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------- | | `--to-version ` | No | Deployment version to reactivate. Omit to select the previous active version. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows undeploy [#agentserve-workflows-undeploy] Take a workflow out of deployment (OAuth login or personal API key required) ```bash agentserve workflows undeploy [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------- | -------- | ----------------------- | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workflows update [#agentserve-workflows-update] Update Workflow ```bash agentserve workflows update [options] ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | --------------------------- | | `workflowId` | Yes | Unique workflow identifier. | **Options** | Option | Required | Description | | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | `--name ` | No | Replacement workflow name. | | `--description ` | No | Replacement workflow description; null clears it. (--description null sends the word, not JSON null). | | `--folder ` | No | Folder path as shown in the app; the leading / is optional. | ### agentserve workflows mv [#agentserve-workflows-mv] Move a workflow to a folder ```bash agentserve workflows mv ``` **Arguments** | Argument | Required | Description | | ------------ | -------- | ---------------------------------------------------------- | | `workflowId` | Yes | Unique workflow identifier. | | `folder` | Yes | Folder path as shown in the app; the leading / is optional | ### agentserve workflows ls [#agentserve-workflows-ls] List workflow resources and child folders together ```bash agentserve workflows ls [path] [options] ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | No | Folder path to list; defaults to the root folder | **Options** | Option | Required | Description | | ----------------- | -------- | --------------------------------------------------------------------- | | `--search ` | No | Filter folders and resources by name. | | `--limit ` | No | Maximum combined items to return (0 for everything). Defaults to `0`. | ### agentserve workflows mkdir [#agentserve-workflows-mkdir] Create a workflow directory at a path ```bash agentserve workflows mkdir ``` **Arguments** | Argument | Required | Description | | -------- | -------- | ------------------------------------------------ | | `path` | Yes | Folder path to create; the leading / is optional | ## agentserve workspaces [#agentserve-workspaces] Also spelled `agentserve workspace`. ### agentserve workspaces access-requests cancel [#agentserve-workspaces-access-requests-cancel] Cancel Workspace Access Request (OAuth login or personal API key required) ```bash agentserve workspaces access-requests cancel ``` **Arguments** | Argument | Required | Description | | ----------- | -------- | -------------------------- | | `requestId` | Yes | Access request identifier. | ### agentserve workspaces access-requests create [#agentserve-workspaces-access-requests-create] Create Workspace Access Request (OAuth login or personal API key required) ```bash agentserve workspaces access-requests create [options] ``` **Options** | Option | Required | Description | | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--target ` | Yes | Target returned by Discover Workspace Access Requests or Discover Organization Access Requests. The target must currently be requestable. (JSON, or @path / @- to read a file or stdin). | | `--reason ` | No | Why the acting user needs this access. | ### agentserve workspaces access-requests discover [#agentserve-workspaces-access-requests-discover] Discover Workspace Access Requests (OAuth login or personal API key required) ```bash agentserve workspaces access-requests discover [options] ``` **Options** | Option | Required | Description | | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `--search ` | No | Case-insensitive substring match against the access item label. | | `--target-kind ` | No | Category of access to discover. Accepted values: `feature`, `integration`, `provider`, `model`, `tool`, `knowledge_connector`, `file_share_auth`, `chat_deploy_auth`, `usage_limit`. | | `--state ` | No | Filter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: `allowed`, `requestable`, `unavailable`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `label`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve workspaces access-requests mine [#agentserve-workspaces-access-requests-mine] List My Workspace Access Requests (OAuth login or personal API key required) ```bash agentserve workspaces access-requests mine [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--status ` | No | Filter by request status; omit to include all statuses. Accepted values: `pending`, `fulfilled`, `declined`, `cancelled`, `closed`. | | `--sort-by ` | No | Field used to sort the result. Accepted values: `createdAt`, `targetLabel`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | ### agentserve workspaces invitations create [#agentserve-workspaces-invitations-create] Create Workspace Invitations (OAuth login or personal API key required) ```bash agentserve workspaces invitations create [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--emails ` | Yes | Email addresses to invite. Each address is processed separately; inspect failed for unsuccessful recipients. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--permission ` | No | Workspace permission to grant. Existing workspace access is preserved. Accepted values: `admin`, `write`, `read`. | | `--membership ` | No | Organization membership: member or admin uses a seat when billing is enabled. External grants workspace access only and requires an eligible paid account when billing is enabled. Existing members of another organization remain external. Accepted values: `member`, `admin`, `external`. | ### agentserve workspaces fork [#agentserve-workspaces-fork] Fork Workspace (OAuth login or personal API key required) ```bash agentserve workspaces fork [options] ``` **Options** | Option | Required | Description | | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | Display name of the workflow or workspace. | | `--copy ` | No | Explicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | Yes | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | Yes | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | ### agentserve workspaces get [#agentserve-workspaces-get] Get Workspace ```bash agentserve workspaces get ``` ### agentserve workspaces fork-availability [#agentserve-workspaces-fork-availability] Get Workspace Fork Availability (OAuth login or personal API key required) ```bash agentserve workspaces fork-availability ``` ### agentserve workspaces lineage [#agentserve-workspaces-lineage] Get Workspace Fork Lineage (OAuth login or personal API key required) ```bash agentserve workspaces lineage ``` ### agentserve workspaces mappings get [#agentserve-workspaces-mappings-get] Get Workspace Fork Mappings (OAuth login or personal API key required) ```bash agentserve workspaces mappings get [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--direction ` | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: `push`, `pull`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--sort-by ` | No | Supported stable sort key for this collection. Accepted values: `id`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`. | ### agentserve workspaces mappings update [#agentserve-workspaces-mappings-update] Update Workspace Fork Mappings (OAuth login or personal API key required) ```bash agentserve workspaces mappings update [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--direction ` | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: `push`, `pull`. | | `--mappings ` | Yes | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | ### agentserve workspaces operations get [#agentserve-workspaces-operations-get] Get Workspace Operation ```bash agentserve workspaces operations get ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ------------------------------------------------ | | `operationId` | Yes | Durable operation identifier to use for polling. | ### agentserve workspaces operations list [#agentserve-workspaces-operations-list] List Workspace Operations ```bash agentserve workspaces operations list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ------------------------------------------------------------------ | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--request-id ` | No | Stable client request ID for reconciliation and identical retries. | ### agentserve workspaces operations wait [#agentserve-workspaces-operations-wait] Wait for copy and deployment readiness; exit 3 for configuration, 1 for failure, or 4 for timeout ```bash agentserve workspaces operations wait [options] ``` **Arguments** | Argument | Required | Description | | ------------- | -------- | ---------------------------------------------------- | | `operationId` | Yes | Operation ID returned by import, fork, push, or pull | **Options** | Option | Required | Description | | -------------------------- | -------- | -------------------------------------------------------- | | `--wait-timeout ` | No | Maximum total wait (default 3600; 0 waits indefinitely). | ### agentserve workspaces permission-config [#agentserve-workspaces-permission-config] Get Workspace Permission Config (OAuth login or personal API key required) ```bash agentserve workspaces permission-config ``` ### agentserve workspaces children [#agentserve-workspaces-children] List Workspace Fork Children (OAuth login or personal API key required) ```bash agentserve workspaces children [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--sort-by ` | No | Supported stable sort key for this collection. Accepted values: `createdAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `desc`. | ### agentserve workspaces fork-resources [#agentserve-workspaces-fork-resources] List Workspace Fork Resources (OAuth login or personal API key required) ```bash agentserve workspaces fork-resources [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `100`. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | | `--kind ` | Yes | Resource or operation kind. Accepted values: `files`, `tables`, `knowledgeBases`, `customTools`, `skills`, `mcpServers`, `workflowMcpServers`. | | `--sort-by ` | No | Supported stable sort key for this collection. Accepted values: `id`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`. | ### agentserve workspaces members [#agentserve-workspaces-members] List workspace members ```bash agentserve workspaces members [options] ``` **Options** | Option | Required | Description | | ------------- | -------- | ------------------------------------------------------------ | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve workspaces list [#agentserve-workspaces-list] List Workspaces ```bash agentserve workspaces list [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--sort-by ` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`, `updatedAt`. | | `--sort-order ` | No | Sort direction. Accepted values: `asc`, `desc`. | | `--limit ` | No | Maximum items to return (0 for everything). Defaults to `0`. | ### agentserve workspaces fork-preview [#agentserve-workspaces-fork-preview] Preview Workspace Fork (OAuth login or personal API key required) ```bash agentserve workspaces fork-preview [options] ``` **Options** | Option | Required | Description | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `--name ` | No | Display name of the workflow or workspace. | | `--copy ` | No | Explicit resource selections to copy into the new fork; omitted resource kinds are not copied. (JSON, or @path / @- to read a file or stdin). | ### agentserve workspaces pull-preview [#agentserve-workspaces-pull-preview] Preview Workspace Pull (OAuth login or personal API key required) ```bash agentserve workspaces pull-preview [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | ### agentserve workspaces push-preview [#agentserve-workspaces-push-preview] Preview Workspace Push (OAuth login or personal API key required) ```bash agentserve workspaces push-preview [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | ### agentserve workspaces pull [#agentserve-workspaces-pull] Pull Workspace (OAuth login or personal API key required) ```bash agentserve workspaces pull [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | Yes | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | Yes | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workspaces push [#agentserve-workspaces-push] Push Workspace (OAuth login or personal API key required) ```bash agentserve workspaces push [options] ``` **Options** | Option | Required | Description | | ---------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `--mappings ` | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). | | `--dependent-values ` | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). | | `--copy-resources ` | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). | | `--drop-references ` | No | Source-deleted references explicitly acknowledged for removal; live source references cannot be dropped. (JSON, or @path / @- to read a file or stdin). | | `--trigger-mappings ` | No | Public trigger path choices from preview\.triggerSlots, addressed by source workflow and block IDs. Duplicate or unavailable choices are rejected. (JSON, or @path / @- to read a file or stdin). | | `--request-id ` | Yes | Stable client request ID for reconciliation and identical retries. | | `--preview-fingerprint ` | Yes | Fingerprint of the reviewed preview and its choices. | | `--wait` | No | Wait for the committed operation to finish; missing configuration and failure exit nonzero. | | `--wait-timeout ` | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workspaces fork-rollback [#agentserve-workspaces-fork-rollback] Rollback Workspace Fork (OAuth login or personal API key required) ```bash agentserve workspaces fork-rollback [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ---------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workspaces unlink [#agentserve-workspaces-unlink] Unlink Workspace Fork (OAuth login or personal API key required) ```bash agentserve workspaces unlink [options] ``` **Options** | Option | Required | Description | | ------------------------------ | -------- | ---------------------------------------------------- | | `--other-workspace-id ` | Yes | Workspace on the other side of the direct fork edge. | | `-y, --yes` | Yes | Confirm this operation. | ### agentserve workspaces sync-exclusions [#agentserve-workspaces-sync-exclusions] Update Workspace Fork Exclusions (OAuth login or personal API key required) ```bash agentserve workspaces sync-exclusions [options] ``` **Options** | Option | Required | Description | | ------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `--workflow ` | Yes | Workflow identifiers in the current workspace. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). | | `--fork-sync-excluded ` | Yes | Whether the named workflows should be skipped as sync sources and targets. Accepted values: `true`, `false`. |