Every command on one page, generated from the CLI itself. Start at the overview to browse; this page is for searching and for tools.
Append .mdx to any page for its raw Markdown —
/cli/reference.mdx is this page as plain text. The docs
are also published as /llms.txt and
/llms-full.txt.
Global options
These apply to every command, and may be written before or after it.
| Option | Description |
|---|---|
-P, --profile <name> | Profile to use (env: AGENT_SERVE_PROFILE). |
--endpoint <url> | Deployment to talk to (env: AGENT_SERVE_BASE_URL). |
-w, --workspace <id> | Workspace to target (env: AGENT_SERVE_WORKSPACE). |
--output <format> | Output format for this command. Accepted values: table, json, yaml, text. |
agentserve login
Log in through the browser and store the login for the profile
agentserve login [options]Options
| Option | Required | Description |
|---|---|---|
--method <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 <port> | No | Pin the local port the browser returns to. |
-y, --yes | No | Overwrite an existing API-key profile without prompting. |
agentserve logout
Sign out and remove the profile's stored login
agentserve logout [options]Options
| Option | Required | Description |
|---|---|---|
--all | No | Remove the profile entirely, including its settings. |
agentserve whoami
Show the resolved profile, where each setting came from, and whether it works
agentserve whoami [options]Options
| Option | Required | Description |
|---|---|---|
--no-verify | No | Skip the API check and only print the resolved settings. |
agentserve configure
Switch a profile's default workspace, or set its endpoint or output format
agentserve configure [options]Options
| Option | Required | Description |
|---|---|---|
--set-endpoint <url> | No | Agent Serve deployment to talk to. |
--set-workspace <id> | No | Default workspace for workspace-scoped commands. |
--set-output <format> | No | Default output format (table | json | yaml | text). |
--unset <key...> | No | Remove settings (endpoint, workspace, output). |
agentserve update
Update this global CLI installation to the newest release on its channel
agentserve update [options]Options
| Option | Required | Description |
|---|---|---|
--package-manager <manager> | No | Package manager that installed this copy. Accepted values: npm, pnpm, bun, yarn. |
agentserve chat
Ask Agent Serve and print the reply
agentserve chat <message> [options]Arguments
| Argument | Required | Description |
|---|---|---|
message | Yes | What to ask Agent Serve |
Options
| Option | Required | Description |
|---|---|---|
-c, --conversation <id> | No | Continue the conversation with this ID. |
agentserve profiles
Also spelled agentserve profile.
agentserve profiles list
List configured profiles
agentserve profiles listagentserve profiles add
Add a workspace profile that shares the active stored login
agentserve profiles add <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Name for the new profile |
Options
| Option | Required | Description |
|---|---|---|
-w, --workspace <id> | No | Existing workspace to use; omit for an interactive picker. |
agentserve telemetry
agentserve telemetry status
Show whether usage reporting is on, and why not if it is off
agentserve telemetry statusagentserve telemetry enable
Turn usage reporting on for this machine
agentserve telemetry enableagentserve telemetry disable
Turn usage reporting off for this machine
agentserve telemetry disableagentserve runner
agentserve runner link
Link this machine to a workspace with a one-time code
agentserve runner link [options]Options
| Option | Required | Description |
|---|---|---|
--name <name> | No | name shown in Settings → Runners (default: hostname). |
--force | No | link again even if this machine is already linked. |
agentserve runner run
Take and run jobs until stopped
agentserve runner run [options]Options
| Option | Required | Description |
|---|---|---|
--concurrency <n> | No | jobs to run at once. Defaults to 2. |
agentserve runner status
Show whether this machine is linked and approved
agentserve runner statusagentserve runner unlink
Forget this machine’s runner token
agentserve runner unlinkagentserve cli
agentserve cli search
Find the command for a task, described in plain words
agentserve cli search <query...>Arguments
| Argument | Required | Description |
|---|---|---|
query... | Yes | What you want to do, e.g. "cancel a workflow run" |
agentserve model
agentserve model pull
Write the published model, or your draft, to agentserve.model.yaml (OAuth login or personal API key required)
agentserve model pull [options]Options
| Option | Required | Description |
|---|---|---|
--draft | No | Pull your own draft instead of the published model. |
-f, --file <path> | No | File to write; - writes to stdout. Defaults to agentserve.model.yaml. |
agentserve model diff
Show what the model file would change in the published model or your draft (OAuth login or personal API key required)
agentserve model diff [options]Options
| Option | Required | Description |
|---|---|---|
-f, --file <path> | No | Model file to compare; - reads stdin. Defaults to agentserve.model.yaml. |
--against <model> | No | Model to compare with. Accepted values: published, draft. Defaults to published. |
agentserve model push
Write the model file into your draft (starting one if needed); never publishes (OAuth login or personal API key required)
agentserve model push [options]Options
| Option | Required | Description |
|---|---|---|
-f, --file <path> | No | Model file to push; - reads stdin. Defaults to agentserve.model.yaml. |
agentserve app
agentserve app init
Create a new app from a starter template
agentserve app init [dir] [options]Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | Folder to create the app in |
Options
| Option | Required | Description |
|---|---|---|
-t, --template <name> | No | Starter template. Accepted values: blank, sales-cockpit, field-visit-logger, deal-desk, support-triage, ops-exceptions, knowledge-assistant. Defaults to blank. |
--name <slug> | No | App name in the manifest; defaults to the folder name. |
--title <text> | 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
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)
agentserve app dev [dir] [options]Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | App folder |
Options
| Option | Required | Description |
|---|---|---|
-p, --port <port> | No | Port for the local host page. Defaults to 5175. |
--page <id> | No | Page to open first. |
--launch <json> | No | What launch.get answers, as a plugin command or action opens the page: {"kind":"command","name":"brief","args":{"file":"q3"}}. |
--build-command <command> | No | Command that builds the app (default: <package manager> 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
Build the app, pack it and upload it as a draft version (OAuth login or personal API key required)
agentserve app deploy [dir] [options]Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | App folder |
Options
| Option | Required | Description |
|---|---|---|
--build-command <command> | No | Command that builds the app (default: <package manager> 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
Publish a draft version so workspaces can install it (admin) (OAuth login or personal API key required)
agentserve app publish <version> [options]Arguments
| Argument | Required | Description |
|---|---|---|
version | Yes | Version to publish, such as 1.2.0, or its id |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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
Move this workspace's install to an earlier published version (admin) (OAuth login or personal API key required)
agentserve app rollback <version> [options]Arguments
| Argument | Required | Description |
|---|---|---|
version | Yes | Published version to run, such as 1.1.0, or its id |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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
Install a published app in the workspace (admin); pick it with -w, --workspace (OAuth login or personal API key required)
agentserve app install [options]Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--to-version <version> | No | Published version to install; defaults to the highest. |
--json | No | Print machine-readable JSON (same as --output json). |
agentserve app logs
Show the install's audit trail, oldest first; --follow keeps watching (OAuth login or personal API key required)
agentserve app logs [options]Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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 <seconds> | No | Seconds between polls with --follow. Defaults to 5. |
--json | No | Print machine-readable JSON (same as --output json). |
agentserve app usage
Show this month's spend against the app's budget, by source (OAuth login or personal API key required)
agentserve app usage [options]Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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
Show what the app may reach, installed and in the local manifest (OAuth login or personal API key required)
agentserve app permissions [dir] [options]Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | App folder whose manifest to compare |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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
Set a secret; prompts without echo when --value is not given (OAuth login or personal API key required)
agentserve app secrets set <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret name, such as API_TOKEN |
Options
| Option | Required | Description |
|---|---|---|
--value <value|@file> | No | Secret value. Inline values land in shell history; @path reads a file and @- stdin, verbatim. |
--app <name-or-id> | 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
List secret names and when each was set (OAuth login or personal API key required)
agentserve app secrets list [options]Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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
Delete a secret (OAuth login or personal API key required)
agentserve app secrets delete <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret name |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | 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 secrets delete
Delete App Secret (OAuth login or personal API key required)
agentserve apps secrets delete <installId> <name> [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
List App Secrets (OAuth login or personal API key required)
agentserve apps secrets list <installId>Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
agentserve apps secrets update
Set App Secret (OAuth login or personal API key required)
agentserve apps secrets update <installId> <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
name | Yes | Secret name. |
Options
| Option | Required | Description |
|---|---|---|
--value <value> | Yes | Write-only secret value. It is never returned. |
agentserve apps get
Get App (OAuth login or personal API key required)
agentserve apps get <appId>Arguments
| Argument | Required | Description |
|---|---|---|
appId | Yes | App identifier. |
agentserve apps deployments get
Get App Deployment (OAuth login or personal API key required)
agentserve apps deployments get <appId> <deploymentId>Arguments
| Argument | Required | Description |
|---|---|---|
appId | Yes | App identifier. |
deploymentId | Yes | Deployment identifier. |
agentserve apps deployments list
List App Deployments (OAuth login or personal API key required)
agentserve apps deployments list <appId>Arguments
| Argument | Required | Description |
|---|---|---|
appId | Yes | App identifier. |
agentserve apps deployments publish
Publish App Deployment (OAuth login or personal API key required)
agentserve apps deployments publish <appId> <deploymentId>Arguments
| Argument | Required | Description |
|---|---|---|
appId | Yes | App identifier. |
deploymentId | Yes | Deployment identifier. |
agentserve apps installs get
Get App Install (OAuth login or personal API key required)
agentserve apps installs get <installId>Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
agentserve apps installs create
Install App (OAuth login or personal API key required)
agentserve apps installs create [options]Options
| Option | Required | Description |
|---|---|---|
--app-id <value> | Yes | App to install. |
--version-id <value> | No | A published version; omit to install the highest published version. |
agentserve apps installs list
List App Installs (OAuth login or personal API key required)
agentserve apps installs listagentserve apps installs delete
Uninstall App (OAuth login or personal API key required)
agentserve apps installs delete <installId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve apps installs update
Update App Install (OAuth login or personal API key required)
agentserve apps installs update <installId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
Options
| Option | Required | Description |
|---|---|---|
--version-id <value> | No | A published version to run instead — an upgrade or a roll back. |
--pinned-for <json|@file> | No | Who sees the app as its own rail icon. (JSON, or @path / @- to read a file or stdin). |
--budget-monthly-usd <number|null> | No | Monthly budget in USD; null falls back to the manifest budget. |
--status <value> | No | Turn the app on or off. Accepted values: active, disabled. |
agentserve apps activity list
Get App Install Activity (OAuth login or personal API key required)
agentserve apps activity list <installId>Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
agentserve apps repos list
List App Repositories (OAuth login or personal API key required)
agentserve apps repos list <appId>Arguments
| Argument | Required | Description |
|---|---|---|
appId | Yes | App identifier. |
agentserve apps list
List Apps (OAuth login or personal API key required)
agentserve apps listagentserve apps tools list
List App Tools (OAuth login or personal API key required)
agentserve apps tools list [options]Options
| Option | Required | Description |
|---|---|---|
--install-id <value> | No | Only the tools of this install. |
agentserve apps publish create
Publish App Version (OAuth login or personal API key required)
agentserve apps publish create <appId> <versionId> [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
Rebuild App Deployment (OAuth login or personal API key required)
agentserve apps rebuild create <appId> <deploymentId>Arguments
| Argument | Required | Description |
|---|---|---|
appId | Yes | App identifier. |
deploymentId | Yes | Deployment identifier. |
agentserve apps retire create
Retire App Version (OAuth login or personal API key required)
agentserve apps retire create <appId> <versionId> [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
Run App Tool (OAuth login or personal API key required)
agentserve apps run create <installId> <toolName> [options]Arguments
| Argument | Required | Description |
|---|---|---|
installId | Yes | Install identifier. |
toolName | Yes | Tool name. |
Options
| Option | Required | Description |
|---|---|---|
--input <json|@file> | No | The tool's input; validated against its input schema. (JSON, or @path / @- to read a file or stdin). |
agentserve apps versions create
Upload App Version (OAuth login or personal API key required)
agentserve apps versions createagentserve audit-logs
Also spelled agentserve audit-log.
agentserve audit-logs get
Get Audit Log (OAuth login or personal API key required)
agentserve audit-logs get <auditLogId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
auditLogId | Yes | Audit-log entry identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | 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
List Audit Logs (OAuth login or personal API key required)
agentserve audit-logs list [options]Options
| Option | Required | Description |
|---|---|---|
--action <value> | No | Filter by exact action name. |
--resource-type <value> | 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 <value> | No | Filter by exact resource identifier. |
--start-date <value> | 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 <value> | 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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--organization <value> | 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 <value> | 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 status
Show billing status, credits spent this period, and storage used (credits and storage require an OAuth login or personal API key)
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
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)
agentserve billing logs [options]Options
| Option | Required | Description |
|---|---|---|
--source <value> | 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 <value> | No | Billing period. Accepted values: 1d, 7d, 30d, all, custom. |
--start-date <value> | No | Custom period start (ISO 8601). |
--end-date <value> | No | Custom period end (ISO 8601). |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | 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 get
Get Block
agentserve blocks get <blockId>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
List Blocks
agentserve blocks list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the block id, name, and description. |
--category <value> | No | Restrict to one toolbar category. Accepted values: blocks, tools, triggers. |
--capability <value> | 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 <value> | No | Restrict to built-in blocks or this workspace's deployed custom blocks. Accepted values: builtin, custom. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve chat-deployments
agentserve chat-deployments list
List Chat Deployments
agentserve chat-deployments list [options]Options
| Option | Required | Description |
|---|---|---|
--workflow-id <value> | 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 <value> | No | Field used to sort the result. Accepted values: identifier, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve connector-types
agentserve connector-types list
List Connector Types
agentserve connector-types list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the connector name. |
agentserve credentials
Also spelled agentserve credential.
agentserve credentials delete
Disconnect Credential (OAuth login or personal API key required)
agentserve credentials delete <credentialId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential to disconnect. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve credentials members list
List Credential Members (OAuth login or personal API key required)
agentserve credentials members list <credentialId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential whose sharing grants are managed. |
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve credentials members remove
Remove Credential Member (OAuth login or personal API key required)
agentserve credentials members remove <credentialId> <userId> [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
Upsert Credential Member (OAuth login or personal API key required)
agentserve credentials members upsert <credentialId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential whose sharing grants are managed. |
Options
| Option | Required | Description |
|---|---|---|
--user <value> | Yes | Existing workspace member to grant or change access for. |
--role <value> | Yes | Credential role to grant; workspace administrators cannot be demoted. Accepted values: admin, member. |
agentserve credentials providers list
List Credential Providers
agentserve credentials providers list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the credential provider name. |
agentserve credentials list
List Credentials
agentserve credentials list [options]Options
| Option | Required | Description |
|---|---|---|
--type <value> | No | Restrict results to this credential type. Accepted values: oauth, service_account. |
--provider-id <value> | No | Restrict results to credentials for this integration provider. |
--search <value> | No | Case-insensitive substring match against the credential display name. |
--sort-by <value> | No | Field used to sort the result. Accepted values: displayName, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve credentials update
Update Credential (OAuth login or personal API key required)
agentserve credentials update <credentialId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Credential to update. |
Options
| Option | Required | Description |
|---|---|---|
--display-name <value> | No | New name shown for the credential in Agent Serve. |
--description <value> | No | New credential description. Send null to clear the stored one. (--description null sends the word, not JSON null). |
--service-account-json <value> | No | Write-only provider service-account JSON configuration, including Oracle Database connection fields. |
--api-token <value> | No | Write-only provider API token. |
--domain <value> | No | Provider account domain. |
--atlassian-product <value> | No | Atlassian product to verify; defaults to Jira on create and preserves the saved product on reconnect. Accepted values: jira, confluence. |
--signing-secret <value> | No | Write-only webhook signing secret. |
--bot-token <value> | No | Write-only bot token. |
--client-id <value> | No | OAuth client identifier. |
--client-secret <value> | No | Write-only OAuth client secret. |
--certificate-id <value> | No | Provider certificate mapping identifier. |
--org-id <value> | No | Provider organization ID. |
--data-center <value> | No | Provider data center. |
--auth-method <value> | No | Provider authentication method. |
--private-key <value> | No | Write-only PEM private key. |
--username <value> | No | Provider run-as username. |
--tenancy-ocid <value> | No | OCI tenancy OCID. |
--user-ocid <value> | No | OCI user OCID. |
--fingerprint <value> | No | OCI API-key fingerprint. |
--private-key-passphrase <value> | No | Write-only OCI private-key passphrase. |
--region <value> | No | OCI home region. |
--name <displayName> | No | Alias for --display-name. |
agentserve credentials create
Create a service-account credential using its discovered provider schema (OAuth login or personal API key required)
agentserve credentials create <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | Service-account provider to create a credential for |
Options
| Option | Required | Description |
|---|---|---|
--name <displayName> | Yes | Name shown for the credential in Agent Serve. |
--credentials <json|@file> | Yes | Provider credentials as JSON (or @path / @- to read a file or stdin). |
--description <description> | No | Optional credential description. |
--id <credentialId> | No | Client-generated credential ID when provider discovery requires it. |
agentserve credentials connect
Create a short-lived link for connecting an OAuth provider (OAuth login or personal API key required)
agentserve credentials connect <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | OAuth provider to connect |
Options
| Option | Required | Description |
|---|---|---|
--name <displayName> | Yes | Name shown for the new credential in Agent Serve. |
agentserve credentials reconnect
Create a short-lived link for reconnecting an OAuth credential (OAuth login or personal API key required)
agentserve credentials reconnect <credentialId>Arguments
| Argument | Required | Description |
|---|---|---|
credentialId | Yes | Existing OAuth credential to re-authorize |
agentserve custom-tools
Also spelled agentserve custom-tool.
agentserve custom-tools create
Create Custom Tool
agentserve custom-tools create [options]Options
| Option | Required | Description |
|---|---|---|
--title <value> | Yes | Display title, unique within the workspace. |
--schema <json|@file> | Yes | OpenAI function schema: {"type":"function","function":{"name":"...","parameters":{"type":"object","properties":{}}}} (JSON, or @path / @- to read a file or stdin). |
--code <value> | Yes | Tool implementation executed in the sandboxed function runtime. |
agentserve custom-tools delete
Delete Custom Tool
agentserve custom-tools delete <customToolId> [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
Get Custom Tool
agentserve custom-tools get <customToolId>Arguments
| Argument | Required | Description |
|---|---|---|
customToolId | Yes | Unique custom tool identifier. |
agentserve custom-tools list
List Custom Tools
agentserve custom-tools list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the tool title. |
--sort-by <value> | No | Field used to sort the result. Accepted values: title, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve custom-tools update
Update Custom Tool
agentserve custom-tools update <customToolId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
customToolId | Yes | Unique custom tool identifier. |
Options
| Option | Required | Description |
|---|---|---|
--title <value> | No | New display title for the tool. |
--schema <json|@file> | No | OpenAI function schema: {"type":"function","function":{"name":"...","parameters":{"type":"object","properties":{}}}} (JSON, or @path / @- to read a file or stdin). |
--code <value> | No | Replacement tool implementation. |
agentserve files
Also spelled agentserve file.
agentserve files batch-delete
Delete several files at once
agentserve files batch-delete [options]Options
| Option | Required | Description |
|---|---|---|
--file-ids <value...> | 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
POST /api/v2/files/copy
agentserve files copy [options]Options
| Option | Required | Description |
|---|---|---|
--source <json|@file> | Yes | Source owner and selected fileIds or folderIds (JSON, or @path / @- to read a file or stdin). |
--destination <json|@file> | Yes | Destination owner and optional folderId (JSON, or @path / @- to read a file or stdin). |
agentserve files create
Create File
agentserve files create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | File name, including its extension. Path separators and dot segments are rejected. |
--content-type <value> | No | MIME type. When omitted, it is inferred from the file extension. |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
--content <value> | 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 <value> | No | Encoding of the content field. Accepted values: utf-8, base64. |
agentserve files folders create
Create a file folder at a path
agentserve files folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path as shown in the app; the leading / is optional |
agentserve files folders delete
Delete Folder
agentserve files folders delete <path> [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
List folders
agentserve files folders list [options]Also available as agentserve files folders ls.
Options
| Option | Required | Description |
|---|---|---|
--parent <value> | No | Direct parent folder path. |
--search <value> | No | Case-insensitive substring match against the folder name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--scope <value> | 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 <value> | 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 <value> | No | Deepest level below parentPath to include when recursive is true. |
agentserve files folders move
Rename or move a file folder
agentserve files folders move <path> <destination>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
Restore an archived file folder
agentserve files folders restore <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path as shown in the app; the leading / is optional |
agentserve files delete
Delete File
agentserve files delete <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve files versions delete
Permanently delete a previous version of a file
agentserve files versions delete <fileId> <version> [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
Show the metadata of one version of a file
agentserve files versions describe <fileId> <version>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
version | Yes | Version number. |
agentserve files versions list
List the recorded versions of a file
agentserve files versions list <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--sort-by <value> | No | Field used to sort the result. Accepted values: version. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve files versions read
Read the text content of one version of a file
agentserve files versions read <fileId> <version> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
version | Yes | Version number. |
Options
| Option | Required | Description |
|---|---|---|
--max-bytes <value> | No | Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit. |
--offset <value> | No | First line to return, 1-based; 0 also starts at the first line. Absent starts at the first line. |
--limit <value> | No | How many lines to return from offset. Absent reads to the end. |
agentserve files versions revert
Make a previous version of a file current again
agentserve files versions revert <fileId> <version> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
version | Yes | Version number. |
Options
| Option | Required | Description |
|---|---|---|
--expected-current-version <value> | 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 <value> | 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
Download the content of one version of a file
agentserve files versions download <fileId> <version> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
version | Yes | Version number. |
Options
| Option | Required | Description |
|---|---|---|
-o, --output-file <path> | No | Write content to a file instead of stdout. |
--force | No | Overwrite --output-file if it already exists. |
agentserve files edit
Apply one exact or anchor-based edit to a text file
agentserve files edit <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--edit <json|@file> | 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 <value> | No | Revision from Get File Metadata or an earlier write; the request is refused with 409 when the content moved on. |
agentserve files describe
Show file metadata and sharing status
agentserve files describe <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--scope <value> | 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
Show a file’s share settings
agentserve files share get <fileId>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
agentserve files share set
Enable or disable sharing for a file (OAuth login or personal API key required)
agentserve files share set <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--is-active <true|false> | 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 <value> | 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 <value> | 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 <value...> | 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
List Files
agentserve files list [options]Options
| Option | Required | Description |
|---|---|---|
--folder <value> | 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 <value> | 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 <value> | No | Case-insensitive substring match against the file name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve files move
Move files into another folder
agentserve files move [options]Also available as agentserve files mv.
Options
| Option | Required | Description |
|---|---|---|
--file-ids <value...> | Yes | File identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--to <value> | No | Destination folder path; omit for root. |
agentserve files read
Read a file’s text content as JSON or YAML
agentserve files read <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--max-bytes <value> | No | Optional ceiling on the source bytes fed to the parser, lowering but never raising the server limit. |
--offset <value> | No | First line to return, 1-based; 0 also starts at the first line. Absent starts at the first line. |
--limit <value> | No | How many lines to return from offset. Absent reads to the end. |
agentserve files rename
Rename a file
agentserve files rename <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | New file name, including its extension. |
agentserve files restore
Restore an archived file
agentserve files restore <fileId>Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
agentserve files search
Search File Content
agentserve files search [options]Options
| Option | Required | Description |
|---|---|---|
--query <value> | Yes | Regular expression, or exact text when mode is exact. |
--mode <value> | No | How query is read. Accepted values: exact, regex. |
--max-results <value> | No | Maximum matching lines to return. |
--folder <value...> | 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
Unzip an archive into a new folder beside it
agentserve files unzip <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve files set-content
Replace a file’s contents
agentserve files set-content <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File identifier. |
Options
| Option | Required | Description |
|---|---|---|
--content <value> | 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 <value> | No | Content encoding. Accepted values: utf-8, base64. |
--expected-revision <value> | No | Revision from Get File Metadata or an earlier write; the request is refused with 409 when the content moved on. |
agentserve files upload
Upload a file to the workspace
agentserve files upload <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Local file to upload |
Options
| Option | Required | Description |
|---|---|---|
--folder <path> | No | Folder path as shown in the app; defaults to the root folder. |
--name <name> | No | Store it under a different name. |
agentserve files get
Download a file’s content to stdout or a local file
agentserve files get <fileId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
fileId | Yes | File whose content to read |
Options
| Option | Required | Description |
|---|---|---|
-o, --output-file <path> | No | Write content to a file instead of stdout. |
--force | No | Overwrite --output-file if it already exists. |
agentserve files ls
List file resources and child folders together
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 <text> | No | Filter folders and resources by name. |
--limit <n> | No | Maximum combined items to return (0 for everything). Defaults to 0. |
agentserve files mkdir
Create a file directory at a path
agentserve files mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
agentserve knowledge
Also spelled agentserve kb.
agentserve knowledge from-workspace-files create
Index files the workspace already stores (OAuth login or personal API key required)
agentserve knowledge from-workspace-files create <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--file <value...> | 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
Declare the tag definitions a knowledge base needs (OAuth login or personal API key required)
agentserve knowledge tags save <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--definitions <json|@file> | Yes | Tag definitions: [{"tagSlot":"tag1","displayName":"category","fieldType":"text"}] (JSON, or @path / @- to read a file or stdin). |
agentserve knowledge tags create
Create Tag (OAuth login or personal API key required)
agentserve knowledge tags create <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--display-name <value> | Yes | Name tag filters and document reads use for this tag. |
--field-type <value> | 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 <value> | 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
Delete Tag (OAuth login or personal API key required)
agentserve knowledge tags delete <knowledgeBaseId> <tagId> [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
Remove tag definitions no document still uses (OAuth login or personal API key required)
agentserve knowledge tags cleanup <knowledgeBaseId> [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
Show which tag slot a create would take for a field type (OAuth login or personal API key required)
agentserve knowledge tags next-slot <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--field-type <value> | 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
List Tags
agentserve knowledge tags list <knowledgeBaseId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
agentserve knowledge tags usage
Show how many documents and chunks carry each tag (OAuth login or personal API key required)
agentserve knowledge tags usage <knowledgeBaseId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
agentserve knowledge tags update
Update Tag (OAuth login or personal API key required)
agentserve knowledge tags update <knowledgeBaseId> <tagId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
tagId | Yes | Unique tag definition identifier. |
Options
| Option | Required | Description |
|---|---|---|
--display-name <value> | No | New tag display name. |
--field-type <value> | No | New value type for the tag. Accepted values: text, number, date, boolean. |
agentserve knowledge chunks batch-update
Enable, disable, or delete many chunks at once (OAuth login or personal API key required)
agentserve knowledge chunks batch-update <knowledgeBaseId> <documentId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
documentId | Yes | Unique knowledge document identifier. |
Options
| Option | Required | Description |
|---|---|---|
--operation <value> | Yes | What to do with the selected chunks. Accepted values: enable, disable, delete. |
--chunk <value...> | 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
Create Chunk (OAuth login or personal API key required)
agentserve knowledge chunks create <knowledgeBaseId> <documentId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
documentId | Yes | Unique knowledge document identifier. |
Options
| Option | Required | Description |
|---|---|---|
--content <value> | 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
Delete Chunk (OAuth login or personal API key required)
agentserve knowledge chunks delete <knowledgeBaseId> <documentId> <chunkId> [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
Get Chunk (OAuth login or personal API key required)
agentserve knowledge chunks get <knowledgeBaseId> <documentId> <chunkId>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
List Chunks (OAuth login or personal API key required)
agentserve knowledge chunks list <knowledgeBaseId> <documentId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
documentId | Yes | Unique knowledge document identifier. |
Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against chunk content. |
--enabled <value> | No | Restrict to enabled or disabled chunks. all returns both. Accepted values: true, false, all. |
--sort-by <value> | No | Field used to sort the result. Accepted values: chunkIndex, tokenCount, enabled. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve knowledge chunks update
Update Chunk (OAuth login or personal API key required)
agentserve knowledge chunks update <knowledgeBaseId> <documentId> <chunkId> [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 <value> | 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
Enable or disable every matching document (OAuth login or personal API key required)
agentserve knowledge documents batch-update <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--operation <value> | Yes | Whether the selected documents become enabled or disabled for search. Accepted values: enable, disable. |
--document <value...> | 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 <value> | No | With selectAll, restrict the update to documents in this state. Accepted values: all, enabled, disabled. |
agentserve knowledge documents delete
Delete a document from a knowledge base
agentserve knowledge documents delete <knowledgeBaseId> <documentId> [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
Get Document
agentserve knowledge documents get <knowledgeBaseId> <documentId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
documentId | Yes | Unique knowledge document identifier. |
agentserve knowledge documents list
List Documents
agentserve knowledge documents list <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--search <value> | No | Case-insensitive substring match against the document filename. |
--enabled-filter <value> | No | Filter by whether documents are enabled for search. Accepted values: all, enabled, disabled. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--tag-filters <value> | 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
Update Document (OAuth login or personal API key required)
agentserve knowledge documents update <knowledgeBaseId> <documentId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
documentId | Yes | Unique knowledge document identifier. |
Options
| Option | Required | Description |
|---|---|---|
--filename <value> | 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 <value> | No | New value for tag slot 1. |
--tag2 <value> | No | New value for tag slot 2. |
--tag3 <value> | No | New value for tag slot 3. |
--tag4 <value> | No | New value for tag slot 4. |
--tag5 <value> | No | New value for tag slot 5. |
--tag6 <value> | No | New value for tag slot 6. |
--tag7 <value> | No | New value for tag slot 7. |
--number1 <value> | No | New value for number tag slot 1. |
--number2 <value> | No | New value for number tag slot 2. |
--number3 <value> | No | New value for number tag slot 3. |
--number4 <value> | No | New value for number tag slot 4. |
--number5 <value> | No | New value for number tag slot 5. |
--date1 <value> | No | New value for date tag slot 1, formatted YYYY-MM-DD. |
--date2 <value> | 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
Upload a document to a knowledge base
agentserve knowledge documents upload <knowledgeBaseId> <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Knowledge base to upload into |
path | Yes | Local file to upload |
Options
| Option | Required | Description |
|---|---|---|
--name <name> | No | Store it under a different name. |
--tag <value...> | No | Document tags, in tag1 through tag7 order. |
--recipe <name> | No | Document processing recipe. Accepted values: default, plain, markdown, code. |
--lang <code> | No | Document language tag: hyphen-separated letter and digit subtags, for example en or en-US. |
agentserve knowledge create
Create Knowledge Base
agentserve knowledge create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Human-readable knowledge base name. |
--description <value> | No | Optional knowledge base description. |
--chunking-config <json|@file> | No | Chunking configuration; defaults are applied when omitted. (JSON, or @path / @- to read a file or stdin). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
agentserve knowledge connectors create
Create Knowledge Connector (OAuth login or personal API key required)
agentserve knowledge connectors create <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--connector-type <value> | Yes | Registered connector type. |
--credential-id <value> | No | OAuth credential identifier for connectors that require OAuth. |
--api-key <value> | No | Write-only API key for connectors that use API-key authentication. |
--source-config <json|@file> | Yes | Connector-specific source selection and filtering configuration. (JSON, or @path / @- to read a file or stdin). |
--sync-interval-minutes <value> | No | Scheduled synchronization interval in minutes; zero disables scheduling. |
agentserve knowledge connectors delete
Delete Knowledge Connector (OAuth login or personal API key required)
agentserve knowledge connectors delete <knowledgeBaseId> <connectorId> [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
Get Knowledge Connector (OAuth login or personal API key required)
agentserve knowledge connectors get <knowledgeBaseId> <connectorId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Knowledge base that owns the connector. |
connectorId | Yes | Connector selected for the operation. |
agentserve knowledge connectors documents list
List Knowledge Connector Documents (OAuth login or personal API key required)
agentserve knowledge connectors documents list <knowledgeBaseId> <connectorId> [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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve knowledge connectors documents update
Update Knowledge Connector Documents (OAuth login or personal API key required)
agentserve knowledge connectors documents update <knowledgeBaseId> <connectorId> [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 <value> | Yes | Whether to restore or exclude the selected documents. Accepted values: restore, exclude. |
--document <value...> | Yes | Connector document identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
agentserve knowledge connectors list
List Knowledge Connectors (OAuth login or personal API key required)
agentserve knowledge connectors list <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--sort-by <value> | No | Field used to sort the result. Accepted values: connectorType, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve knowledge connectors sync
Queue a knowledge connector synchronization (OAuth login or personal API key required)
agentserve knowledge connectors sync <knowledgeBaseId> <connectorId> [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
Update Knowledge Connector (OAuth login or personal API key required)
agentserve knowledge connectors update <knowledgeBaseId> <connectorId> [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 <json|@file> | 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 <value> | No | New scheduled synchronization interval in minutes. |
--status <value> | No | New connector state. Accepted values: active, paused. |
agentserve knowledge folders create
Create a knowledge folder at a path
agentserve knowledge folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path as shown in the app; the leading / is optional |
agentserve knowledge folders delete
Delete Folder
agentserve knowledge folders delete <path> [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
List knowledge folders
agentserve knowledge folders list [options]Also available as agentserve knowledge folders ls.
Options
| Option | Required | Description |
|---|---|---|
--parent <value> | No | Direct parent folder path. |
--search <value> | No | Case-insensitive substring match against the folder name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve knowledge folders move
Rename or move a knowledge folder
agentserve knowledge folders move <path> <destination>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
Delete Knowledge Base
agentserve knowledge delete <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve knowledge get
Get Knowledge Base
agentserve knowledge get <knowledgeBaseId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
agentserve knowledge list
List Knowledge Bases
agentserve knowledge list [options]Options
| Option | Required | Description |
|---|---|---|
--scope <value> | 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 <value> | No | Folder path as shown in the app; the leading / is optional. |
--search <value> | No | Case-insensitive substring match against the resource name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve knowledge restore
Restore an archived knowledge base
agentserve knowledge restore <knowledgeBaseId>Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
agentserve knowledge search
Search Knowledge
agentserve knowledge search [options]Options
| Option | Required | Description |
|---|---|---|
--kb <value...> | Yes | Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--query <value> | No | Text to search for. |
--top-k <value> | No | Maximum number of search results to return. Must be a whole number between 1 and 100. |
--tag-filters <json|@file> | No | Tag filters as [{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin). |
--search-mode <value> | 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 <json|@file> | 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 <value> | 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
Update Knowledge Base
agentserve knowledge update <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Unique knowledge base identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | New knowledge base name. |
--description <value> | No | New knowledge base description. |
--chunking-config <json|@file> | No | New document chunking configuration. (JSON, or @path / @- to read a file or stdin). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
agentserve knowledge mv
Move a knowledge base to a folder
agentserve knowledge mv <knowledgeBaseId> <folder>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
Export a knowledge base as a .agentservekb.zip bundle
agentserve knowledge export <knowledgeBaseId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
knowledgeBaseId | Yes | Knowledge base to export |
Options
| Option | Required | Description |
|---|---|---|
-o, --output-file <path> | 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
List knowledge resources and child folders together
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 <text> | No | Filter folders and resources by name. |
--limit <n> | No | Maximum combined items to return (0 for everything). Defaults to 0. |
agentserve knowledge mkdir
Create a knowledge directory at a path
agentserve knowledge mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
agentserve logs
Also spelled agentserve log.
agentserve logs get
Show run diagnostics
agentserve logs get <runId> [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
Summarize run counts, failures and latency over a window
agentserve logs stats [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <value...> | 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 <value...> | 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 <value...> | 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 <value> | No | Severity level to include. Accepted values: info, error. |
--start-date <value> | 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 <value> | 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 <value> | 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
List run logs, such as failed or errored runs, by workflow, trigger or time
agentserve logs list [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <value...> | 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 <value...> | 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 <value> | No | Severity level to include. Accepted values: info, error. |
--start-date <value> | 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 <value> | 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 <value> | 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 <value> | 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 <value> | 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 <value> | 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 <value> | No | AI model used during execution. |
--details <value> | 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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--status <value> | 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 <value> | 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 <value> | No | Exact run identifier to match. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--folder <value...> | 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
Watch runs live as they arrive, printing each new run once
agentserve logs follow [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <id> | No | Only follow runs of this workflow (repeatable). |
--folder <path> | No | Only follow runs of workflows in this folder (repeatable). |
--trigger <type> | No | Only follow runs with this trigger type (repeatable). |
--level <level> | No | Only follow runs at this severity. Accepted values: info, error. |
--details <level> | No | Response detail level; full names each run’s workflow. Accepted values: basic, full. Defaults to full. |
-n, --lines <count> | No | Recent runs to print before watching. Defaults to 10. |
--interval <seconds> | No | Seconds between polls. Defaults to 3. |
agentserve mcp-servers
Also spelled agentserve mcp-server.
agentserve mcp-servers create
Create MCP Server
agentserve mcp-servers create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Server display name. |
--description <value> | No | Optional server description. |
--transport <value> | No | Transport protocol. Defaults to streamable-http on creation. Accepted values: streamable-http. |
--url <value> | 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 <value> | 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 <json|@file> | 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 <value> | No | Per-request timeout in milliseconds. Defaults to 30000 on creation. |
--retries <value> | 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 <value> | No | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization. |
--oauth-client-secret <value> | 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
Delete MCP Server
agentserve mcp-servers delete <mcpServerId> [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
Get MCP Server
agentserve mcp-servers get <mcpServerId>Arguments
| Argument | Required | Description |
|---|---|---|
mcpServerId | Yes | Unique MCP server identifier. |
agentserve mcp-servers list
List MCP Servers
agentserve mcp-servers list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the server name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve mcp-servers tools list
List MCP Server Tools (OAuth login or personal API key required)
agentserve mcp-servers tools list <mcpServerId> [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
Update MCP Server
agentserve mcp-servers update <mcpServerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
mcpServerId | Yes | Unique MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Server display name. |
--description <value> | No | Optional server description. |
--transport <value> | No | Transport protocol. Defaults to streamable-http on creation. Accepted values: streamable-http. |
--url <value> | No | Immutable server URL. When provided, it must equal the current URL; use delete and create to change endpoints. |
--auth-type <value> | 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 <json|@file> | 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 <value> | No | Per-request timeout in milliseconds. Defaults to 30000 on creation. |
--retries <value> | 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 <value> | No | Pre-registered OAuth client identifier. Changing it on update revokes the stored OAuth grant and forces reauthorization. |
--oauth-client-secret <value> | 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 status
Show what this API supports and which limits apply
agentserve meta statusagentserve organizations
agentserve organizations domains add
Add Organization Domain (OAuth login or personal API key required)
agentserve organizations domains add [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--domain <value> | Yes | Domain to claim and verify through a DNS TXT record. |
agentserve organizations domains list
List Organization Domains (OAuth login or personal API key required)
agentserve organizations domains list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
--sort-by <value> | No | Field used to sort the result. Accepted values: domain. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve organizations domains remove
Remove Organization Domain (OAuth login or personal API key required)
agentserve organizations domains remove <domainId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
domainId | Yes | Domain claim owned by this organization. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
-y, --yes | Yes | Confirm this operation. |
agentserve organizations domains verify
Verify Organization Domain (OAuth login or personal API key required)
agentserve organizations domains verify <domainId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
domainId | Yes | Domain claim owned by this organization. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations access-requests cancel
Cancel Organization Access Request (OAuth login or personal API key required)
agentserve organizations access-requests cancel <requestId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
requestId | Yes | Access request identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations access-requests create
Create Organization Access Request (OAuth login or personal API key required)
agentserve organizations access-requests create [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--target <json|@file> | 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 <value> | No | Why the acting user needs this access. |
agentserve organizations access-requests discover
Discover Organization Access Requests (OAuth login or personal API key required)
agentserve organizations access-requests discover [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against the access item label. |
--target-kind <value> | No | Category of access to discover. Accepted values: feature, integration, provider, model, tool, knowledge_connector, file_share_auth, chat_deploy_auth, usage_limit. |
--state <value> | No | Filter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: allowed, requestable, unavailable. |
--sort-by <value> | No | Field used to sort the result. Accepted values: label. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve organizations access-requests settings get
Get Organization Access Request Settings (OAuth login or personal API key required)
agentserve organizations access-requests settings get [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations access-requests settings update
Update Organization Access Request Settings (OAuth login or personal API key required)
agentserve organizations access-requests settings update [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--allow-requests <true|false> | 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
List My Organization Access Requests (OAuth login or personal API key required)
agentserve organizations access-requests mine [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--status <value> | No | Filter by request status; omit to include all statuses. Accepted values: pending, fulfilled, declined, cancelled, closed. |
--sort-by <value> | No | Field used to sort the result. Accepted values: createdAt, targetLabel. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve organizations access-requests list
List Organization Access Requests (OAuth login or personal API key required)
agentserve organizations access-requests list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--status <value> | No | Filter by request status; omit to include all statuses. Accepted values: pending, fulfilled, declined, cancelled, closed. |
--sort-by <value> | No | Field used to sort the result. Accepted values: createdAt, targetLabel. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--search <value> | No | Case-insensitive substring match against the target label or requester name or email. |
agentserve organizations access-requests preview
Preview Organization Access Request (OAuth login or personal API key required)
agentserve organizations access-requests preview <requestId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
requestId | Yes | Access request identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations access-requests resolve
Resolve Organization Access Request (OAuth login or personal API key required)
agentserve organizations access-requests resolve <requestId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
requestId | Yes | Access request identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--action <value> | 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 <value> | 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 <value> | 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 <value> | No | Required explanation for declining this request. Available when action is decline. Required when action is decline. |
agentserve organizations invitations create
Create Organization Invitation (OAuth login or personal API key required)
agentserve organizations invitations create [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--email <value> | Yes | Email address of the person to invite. |
--role <value> | No | Organization role to offer. Defaults to member; grants no workspace-specific permissions. Accepted values: member, admin. |
agentserve organizations invitations get
Get Organization Invitation (OAuth login or personal API key required)
agentserve organizations invitations get <invitationId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
invitationId | Yes | Invitation identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations invitations list
List Organization Invitations (OAuth login or personal API key required)
agentserve organizations invitations list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against the invitee email. |
--status <value> | No | Filter by current invitation status. Omit to include all statuses. Accepted values: pending, accepted, rejected, cancelled, expired. |
--sort-by <value> | No | Field used to sort the result. Accepted values: email, createdAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve organizations invitations workspaces
List Organization Invitation Workspaces (OAuth login or personal API key required)
agentserve organizations invitations workspaces <invitationId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
invitationId | Yes | Invitation identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against the workspace name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve organizations invitations resend
Resend Organization Invitation (OAuth login or personal API key required)
agentserve organizations invitations resend <invitationId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
invitationId | Yes | Invitation identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations invitations revoke
Revoke Organization Invitation (OAuth login or personal API key required)
agentserve organizations invitations revoke <invitationId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
invitationId | Yes | Invitation identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
-y, --yes | Yes | Confirm this operation. |
agentserve organizations sso providers delete
Delete SSO Provider (OAuth login or personal API key required)
agentserve organizations sso providers delete <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | Identity provider identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
-y, --yes | Yes | Confirm this operation. |
agentserve organizations sso providers get
Get SSO Provider (OAuth login or personal API key required)
agentserve organizations sso providers get <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | Identity provider identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations sso providers list
List SSO Providers (OAuth login or personal API key required)
agentserve organizations sso providers list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
--sort-by <value> | No | Field used to sort the result. Accepted values: providerId, domain. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve organizations sso providers save
Save SSO Provider (OAuth login or personal API key required)
agentserve organizations sso providers save [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--provider-type <value> | Yes | oidc: Configure an OpenID Connect identity provider. saml: Configure a SAML identity provider. Accepted values: oidc, saml. |
--provider-id <value> | Yes | Globally unique provider ID; saving an existing provider replaces its supplied configuration. |
--issuer <value> | Yes | Identity provider issuer URL. |
--domain <value> | 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 <json|@file> | No | Identity-provider claims mapped to user fields. (JSON, or @path / @- to read a file or stdin). |
--client-id <value> | No | Identity provider client identifier. Available when providerType is oidc. Required when providerType is oidc. |
--client-secret <value|@file> | 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 <json|@file> | 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 <value> | No | Optional authorization endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc. |
--token-endpoint <value> | No | Optional token endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc. |
--user-info-endpoint <value> | 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 <value> | No | Optional signing-key endpoint; otherwise resolved through issuer discovery. Available when providerType is oidc. |
--entry-point <value> | No | Identity provider SAML sign-in endpoint. Available when providerType is saml. Required when providerType is saml. |
--cert <value> | No | Identity provider signing certificate. Available when providerType is saml. Required when providerType is saml. |
--callback-url <value> | No | SAML callback URL; defaults to this provider’s Agent Serve callback. Available when providerType is saml. |
--audience <value> | 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 <value> | No | Signature algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml. |
--digest-algorithm <value> | No | Digest algorithm accepted by the SAML configuration validator; omission preserves the saved value. Available when providerType is saml. |
--identifier-format <value> | No | SAML NameID format; omission clears the saved value. Available when providerType is saml. |
--idp-metadata <value> | No | Identity provider metadata XML; omission clears the saved document. Available when providerType is saml. |
agentserve organizations sso providers primary
Set Primary SSO Provider (OAuth login or personal API key required)
agentserve organizations sso providers primary <providerId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
providerId | Yes | Identity provider identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations sso policy get
Get SSO Policy (OAuth login or personal API key required)
agentserve organizations sso policy get [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve organizations sso policy update
Update SSO Policy (OAuth login or personal API key required)
agentserve organizations sso policy update [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--require-sso <true|false> | Yes | Require organization SSO on future sign-ins; existing sessions remain active. Accepted values: true, false. |
agentserve organizations get
Get Organization (OAuth login or personal API key required)
agentserve organizations get <organizationId>Arguments
| Argument | Required | Description |
|---|---|---|
organizationId | Yes | Organization identifier. |
agentserve organizations members usage-limit get
Get Organization Member Credit Limit (OAuth login or personal API key required)
agentserve organizations members usage-limit get <userId> [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 <value> | Yes | Organization identifier. |
agentserve organizations members usage-limit update
Update Organization Member Credit Limit (OAuth login or personal API key required)
agentserve organizations members usage-limit update <userId> [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 <value> | Yes | Organization identifier. |
--credit-limit <number|null> | 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
List Organization Members (OAuth login or personal API key required)
agentserve organizations members list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against member name or email. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve organizations members remove
Remove Organization Member (OAuth login or personal API key required)
agentserve organizations members remove <userId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
userId | Yes | User identifier of the organization member. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
-y, --yes | Yes | Confirm this operation. |
agentserve organizations members update
Update Organization Member (OAuth login or personal API key required)
agentserve organizations members update <userId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
userId | Yes | User identifier of the organization member. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--role <value> | Yes | New organization role. Ownership transfers use a separate operation. Accepted values: member, admin. |
agentserve organizations usage breakdown
Get Organization Usage Breakdown (OAuth login or personal API key required)
agentserve organizations usage breakdown [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--preset <value> | 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 <value> | No | First calendar date included, in the selected timezone. Requires preset=custom. |
--end-date <value> | No | Last calendar date included, in the selected timezone. Requires preset=custom. |
--timezone <value> | No | IANA timezone for calendar boundaries; defaults to UTC. |
--dimension <value> | Yes | Usage grouping dimension. Accepted values: member, workspace, workflow, model, byok, source. |
--limit <value> | 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
Get Organization Usage Summary (OAuth login or personal API key required)
agentserve organizations usage summary [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--preset <value> | 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 <value> | No | First calendar date included, in the selected timezone. Requires preset=custom. |
--end-date <value> | No | Last calendar date included, in the selected timezone. Requires preset=custom. |
--timezone <value> | No | IANA timezone for calendar boundaries; defaults to UTC. |
agentserve organizations usage events
List Organization Usage Events (OAuth login or personal API key required)
agentserve organizations usage events [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--preset <value> | 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 <value> | No | First calendar date included, in the selected timezone. Requires preset=custom. |
--end-date <value> | No | Last calendar date included, in the selected timezone. Requires preset=custom. |
--timezone <value> | No | IANA timezone for calendar boundaries; defaults to UTC. |
--source <value> | 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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--sort-by <value> | No | Field used to sort the result. Accepted values: createdAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve organizations list
List Organizations (OAuth login or personal API key required)
agentserve organizations list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the organization name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve organizations workspaces
List Organization Workspaces (OAuth login or personal API key required)
agentserve organizations workspaces [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against the workspace name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve permission-groups
Also spelled agentserve permission-group.
agentserve permission-groups members add
Add Permission Group Member (OAuth login or personal API key required)
agentserve permission-groups members add [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
--user <value> | Yes | Existing organization member to add. |
agentserve permission-groups members batch-add
Bulk Add Permission Group Members (OAuth login or personal API key required)
agentserve permission-groups members batch-add [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
--user <value...> | 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
List Permission Group Members (OAuth login or personal API key required)
agentserve permission-groups members list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
--sort-by <value> | No | Field used to sort the result. Accepted values: assignedAt, userId. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve permission-groups members remove
Remove Permission Group Member (OAuth login or personal API key required)
agentserve permission-groups members remove <userId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
userId | Yes | User identifier of the member to remove. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--group <value> | Yes | Permission group identifier. |
-y, --yes | Yes | Confirm this operation. |
agentserve permission-groups create
Create Permission Group (OAuth login or personal API key required)
agentserve permission-groups create [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--name <value> | Yes | Group name, unique within the organization. |
--description <value> | No | Optional group description. |
--config <json|@file> | 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 <json|@file> | 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 <json|@file> | 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
Delete Permission Group (OAuth login or personal API key required)
agentserve permission-groups delete <groupId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
groupId | Yes | Permission group identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
-y, --yes | Yes | Confirm this operation. |
agentserve permission-groups get
Get Permission Group (OAuth login or personal API key required)
agentserve permission-groups get <groupId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
groupId | Yes | Permission group identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
agentserve permission-groups list
List Permission Groups (OAuth login or personal API key required)
agentserve permission-groups list [options]Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--search <value> | No | Case-insensitive substring match against the group name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve permission-groups update
Update Permission Group (OAuth login or personal API key required)
agentserve permission-groups update <groupId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
groupId | Yes | Permission group identifier. |
Options
| Option | Required | Description |
|---|---|---|
--organization <value> | Yes | Organization identifier. |
--name <value> | No | Group name, unique within the organization. |
--description <value> | No | Group description. Null or an empty string clears it; omission leaves it unchanged. (--description null sends the word, not JSON null). |
--config <json|@file> | 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 <json|@file> | 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 <json|@file> | 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 tasks create
Assign Relay Task (OAuth login or personal API key required)
agentserve relays tasks create [options]Options
| Option | Required | Description |
|---|---|---|
--relay <value> | Yes | The Relay, by name (unique within the workspace). |
--title <value> | Yes | Short title of the task. |
--objective <value> | Yes | What the Relay should do. |
--acceptance <value> | No | How to tell the task is done. |
agentserve sandboxes
Also spelled agentserve sandbox.
agentserve sandboxes create
Create Sandbox (OAuth login or personal API key required)
agentserve sandboxes create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Display name, unique within the workspace; 1 to 64 characters. |
--language <value> | Yes | Dependency ecosystem: javascript installs from npm, python from PyPI. Accepted values: javascript, python. |
--dependencies <value...> | 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 <value...> | 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 <value...> | 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
Delete Sandbox (OAuth login or personal API key required)
agentserve sandboxes delete <sandboxId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
sandboxId | Yes | Unique sandbox identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve sandboxes get
Get Sandbox
agentserve sandboxes get <sandboxId>Arguments
| Argument | Required | Description |
|---|---|---|
sandboxId | Yes | Unique sandbox identifier. |
agentserve sandboxes list
List Sandboxes
agentserve sandboxes list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the sandbox name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve sandboxes update
Update Sandbox (OAuth login or personal API key required)
agentserve sandboxes update <sandboxId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
sandboxId | Yes | Unique sandbox identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | New display name, unique within the workspace; 1 to 64 characters. |
--language <value> | 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 <value...> | 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 <value...> | 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 <value...> | 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
Also spelled agentserve secret.
agentserve secrets delete
Delete Secret (OAuth login or personal API key required)
agentserve secrets delete <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret to delete. |
Options
| Option | Required | Description |
|---|---|---|
--scope <value> | 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
List Secrets (OAuth login or personal API key required)
agentserve secrets list [options]Options
| Option | Required | Description |
|---|---|---|
--scope <value> | No | Restrict results to one ownership scope. Accepted values: workspace, personal. |
--search <value> | No | Case-insensitive substring match against the secret name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve secrets set
Create or replace a named secret, such as an API key or environment variable (OAuth login or personal API key required)
agentserve secrets set <name> [options]Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret name, as referenced in workflows |
Options
| Option | Required | Description |
|---|---|---|
--scope <scope> | Yes | Secret ownership scope. Accepted values: workspace, personal. |
--value <value|@file> | 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 <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 get
Get Selector Option (OAuth login or personal API key required)
agentserve selectors get [options]Options
| Option | Required | Description |
|---|---|---|
--selector-key <value> | 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 <json|@file> | 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 <value> | Yes | Resource identifier. |
agentserve selectors list
List Selector Options (OAuth login or personal API key required)
agentserve selectors list [options]Options
| Option | Required | Description |
|---|---|---|
--selector-key <value> | 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 <json|@file> | 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 <value> | No | Provider option search text. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
agentserve semantic-model
agentserve semantic-model query
Query Semantic Model (OAuth login or personal API key required)
agentserve semantic-model query [options]Options
| Option | Required | Description |
|---|---|---|
--source <value> | 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 <json|@file> | Yes | Measures to compute. (JSON, or @path / @- to read a file or stdin). |
--dimensions <json|@file> | No | Attributes to group by. (JSON, or @path / @- to read a file or stdin). |
--where <json|@file> | No | Equality conditions keyed by entity.attribute, all of which must hold. (JSON, or @path / @- to read a file or stdin). |
--sort <json|@file> | No | Sort order of the result rows. (JSON, or @path / @- to read a file or stdin). |
--limit <value> | No | Most rows to return. Defaults to 100. |
agentserve skills
Also spelled agentserve skill.
agentserve skills create
Create Skill (OAuth login or personal API key required)
agentserve skills create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Kebab-case name, unique within the workspace and not reserved by a built-in skill. |
--description <value> | Yes | One-line summary of when the skill applies. |
--content <value> | Yes | Skill body containing the instructions given to the agent. |
agentserve skills delete
Delete Skill (OAuth login or personal API key required)
agentserve skills delete <skillId> [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
Get Skill
agentserve skills get <skillId>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
Grant Skill Editor (OAuth login or personal API key required)
agentserve skills editors create <skillId> [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 <value> | Yes | Email address of a current workspace member. |
agentserve skills editors list
List Skill Editors
agentserve skills editors list <skillId> [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 <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve skills editors delete
Revoke Skill Editor (OAuth login or personal API key required)
agentserve skills editors delete <skillId> [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 <value> | Yes | Email address of a current workspace member. |
-y, --yes | Yes | Confirm this operation. |
agentserve skills list
List Skills
agentserve skills list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the skill name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve skills update
Update Skill (OAuth login or personal API key required)
agentserve skills update <skillId> [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 <value> | No | New kebab-case skill name. |
--description <value> | No | New one-line summary of when the skill applies. |
--content <value> | No | Replacement skill body. |
agentserve slides
agentserve slides export
Export Presentation
agentserve slides export <docId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
docId | Yes | The deck to export. |
Options
| Option | Required | Description |
|---|---|---|
--format <value> | Yes | pptx for PowerPoint, pdf for a PDF of the slides. Accepted values: pptx, pdf. |
agentserve slides jobs get
Get Slides Job
agentserve slides jobs get <jobId>Arguments
| Argument | Required | Description |
|---|---|---|
jobId | Yes | Job identifier. |
agentserve slides templates list
List Slides Templates
agentserve slides templates listagentserve slides presentations create
Start Presentation (OAuth login or personal API key required)
agentserve slides presentations create [options]Options
| Option | Required | Description |
|---|---|---|
--space-id <value> | Yes | Space the new deck is created in. |
--title <value> | Yes | Title of the new deck. |
--content <value> | Yes | What the deck should say: the audience, the story and the facts to use. |
--n-slides <value> | No | How many slides to write. The Slides AI decides when omitted. |
--template-id <value> | No | Template to lay the deck out with, from List Slides Templates. Default general. |
--language <value> | No | Language to write the slides in, for example English or Deutsch. |
--tone <value> | No | Tone of the writing, for example formal or casual. |
--instructions <value> | No | Further instructions for the Slides AI. |
--file-ids <json|@file> | 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 <value> | 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 docs get
Get Space Doc
agentserve spaces docs get <spaceId> <docId>Arguments
| Argument | Required | Description |
|---|---|---|
spaceId | Yes | Space identifier. |
docId | Yes | Doc identifier. |
agentserve spaces docs list
List Space Docs
agentserve spaces docs list <spaceId>Arguments
| Argument | Required | Description |
|---|---|---|
spaceId | Yes | Space identifier. |
agentserve spaces list
List Spaces
agentserve spaces listagentserve tables
Also spelled agentserve table.
agentserve tables columns create
Add Column
agentserve tables columns create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--column <json|@file> | Yes | Column definition to add. (JSON, or @path / @- to read a file or stdin). |
agentserve tables columns delete
Delete Column
agentserve tables columns delete <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--column-name <value> | Yes | Name of the column to delete. |
-y, --yes | Yes | Confirm this operation. |
agentserve tables columns update
Update Column
agentserve tables columns update <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--column-name <value> | Yes | Current name of the column to update. |
--updates <json|@file> | Yes | Mutable column fields. (JSON, or @path / @- to read a file or stdin). |
agentserve tables groups create
Add Workflow Group
agentserve tables groups create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--group <json|@file> | Yes | Workflow or enrichment producer definition. (JSON, or @path / @- to read a file or stdin). |
--output-columns <json|@file> | 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
Delete Workflow Group
agentserve tables groups delete <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--group-id <value> | Yes | Workflow group to delete. |
-y, --yes | Yes | Confirm this operation. |
agentserve tables groups list
List Workflow Groups
agentserve tables groups list <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
agentserve tables groups update
Update Workflow Group
agentserve tables groups update <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--group-id <value> | Yes | Workflow group to update. |
--workflow-id <value> | No | Replacement backing workflow identifier. |
--name <value> | No | Replacement workflow-group display name. |
--dependencies <json|@file> | No | Replacement input dependencies. (JSON, or @path / @- to read a file or stdin). |
--outputs <json|@file> | No | Replacement producer outputs. (JSON, or @path / @- to read a file or stdin). |
--new-output-columns <json|@file> | No | Columns to add for new outputs. (JSON, or @path / @- to read a file or stdin). |
--mapping-updates <json|@file> | No | Existing output-column mapping changes. (JSON, or @path / @- to read a file or stdin). |
--input-mappings <json|@file> | No | Replacement workflow input mappings. (JSON, or @path / @- to read a file or stdin). |
--deployment-mode <value> | No | Replacement workflow execution mode. Accepted values: live, deployed. |
--type <value> | 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
Bulk Delete Tables and Folders
agentserve tables batch-delete [options]Options
| Option | Required | Description |
|---|---|---|
--table-ids <json|@file> | No | Tables to archive, by identifier. (JSON, or @path / @- to read a file or stdin). |
--folder <value...> | 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
Apply a distinct patch to each listed row
agentserve tables rows update-each <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--updates <json|@file> | 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
Create Rows
agentserve tables rows create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--data <json|@file> | No | One row keyed by column name (JSON, or @path / @-; choose exactly one body flag). |
--rows <json|@file> | No | Several rows keyed by column name (JSON, or @path / @-; choose exactly one body flag). |
agentserve tables rows delete
Delete Row
agentserve tables rows delete <tableId> <rowId> [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
Delete rows matching a filter, or an explicit list of ids
agentserve tables rows batch-delete <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--filter <json|@file> | 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 <value> | 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 <value...> | 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
Get Row
agentserve tables rows get <tableId> <rowId> [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
List Rows
agentserve tables rows list <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | 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
Query rows with a filter and sort
agentserve tables rows query <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--filter <json|@file> | 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 <json|@file> | No | Ordered sort keys: [{"field":"createdAt","direction":"desc"}] (direction: asc or desc) (JSON, or @path / @- to read a file or stdin). |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | 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
Count rows matching a filter
agentserve tables rows count <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--filter <json|@file> | 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
Run one row’s enrichment group
agentserve tables rows enrich <tableId> <rowId> <groupId>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
Search cells for a value and return their coordinates
agentserve tables rows search <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--query <value> | Yes | Value to search for. |
--filter <json|@file> | 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 <json|@file> | 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
Update every row matching a filter
agentserve tables rows batch-update <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--filter <json|@file> | 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 <json|@file> | Yes | Row-data patch applied to every matching row. (JSON, or @path / @- to read a file or stdin). |
--limit <value> | 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
Update Row
agentserve tables rows update <tableId> <rowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
rowId | Yes | Unique table row identifier. |
Options
| Option | Required | Description |
|---|---|---|
--data <json|@file> | Yes | Partial row-data patch keyed by column name. (JSON, or @path / @- to read a file or stdin). |
agentserve tables dispatches cancel
Cancel a running dispatch
agentserve tables dispatches cancel <tableId> <dispatchId> [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
Start a column or enrichment run
agentserve tables dispatches create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--group-ids <value...> | Yes | Workflow or enrichment groups to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--run-mode <value> | No | Whether to run all or only incomplete cells. Accepted values: all, incomplete. |
--row-ids <value...> | No | Explicit row subset to run. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--filter <json|@file> | 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 <value...> | 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 <n> | No | Stop after this many eligible rows have run (1-1,000,000). Omit for an unbounded run. |
agentserve tables dispatches get
Get Run Dispatch
agentserve tables dispatches get <tableId> <dispatchId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
dispatchId | Yes | Unique table run-dispatch identifier. |
agentserve tables dispatches list
List Active Run Dispatches
agentserve tables dispatches list <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
agentserve tables exports cancel
Stop a running export
agentserve tables exports cancel <tableId> <exportId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
exportId | Yes | Unique table-export identifier. |
agentserve tables exports create
Create Table Export
agentserve tables exports create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--format <value> | No | Export file format. Accepted values: csv, json. |
agentserve tables exports get
Get Table Export
agentserve tables exports get <tableId> <exportId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
exportId | Yes | Unique table-export identifier. |
agentserve tables exports download
Get the download URL for a finished export
agentserve tables exports download <tableId> <exportId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
exportId | Yes | Unique table-export identifier. |
agentserve tables imports cancel
Stop a running import
agentserve tables imports cancel <importId> [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
Get Table Import
agentserve tables imports get <importId>Arguments
| Argument | Required | Description |
|---|---|---|
importId | Yes | Unique table-import identifier. |
agentserve tables cancel-runs
Stop every running column job
agentserve tables cancel-runs <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--scope <value> | Yes | Whether to cancel across the table or one row. Accepted values: all, row. |
--row-id <value> | No | Row whose runs should be canceled for row scope. |
--filter <json|@file> | 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 <value...> | 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
Create Table
agentserve tables create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Identifier: letters, numbers, and underscores; cannot start with a number. |
--description <value> | No | Optional table description. |
--schema <json|@file> | Yes | Table schema: {"columns":[{"name":"email","type":"string"}]} (JSON, or @path / @- to read a file or stdin). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
agentserve tables folders create
Create a table folder at a path
agentserve tables folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path as shown in the app; the leading / is optional |
agentserve tables folders delete
Delete Folder
agentserve tables folders delete <path> [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
List table folders
agentserve tables folders list [options]Also available as agentserve tables folders ls.
Options
| Option | Required | Description |
|---|---|---|
--parent <value> | No | Direct parent folder path. |
--search <value> | No | Case-insensitive substring match against the folder name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve tables folders move
Rename or move a table folder
agentserve tables folders move <path> <destination>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
Restore an archived table folder
agentserve tables folders restore <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path as shown in the app; the leading / is optional |
agentserve tables views create
Create View
agentserve tables views create <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Saved-view display name. |
--config <json|@file> | Yes | Saved filter, sort, and column-layout configuration. (JSON, or @path / @- to read a file or stdin). |
agentserve tables views delete
Delete View
agentserve tables views delete <tableId> <viewId> [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
Get View
agentserve tables views get <tableId> <viewId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
viewId | Yes | Unique saved-view identifier. |
agentserve tables views list
List Views
agentserve tables views list <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
agentserve tables views update
Update View
agentserve tables views update <tableId> <viewId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
viewId | Yes | Unique saved-view identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Replacement saved-view display name. |
--config <json|@file> | No | Complete replacement saved-view configuration. (JSON, or @path / @- to read a file or stdin). |
--config-patch <json|@file> | 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
Delete Table
agentserve tables delete <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve tables enrichment get
Get Enrichment Run Detail
agentserve tables enrichment get <tableId> <rowId> <groupId>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
Get Table
agentserve tables get <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
agentserve tables list
List Tables
agentserve tables list [options]Options
| Option | Required | Description |
|---|---|---|
--scope <value> | 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 <value> | No | Folder path as shown in the app; the leading / is optional. |
--search <value> | No | Case-insensitive substring match against the resource name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve tables move
Move Tables and Folders
agentserve tables move [options]Options
| Option | Required | Description |
|---|---|---|
--table-ids <json|@file> | No | Tables to move, by identifier. (JSON, or @path / @- to read a file or stdin). |
--folder <value...> | 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 <value> | No | Destination folder path; omit for root. |
agentserve tables restore
Restore an archived table
agentserve tables restore <tableId>Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
agentserve tables update
Update Table
agentserve tables update <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Identifier: letters, numbers, and underscores; cannot start with a number. |
--description <value> | No | Replacement table description, or null to clear it. (--description null sends the word, not JSON null). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
agentserve tables mv
Move a table to a folder
agentserve tables mv <tableId> <folder>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
Insert a row, or update the one that conflicts on a unique column
agentserve tables upsert <tableId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
tableId | Yes | Unique table identifier. |
Options
| Option | Required | Description |
|---|---|---|
--data <json|@file> | 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 <value> | No | Unique column to resolve the conflict against. |
agentserve tables import
Import a CSV, into a new table by default
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 <name> | No | Identifier for the new table: letters, numbers, and underscores; defaults to the sanitized file name. |
--table-id <id> | No | Import into this existing table instead of creating one. |
--mode <append|replace> | No | How to write into --table-id (default: append). Accepted values: append, replace. |
--folder <path> | No | Folder path for the new table, as shown in the app. |
--file-id <id> | No | Import a file already in the workspace instead of a local path. |
--mapping <json|@file> | No | Column mapping (--table-id only). |
--create-columns <json|@file> | No | Columns to create (--table-id only). |
--timezone <iana> | 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
List table resources and child folders together
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 <text> | No | Filter folders and resources by name. |
--limit <n> | No | Maximum combined items to return (0 for everything). Defaults to 0. |
agentserve tables mkdir
Create a table directory at a path
agentserve tables mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
agentserve tools
agentserve tools execute
Run one built-in tool and print what it produced (OAuth login or personal API key required)
agentserve tools execute <toolId> [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 <json|@file> | 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 <value> | No | Credential to authenticate with, required for OAuth tools. |
--timeout <value> | No | Seconds to wait before abandoning the call. |
agentserve tools get
Get Tool
agentserve tools get <toolId>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
List Tools
agentserve tools list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the tool id, name, and description. |
--hosted-api-key <value> | No | Restrict to tools by how their API key is supplied. Accepted values: always, conditional, none. |
--oauth-provider <value> | No | Restrict to tools that authenticate against this OAuth service. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve workflow-mcp-servers
agentserve workflow-mcp-servers create
Create Workflow MCP Server (OAuth login or personal API key required)
agentserve workflow-mcp-servers create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Server display name, shown to connecting MCP clients. |
--description <value> | 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 <value...> | 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
Delete Workflow MCP Server (OAuth login or personal API key required)
agentserve workflow-mcp-servers delete <serverId> [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
Publish Workflow As MCP Tool (OAuth login or personal API key required)
agentserve workflow-mcp-servers tools create <serverId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow-id <value> | Yes | Deployed workflow to publish. The workflow must already be deployed. |
--tool-name <value> | No | Name MCP clients call. Normalized to the MCP tool-name grammar, and derived from the workflow name when omitted. |
--tool-description <value> | No | Description shown to MCP clients. Derived from the workflow name when omitted. |
--parameter-descriptions <json|@file> | 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
List Workflow MCP Tools (OAuth login or personal API key required)
agentserve workflow-mcp-servers tools list <serverId>Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
agentserve workflow-mcp-servers tools delete
Unpublish Workflow MCP Tool (OAuth login or personal API key required)
agentserve workflow-mcp-servers tools delete <serverId> <workflowId> [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
Get Workflow MCP Server (OAuth login or personal API key required)
agentserve workflow-mcp-servers get <serverId>Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
agentserve workflow-mcp-servers list
List Workflow MCP Servers (OAuth login or personal API key required)
agentserve workflow-mcp-servers list [options]Options
| Option | Required | Description |
|---|---|---|
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve workflow-mcp-servers update
Update Workflow MCP Server (OAuth login or personal API key required)
agentserve workflow-mcp-servers update <serverId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
serverId | Yes | Unique workflow-MCP server identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Server display name, shown to connecting MCP clients. |
--description <value> | 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
Also spelled agentserve workflow.
agentserve workflows activate create
Activate Workflow Version (OAuth login or personal API key required)
agentserve workflows activate create <workflowId> <version> [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
Edit a workflow’s blocks, connections and settings with a batch of operations (OAuth login or personal API key required)
agentserve workflows operations apply <workflowId> [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 <json|@file> | 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":"<uuid>","params":{"name":"Renamed","connections":{"success":"my-fn"}}},{"operation_type":"delete","block_id":"<uuid>"}]. Also extract_from_subflow, whose params carry {"subflowId":"<loop-id>"}, 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 <value> | 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 <json|@file> | No | Blocks to enable or disable, applied after --operations: [{"block_id":"<uuid>","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
Update Workflow Variables
agentserve workflows variables update <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--operations <json|@file> | 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
Cancel a running workflow run
agentserve workflows runs cancel <runId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
agentserve workflows runs get
Show run status (requested outputs are included in JSON or YAML output)
agentserve workflows runs get <runId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--include-output | No | Include the final output in JSON or YAML output. |
--select-output <value...> | 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 <value> | No | Per-file inline ceiling, lowering but never raising the server limit of 16 MiB. |
agentserve workflows runs list
List runs for a workflow
agentserve workflows runs list [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--status <value> | No | Filter by run status. Accepted values: pending, running, completed, failed, cancelled, paused. |
--trigger <value> | No | Filter by trigger type. |
--start-date <value> | 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 <value> | 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 <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--order <value> | 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
Resume a paused run (output is included in JSON or YAML output)
agentserve workflows runs resume <runId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--context <value> | Yes | Pause context ID returned by run status. |
--input <json|@file> | No | Resume input as JSON (JSON, or @path / @- to read a file or stdin). |
agentserve workflows runs wait
Wait for a run to reach a terminal state, then show it
agentserve workflows runs wait <runId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--wait-timeout <seconds> | 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
Compare Workflow Versions
agentserve workflows versions compare <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--base <value> | Yes | Deployment version to compare from. |
--target <value> | Yes | Deployment version to compare to, in the same workflow. |
agentserve workflows versions get
Get Workflow Version
agentserve workflows versions get <workflowId> <version>Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
version | Yes | Numeric deployment version. |
agentserve workflows versions list
List Workflow Versions
agentserve workflows versions list <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve workflows versions update
Update Workflow Version
agentserve workflows versions update <workflowId> <version> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
version | Yes | Numeric deployment version. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | New label for the deployment version. |
--description <value> | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). |
agentserve workflows create
Create Workflow
agentserve workflows create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Workflow name. |
--description <value> | No | Optional workflow description. |
--folder <value> | No | Existing folder path (leading / optional); create it first with agentserve workflows mkdir <path>. |
agentserve workflows folders create
Create a workflow folder at a path
agentserve workflows folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path as shown in the app; the leading / is optional |
agentserve workflows folders delete
Delete Workflow Folder
agentserve workflows folders delete <path> [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
List workflow folders
agentserve workflows folders list [options]Also available as agentserve workflows folders ls.
Options
| Option | Required | Description |
|---|---|---|
--parent <value> | No | Direct parent folder path. |
--search <value> | No | Case-insensitive substring match against the folder name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve workflows folders move
Rename or move a workflow folder
agentserve workflows folders move <path> <destination>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
Delete Workflow
agentserve workflows delete <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve workflows chat unpublish
Take a workflow’s chat deployment offline (OAuth login or personal API key required)
agentserve workflows chat unpublish <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve workflows chat status
Show a workflow’s chat deployment (OAuth login or personal API key required)
agentserve workflows chat status <workflowId>Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
agentserve workflows chat publish
Publish or replace a workflow’s chat deployment (OAuth login or personal API key required)
agentserve workflows chat publish <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--identifier <value> | Yes | URL slug the deployed chat answers on. Must be free across live deployments. |
--title <value> | Yes | Title shown to visitors. |
--description <value> | No | Description shown to visitors. Omitted clears it. |
--customizations <json|@file> | No | Presentation overrides. Omitted fields take platform defaults. (JSON, or @path / @- to read a file or stdin). |
--auth-type <value> | No | How visitors are gated. public leaves the chat open to anyone holding the URL. Accepted values: public, password, email, sso. |
--password <value> | No | Write-only password. Required whenever authType is password, and rejected otherwise. Never readable back. |
--allowed-emails <json|@file> | 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 <json|@file> | 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
Deploy Workflow (OAuth login or personal API key required)
agentserve workflows deploy <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Optional label for the deployment version. |
--description <value> | No | Optional release note for the deployment version. |
agentserve workflows duplicate create
Duplicate Workflow
agentserve workflows duplicate create <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Name for the copy. Defaults to the source name, deduplicated within the folder. |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
agentserve workflows run
Run a deployed workflow or execute saved state manually
agentserve workflows run <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--input <json|@file> | 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 <value> | No | Maximum duration of an asynchronous run, in seconds, capped by the plan's execution timeout. Requires async: true; otherwise returns 400. |
--select-output <value...> | 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 <value> | 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 <value> | 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 <blockId> | 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 <blockId> | No | Run manually from this saved workflow block. |
--source-run <runId> | No | Prior run whose persisted state supplies upstream outputs (requires --from-block). |
--stop-after <blockId> | 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
Print a workflow as a portable JSON document
agentserve workflows export <workflowId> [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
Get Workflow
agentserve workflows get <workflowId>Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
agentserve workflows deployment status
Show a workflow’s current deployment
agentserve workflows deployment status <workflowId>Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
agentserve workflows deployment update
Update Workflow Public API Access (OAuth login or personal API key required)
agentserve workflows deployment update <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--is-public-api <true|false> | Yes | Whether the deployed workflow should accept unauthenticated public API execution. Accepted values: true, false. |
agentserve workflows state get
Get Workflow State
agentserve workflows state get <workflowId>Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
agentserve workflows state replace
Replace Workflow State (OAuth login or personal API key required)
agentserve workflows state replace <workflowId> [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 <json|@file> | Yes | Blocks keyed by block id. (JSON, or @path / @- to read a file or stdin). |
--edges <json|@file> | Yes | Directed connections between blocks. (JSON, or @path / @- to read a file or stdin). |
--loops <json|@file> | No | Ignored on write: loop containers are recomputed from blocks. (JSON, or @path / @- to read a file or stdin). |
--parallels <json|@file> | No | Ignored on write: parallel containers are recomputed from blocks. (JSON, or @path / @- to read a file or stdin). |
--variables <json|@file> | 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
Import Workflow
agentserve workflows import [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <json|@file> | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
--name <value> | No | Override for the imported workflow name. |
--description <value> | No | Override for the imported workflow description. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--bindings <json|@file> | No | Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--request-id <value> | No | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | 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 <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
agentserve workflows list
List Workflows
agentserve workflows list [options]Options
| Option | Required | Description |
|---|---|---|
--scope <value> | 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 <value> | 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 <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
--search <value> | No | Case-insensitive substring match against the resource name. |
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
agentserve workflows move
Move Workflows
agentserve workflows move [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <value...> | Yes | Workflows to move. Duplicates are collapsed. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--to <value> | Yes | Destination folder path; / moves the workflows to the workspace root. |
agentserve workflows import-preview
Preview Workflow Import
agentserve workflows import-preview [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <json|@file> | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
--name <value> | No | Override for the imported workflow name. |
--description <value> | No | Override for the imported workflow description. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--bindings <json|@file> | No | Resolved and unresolved source occurrences with their destination selections. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
agentserve workflows restore
Restore an archived workflow
agentserve workflows restore <workflowId>Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
agentserve workflows revert create
Revert Workflow To Version (OAuth login or personal API key required)
agentserve workflows revert create <workflowId> <version> [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
Rollback Workflow (OAuth login or personal API key required)
agentserve workflows rollback <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--to-version <value> | No | Deployment version to reactivate. Omit to select the previous active version. |
-y, --yes | Yes | Confirm this operation. |
agentserve workflows undeploy
Take a workflow out of deployment (OAuth login or personal API key required)
agentserve workflows undeploy <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | Yes | Confirm this operation. |
agentserve workflows update
Update Workflow
agentserve workflows update <workflowId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
workflowId | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Replacement workflow name. |
--description <value> | No | Replacement workflow description; null clears it. (--description null sends the word, not JSON null). |
--folder <value> | No | Folder path as shown in the app; the leading / is optional. |
agentserve workflows mv
Move a workflow to a folder
agentserve workflows mv <workflowId> <folder>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
List workflow resources and child folders together
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 <text> | No | Filter folders and resources by name. |
--limit <n> | No | Maximum combined items to return (0 for everything). Defaults to 0. |
agentserve workflows mkdir
Create a workflow directory at a path
agentserve workflows mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |
agentserve workspaces
Also spelled agentserve workspace.
agentserve workspaces access-requests cancel
Cancel Workspace Access Request (OAuth login or personal API key required)
agentserve workspaces access-requests cancel <requestId>Arguments
| Argument | Required | Description |
|---|---|---|
requestId | Yes | Access request identifier. |
agentserve workspaces access-requests create
Create Workspace Access Request (OAuth login or personal API key required)
agentserve workspaces access-requests create [options]Options
| Option | Required | Description |
|---|---|---|
--target <json|@file> | 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 <value> | No | Why the acting user needs this access. |
agentserve workspaces access-requests discover
Discover Workspace Access Requests (OAuth login or personal API key required)
agentserve workspaces access-requests discover [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the access item label. |
--target-kind <value> | No | Category of access to discover. Accepted values: feature, integration, provider, model, tool, knowledge_connector, file_share_auth, chat_deploy_auth, usage_limit. |
--state <value> | No | Filter by the acting user’s current access. Requestable items can be submitted for review. Accepted values: allowed, requestable, unavailable. |
--sort-by <value> | No | Field used to sort the result. Accepted values: label. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve workspaces access-requests mine
List My Workspace Access Requests (OAuth login or personal API key required)
agentserve workspaces access-requests mine [options]Options
| Option | Required | Description |
|---|---|---|
--status <value> | No | Filter by request status; omit to include all statuses. Accepted values: pending, fulfilled, declined, cancelled, closed. |
--sort-by <value> | No | Field used to sort the result. Accepted values: createdAt, targetLabel. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
agentserve workspaces invitations create
Create Workspace Invitations (OAuth login or personal API key required)
agentserve workspaces invitations create [options]Options
| Option | Required | Description |
|---|---|---|
--emails <value...> | 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 <value> | No | Workspace permission to grant. Existing workspace access is preserved. Accepted values: admin, write, read. |
--membership <value> | 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
Fork Workspace (OAuth login or personal API key required)
agentserve workspaces fork [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Display name of the workflow or workspace. |
--copy <json|@file> | 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 <value> | Yes | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | 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 <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
agentserve workspaces get
Get Workspace
agentserve workspaces getagentserve workspaces fork-availability
Get Workspace Fork Availability (OAuth login or personal API key required)
agentserve workspaces fork-availabilityagentserve workspaces lineage
Get Workspace Fork Lineage (OAuth login or personal API key required)
agentserve workspaces lineageagentserve workspaces mappings get
Get Workspace Fork Mappings (OAuth login or personal API key required)
agentserve workspaces mappings get [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--direction <value> | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: push, pull. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--sort-by <value> | No | Supported stable sort key for this collection. Accepted values: id. |
--sort-order <value> | No | Sort direction. Accepted values: asc. |
agentserve workspaces mappings update
Update Workspace Fork Mappings (OAuth login or personal API key required)
agentserve workspaces mappings update [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--direction <value> | Yes | Push means current to other; pull means other to current, independent of parent/child orientation. Accepted values: push, pull. |
--mappings <json|@file> | Yes | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
agentserve workspaces operations get
Get Workspace Operation
agentserve workspaces operations get <operationId>Arguments
| Argument | Required | Description |
|---|---|---|
operationId | Yes | Durable operation identifier to use for polling. |
agentserve workspaces operations list
List Workspace Operations
agentserve workspaces operations list [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--request-id <value> | No | Stable client request ID for reconciliation and identical retries. |
agentserve workspaces operations wait
Wait for copy and deployment readiness; exit 3 for configuration, 1 for failure, or 4 for timeout
agentserve workspaces operations wait <operationId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
operationId | Yes | Operation ID returned by import, fork, push, or pull |
Options
| Option | Required | Description |
|---|---|---|
--wait-timeout <seconds> | No | Maximum total wait (default 3600; 0 waits indefinitely). |
agentserve workspaces permission-config
Get Workspace Permission Config (OAuth login or personal API key required)
agentserve workspaces permission-configagentserve workspaces children
List Workspace Fork Children (OAuth login or personal API key required)
agentserve workspaces children [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--sort-by <value> | No | Supported stable sort key for this collection. Accepted values: createdAt. |
--sort-order <value> | No | Sort direction. Accepted values: desc. |
agentserve workspaces fork-resources
List Workspace Fork Resources (OAuth login or personal API key required)
agentserve workspaces fork-resources [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--cursor <value> | No | Continue from nextCursor returned by a previous result. |
--kind <value> | Yes | Resource or operation kind. Accepted values: files, tables, knowledgeBases, customTools, skills, mcpServers, workflowMcpServers. |
--sort-by <value> | No | Supported stable sort key for this collection. Accepted values: id. |
--sort-order <value> | No | Sort direction. Accepted values: asc. |
agentserve workspaces members
List workspace members
agentserve workspaces members [options]Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve workspaces list
List Workspaces
agentserve workspaces list [options]Options
| Option | Required | Description |
|---|---|---|
--sort-by <value> | 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 <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |
agentserve workspaces fork-preview
Preview Workspace Fork (OAuth login or personal API key required)
agentserve workspaces fork-preview [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Display name of the workflow or workspace. |
--copy <json|@file> | 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
Preview Workspace Pull (OAuth login or personal API key required)
agentserve workspaces pull-preview [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | 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 <json|@file> | 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
Preview Workspace Push (OAuth login or personal API key required)
agentserve workspaces push-preview [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | 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 <json|@file> | 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
Pull Workspace (OAuth login or personal API key required)
agentserve workspaces pull [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | 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 <json|@file> | 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 <value> | Yes | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | 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 <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
-y, --yes | Yes | Confirm this operation. |
agentserve workspaces push
Push Workspace (OAuth login or personal API key required)
agentserve workspaces push [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
--mappings <json|@file> | No | Mappings keyed by resource type and source identifier. (JSON, or @path / @- to read a file or stdin). |
--dependent-values <json|@file> | No | Destination-dependent choices keyed by source workflow, block, and field identities. (JSON, or @path / @- to read a file or stdin). |
--copy-resources <json|@file> | No | Explicit source resources to copy before syncing the workflows. (JSON, or @path / @- to read a file or stdin). |
--drop-references <json|@file> | 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 <json|@file> | 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 <value> | Yes | Stable client request ID for reconciliation and identical retries. |
--preview-fingerprint <value> | 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 <seconds> | No | Maximum operation wait in seconds (default 3600; 0 waits indefinitely). |
-y, --yes | Yes | Confirm this operation. |
agentserve workspaces fork-rollback
Rollback Workspace Fork (OAuth login or personal API key required)
agentserve workspaces fork-rollback [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
-y, --yes | Yes | Confirm this operation. |
agentserve workspaces unlink
Unlink Workspace Fork (OAuth login or personal API key required)
agentserve workspaces unlink [options]Options
| Option | Required | Description |
|---|---|---|
--other-workspace-id <value> | Yes | Workspace on the other side of the direct fork edge. |
-y, --yes | Yes | Confirm this operation. |
agentserve workspaces sync-exclusions
Update Workspace Fork Exclusions (OAuth login or personal API key required)
agentserve workspaces sync-exclusions [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <value...> | Yes | Workflow identifiers in the current workspace. (space-separated, or @path / @- with one value per line; @@value for a literal leading @). |
--fork-sync-excluded <true|false> | Yes | Whether the named workflows should be skipped as sync sources and targets. Accepted values: true, false. |