Applied LabsDocs
CoreAgentsAgent responsesAgent flowsFlow nodesFlow edgesContentSearchAnalyticsMetric eventsDashboardsConversationsConversation referencesConversation spansConnector typesFlowsFlowFlow runsFlow run
CLI reference

Applied CLI Reference

The Applied CLI lets developers authenticate, inspect workspace data, run analytics queries, test conversations, and propose or apply changes from a terminal.

applied <command> [flags]
Get startedterminal
applied loginapplied whoamiapplied --json doctor

Global options

Global options

--json

Emit stable JSON output for scripting.

-f, --format <text|json>

Choose text or JSON output. Short form is accepted.

-h, --help

Show command-specific help.

--version

Print the installed CLI version.

Command group

Core

Authenticate, inspect credentials, and verify API reachability.

6 usages
Core commands
applied --help
applied --version
applied login
applied logout
applied whoami
applied doctor

Login options

applied login --api <url>

Override the API host for the device authorization flow.

applied login --client <url>

Override the web app host opened during login.

Command group

Agents

Inspect and update agents, including nested response and flow surfaces.

7 usages
Agent commands
applied agents list
applied agents get <agent_id>
applied agents <agent_id>
applied agents <agent_id> update [--name ...] [--metadata JSON]
applied agents <agent_id> sync [--workspace <path>]
applied agents <agent_id> responses ...
applied agents <agent_id> flows ...

Global options

--json

Optional

--format json

Optional

Command group

Agent responses

Manage reusable answers owned by an agent.

6 usages
Agent response commands
applied agents <agent_id> responses list
applied agents <agent_id> responses create --type qa --question ... --answer ...
applied agents <agent_id> responses get <response_id>
applied agents <agent_id> responses <response_id>
applied agents <agent_id> responses <response_id> update
applied agents <agent_id> responses <response_id> delete

Useful flags

--type <type>

Optional

--question <text>

Optional

--answer <text>

Optional

--guardrail <text>

Optional

--active | --inactive

Optional

--body JSON | --body-file path

Optional

--dry-run

Optional

Command group

Agent flows

List, create, inspect, update, and delete agent flows.

8 usages
Agent flow commands
applied agents <agent_id> flows list
applied agents <agent_id> flows create --name <name>
applied agents <agent_id> flows get <flow_id>
applied agents <agent_id> flows <flow_id>
applied agents <agent_id> flows <flow_id> update
applied agents <agent_id> flows <flow_id> delete
applied agents <agent_id> flows <flow_id> nodes ...
applied agents <agent_id> flows <flow_id> edges ...

Useful flags

--name <name>

Optional

--trigger llm.call

Optional

--type conversational

Optional

--description <text>

Optional

--status Active

Optional

--prompt <text>

Optional

--body JSON | --body-file path

Optional

--dry-run

Optional

Command group

Flow nodes

Inspect or mutate nodes in an agent flow graph.

8 usages
Flow node commands
applied agents <agent_id> flows <flow_id> nodes list
applied agents <agent_id> flows <flow_id> nodes create --executor-type completion
applied agents <agent_id> flows <flow_id> nodes get <node_id>
applied agents <agent_id> flows <flow_id> nodes <node_id> update
applied agents <agent_id> flows <flow_id> nodes <node_id> delete
Singular compatibility alias
applied agents <agent_id> flows <flow_id> node create
applied agents <agent_id> flows <flow_id> node <node_id> update
applied agents <agent_id> flows <flow_id> node <node_id> delete

Useful flags

--executor-type <type>

Optional

--description <text>

Optional

--prompt <text>

Optional

--guardrail <text>

Optional

--metadata JSON

Optional

--body JSON | --body-file path

Optional

--dry-run

Optional

Command group

Flow edges

Inspect or mutate edges in an agent flow graph.

8 usages
Flow edge commands
applied agents <agent_id> flows <flow_id> edges list
applied agents <agent_id> flows <flow_id> edges create --source-node-id <id> --target-node-id <id>
applied agents <agent_id> flows <flow_id> edges get <edge_id>
applied agents <agent_id> flows <flow_id> edges <edge_id> update
applied agents <agent_id> flows <flow_id> edges <edge_id> delete
Singular compatibility alias
applied agents <agent_id> flows <flow_id> edge create
applied agents <agent_id> flows <flow_id> edge <edge_id> update
applied agents <agent_id> flows <flow_id> edge <edge_id> delete

Useful flags

--source-node-id <id>

Optional

--target-node-id <id>

Optional

--source-handle <handle>

Optional

--target-handle <handle>

Optional

--label <text>

Optional

--metadata JSON

Optional

--body JSON | --body-file path

Optional

--dry-run

Optional

Command group

Content

Read, create, update, delete, and resync knowledge content.

13 usages
Content commands
applied content list
applied content get <content_id>
applied content <content_id>
applied content <content_id> text
applied content <content_id> chunks
applied content create --type Article --source <title>
applied content create --type Site --source <url> [--pages single|all]
applied content create --type Product --product JSON
applied content <content_id> update
applied content <content_id> delete
applied content <content_id> resync
Plural compatibility alias
applied contents list
applied contents <content_id> update

List filters

--search <query>

Optional

--type <Site|Article|File|Product|Page|Spreadsheet|Table|Ticket|Message|Order|Invoice|Document>

Optional

--type-in <comma-separated-types>

Optional

--status <Active|Draft|Archived>

Optional

--source-id <uuid>

Optional

--tags-in <comma-separated-tags>

Optional

--has-responses <true|false>

Optional

--should-autogenerate-responses <true|false>

Optional

--ordering updated_at|title|tokens|-updated_at|-title|-tokens

Optional

--limit <n>

Optional

Create/update flags

--title <text>

Optional

--description <text>

Optional

--slug <slug>

Optional

--content <tiptap-json-string> | --content-file <path>

Optional

--text <plain-text> | --text-file <path>

Optional

--html <html> | --html-file <path>

Optional

--status <status>

Optional

--label-id <uuid>

Optional

--sublabel-id <uuid>

Optional

--media-id <uuid>

Optional

--source-id <uuid>

Optional

--tags JSON_ARRAY

Optional

--product JSON_OBJECT

Optional

--should-autogenerate-responses | --no-should-autogenerate-responses

Optional

--used-for-rag | --not-used-for-rag

Optional

--sync-enabled | --sync-disabled

Optional

--resync-schedule <cron>

Optional

--delete-responses

Optional

--body JSON | --body-file path

Optional

--dry-run

Optional

Command group

Search

Search across conversations, tickets, contacts, content, agents, and users.

4 usages
Search commands
applied search --query <text>
applied search --query <text> --model content
applied search --query <text> --model content,agent
applied global-search --query <text>

Useful flags

--query <text>

Optional

--q <text>

Optional

--model <conversation|ticket|contact|content|agent|user|all>

Optional

--limit <n>

Optional

--offset <n>

Optional

--json

Optional

--format json

Optional

Notes

- Global search returns {"results":[...]} rather than the paginated {"count","next","previous","results"} list shape.

Optional

- Repeat --model or pass a comma-separated list.

Optional

- Empty query with no specific model falls back to recent conversations.

Optional

- 1-2 character queries across multiple models return no results; use 3+ characters or a single model.

Optional

Command group

Analytics

Query analytics reports, metric event metadata, and dashboards.

14 usages
Analytics commands
applied analytics query --view <view> --model conversation --start <date> --end <date>
applied analytics query --body JSON
applied analytics metric-events counts
applied analytics metric-events property-keys --metric-name <name>
applied analytics metric-events property-values --metric-name <name> --property-key <key>
applied analytics dashboards list
applied analytics dashboards get <dashboard_id>
applied analytics dashboards <dashboard_id> revisions
applied analytics dashboards revision <dashboard_id> <revision_id>

Query flags

--view <analytics-view>

Optional

--model conversation|ticket

Optional

--start <YYYY-MM-DD|ISO-8601>

Optional

--end <YYYY-MM-DD|ISO-8601>

Optional

--tz <IANA-timezone>

Optional

--group-by <dimension[,dimension]>

Optional

--group-parts JSON_ARRAY

Optional

--period hour|day|week|month|quarter|year

Optional

--date-column created_at|resolved_at|first_human_response_at|event_time

Optional

--flow-id <flow_id>

Optional

--page <n>

Optional

--limit <n>

Optional

--offset <n>

Optional

--count <n>

Optional

--source-view <view>

Optional

--metric-rate <metric_rate>

Optional

--experiment-id <experiment_id>

Optional

--object-type conversation|ticket

Optional

--sample-object-ids <n>

Optional

--filter key=value

Optional

--conversation-filters JSON_OBJECT

Optional

--flow-run-filters JSON_OBJECT

Optional

--metric-events-filters JSON_OBJECT

Optional

--custom-rate-metrics-requests JSON_ARRAY

Optional

--custom-rate-metrics-request JSON_OBJECT

Optional

--body JSON | --body-file path

Optional

--dry-run

Optional

Examples

Examples
applied analytics query --view overview_aggregate_metrics --model conversation --start 2026-04-01 --end 2026-04-30 -f json
applied analytics query --view satisfaction_aggregates --model conversation --group-by intent,topic --date-column resolved_at -f json
applied analytics query --view overview_tables --model conversation --period day --page 2 -f json
applied analytics query --view flow_aggregate --model conversation --flow-id <flow_id> -f json
applied analytics query --view drilldown --source-view dashboard_rate_metrics --metric-rate ai_resolution_rate --group-parts '["support"]' --custom-rate-metrics-requests '[{"numerator":"conversation.resolve","rate":"ai_resolution_rate"}]' -f json
Command group

Metric events

Explore metric event counts, keys, and values.

3 usages
Analytics metric-event commands
applied analytics metric-events counts
applied analytics metric-events property-keys --metric-name <name>
applied analytics metric-events property-values --metric-name <name> --property-key <key>

Useful flags

--metric-name <name>

Repeatable, or comma-separated.

--property-key <key>

Optional

--object-type conversation|ticket

Optional

--prefix <prefix>

Repeatable for counts.

--exclude-prefix <prefix>

Repeatable for counts.

--limit <n>

Optional

Command group

Dashboards

List dashboards and inspect dashboard revisions.

7 usages
Analytics dashboard commands
applied analytics dashboards list
applied analytics dashboards get <dashboard_id>
applied analytics dashboards <dashboard_id>
applied analytics dashboards revisions <dashboard_id>
applied analytics dashboards <dashboard_id> revisions
applied analytics dashboards revision <dashboard_id> <revision_id>
applied analytics dashboards <dashboard_id> revision <revision_id>

Useful flags

--limit <n>

Optional

Command group

Conversations

Create test conversations, inspect messages, and send test webchat messages.

5 usages
Conversation commands
applied conversation create --agent-id <agent_id> --test
applied conversation <conversation_id>
applied conversation get <conversation_id>
applied conversation <conversation_id> --messages
applied conversation <conversation_id> send-message "hello"

create

--agent-id <agent_id>

Required.

--test | --is-test

Optional

--type <type>

Optional

--inbound-type <type>

Optional

--title <title>

Optional

--contact-id <contact_id>

Optional

--contact-name <name>

Optional

--contact-email <email>

Optional

--contact-phone <phone>

Optional

--contact-company <company>

Optional

--contact-role <role>

Optional

--metadata JSON_OBJECT

Optional

--context JSON_OBJECT

Optional

--body JSON_OBJECT

Optional

--dry-run

Optional

send-message

--text <message> | --content <message>

Optional

--metadata JSON_OBJECT

Optional

--body JSON_OBJECT

Optional

--limit <n>

Applies to the returned message bundle. Default 200.

--dry-run

Optional

--messages

Optional

--limit <n>

Applies when --messages is used. Default 200.

--json

Optional

--format json

Optional

Command group

Conversation references

Inspect references attached to a conversation.

1 usage
Conversation reference commands
applied conversation-references <conversation_id>

Useful flags

--json

Optional

--format json

Optional

Command group

Conversation spans

Inspect monitor spans attached to a conversation.

1 usage
Conversation span commands
applied conversation-spans <conversation_id>

Useful flags

--json

Optional

--format json

Optional

Command group

Connector types

Inspect available connector types and optional schemas.

3 usages
Connector type commands
applied connectors types
applied connector-types
applied connector-types --type <connector_type>

Useful flags

--type <connector_type>

Optional

--include-schemas

Optional

--json

Optional

--format json

Optional

Command group

Flows

List flows across agents with common filters.

3 usages
Flow list commands
applied flows
applied flows --agent <agent_id>
applied flows --agent-id <agent_id> --status Active

Useful flags

--agent <agent_id>

Optional

--agent-id <agent_id>

Optional

--status <status>

Optional

--type <type>

Optional

--trigger <trigger>

Optional

--limit <n>

Optional

--json

Optional

--format json

Optional

Command group

Flow

Inspect one flow directly by id.

1 usage
Flow commands
applied flow <flow_id>

Useful flags

--json

Optional

--format json

Optional

Command group

Flow runs

List flow runs by conversation, flow, agent, or status.

4 usages
Flow run list commands
applied flow-runs
applied flow-runs --conversation-id <conversation_id>
applied flow-runs --flow-id <flow_id>
applied flow-runs --agent <agent_id>

Useful flags

--conversation-id <conversation_id>

Optional

--flow-id <flow_id>

Optional

--agent <agent_id>

Optional

--agent-id <agent_id>

Optional

--status <status>

Optional

--limit <n>

Optional

--json

Optional

--format json

Optional

Command group

Flow run

Inspect one flow run directly by id.

1 usage
Flow run commands
applied flow-run <flow_run_id>

Useful flags

--json

Optional

--format json

Optional