Skip to main content

ish chat endpoint

Manage saved chatbot endpoints Usage: ish chat endpoint

ish chat endpoint list

List chatbot endpoints in the current workspace Usage: ish chat endpoint list [options]

Options

--workspace <id>
string
Workspace ID

ish chat endpoint get

Get a chatbot endpoint by id (or the active endpoint) Usage: ish chat endpoint get [id] [options]

Arguments

id
Endpoint alias or UUID; defaults to the active endpoint (optional)

Options

--endpoint <id>
string
Endpoint alias or UUID (alternative to positional)

ish chat endpoint create

Create a chatbot endpoint from a hand-written ChatbotEndpointConfig JSON (advanced - use chat endpoint init to infer the config from a curl sample, JSON, or template). Usage: ish chat endpoint create [options]

Options

--endpoint-config <file>
string
Path to JSON file (or ”-” for stdin) Required.
--name <name>
string
Override the name from the config file
--workspace <id>
string
Workspace ID
--tunnel-backed
boolean
Mark this endpoint as tunnel-backed (overrides envelope/config)
--no-tunnel-backed
boolean
Force tunnel-backed off (overrides envelope/config)

ish chat endpoint update

Update a chatbot endpoint (full replace via —endpoint-config, or per-field shorthand) Usage: ish chat endpoint update [id] [options]

Arguments

id
Endpoint alias or UUID; defaults to the active endpoint (optional)

Options

--endpoint <id>
string
Endpoint alias or UUID (alternative to positional)
--endpoint-config <file>
string
Replace config from JSON file (or ”-” for stdin)
--name <name>
string
Rename the endpoint
--url <url>
string
Replace outgoing.url
--method <method>
string
Replace outgoing.method (POST | PUT)
--mode <mode>
string
Replace outgoing.mode (stateful | stateless)
--tunnel-backed
boolean
Set isTunnelBacked=true
--no-tunnel-backed
boolean
Set isTunnelBacked=false

ish chat endpoint delete

Delete a chatbot endpoint Usage: ish chat endpoint delete [id] [options]

Arguments

id
Endpoint alias or UUID; defaults to the active endpoint (optional)

Options

--endpoint <id>
string
Endpoint alias or UUID (alternative to positional)
-y, --yes
boolean
Skip confirmation prompt (required in —json or non-TTY contexts)

ish chat endpoint use

Set the active chat endpoint (saved to ~/.ish/config.json) Usage: ish chat endpoint use [id] [options]

Arguments

id
Endpoint alias or UUID (optional)

Options

--clear
boolean
Remove the active chat endpoint from config

ish chat endpoint init

Author an endpoint from a curl/JSON sample via test-and-map, or from a known-good template (recommended for most users - use chat endpoint create only when you already have a hand-written ChatbotEndpointConfig). Usage: ish chat endpoint init [options]

Options

--from-curl <file>
string
Path to a curl example file (or ”-” for stdin)
--from-json <file>
string
Path to a JSON request/response sample (or ”-” for stdin)
--template <name>
string
Start from a known-good template (one of: openai, anthropic, voiceflow, dialogflow-cx, botframework)
--name <name>
string
Save the inferred config under this display name
--no-save
boolean
Infer the shape without persisting it
--workspace <id>
string
Workspace ID
--tunnel-backed
boolean
Force isTunnelBacked=true (overrides localhost auto-detect)
--no-tunnel-backed
boolean
Force isTunnelBacked=false (overrides localhost auto-detect)

ish chat endpoint test

Send one message to a saved endpoint and return the bot’s reply Usage: ish chat endpoint test [endpoint-id] [options]

Arguments

endpoint-id
Endpoint alias or UUID; defaults to the active endpoint (optional)

Options

--endpoint <id>
string
Endpoint alias or UUID (alternative to positional)
-m, --message <text>
string
Message to send Default: “Hello”.
--conversation-id <id>
string
Thread state across multiple invocations (stateful endpoints)
--participant <json>
string
Participant persona JSON ({name, locale, …}) exposed via {{participant.*}}
--include-request
boolean
Include the dispatched POST body in the output
--workspace <id>
string
Workspace ID

ish chat endpoint map

Map a chatbot contract from documentation (and optionally a saved endpoint draft) via /chat/test-and-map Usage: ish chat endpoint map [options]

Options

--docs <file>
string
Path to documentation file (curl, JSON, OpenAPI snippet, freeform). Use ”-” for stdin
--endpoint <id>
string
Saved endpoint alias or UUID - its config seeds the draft endpoint. Optional.
--workspace <id>
string
Workspace ID

ish chat config

Manage chatbot configurations (agent shape: model, prompt, tools, sub-agents) Usage: ish chat config

ish chat config list

List configurations under a chatbot endpoint Usage: ish chat config list [options]

Options

--endpoint <id>
string
Endpoint alias or UUID (defaults to active endpoint)

ish chat config set

Create or update a chatbot configuration (composite upsert) Usage: ish chat config set [options]

Options

--name <name>
string
Configuration name (unique per endpoint) Required.
--endpoint <id>
string
Endpoint alias or UUID (defaults to active endpoint; create only)
--config <id>
string
Configuration alias or UUID - switches to update mode
--version-label <label>
string
Optional version tag (e.g. v3, 1.2.0, git sha)
--description <text>
string
Optional description
--model <id>
string
Primary model identifier (e.g. claude-sonnet-4-6)
--system-prompt <text>
string
System prompt text
--system-prompt-file <file>
string
Read system prompt from file (or ”-” for stdin)
--tools-file <file>
string
JSON array of tools (or ”-” for stdin)
--sub-agents-file <file>
string
JSON array of sub-agents (or ”-” for stdin)
--custom-field <key=value>
string
Custom field; repeat. Replaces all custom fields on update.
--default
boolean
Mark as the endpoint’s default configuration

ish chat config get

Get a chatbot configuration (or its referencing iterations) Usage: ish chat config get [id] [options]

Arguments

id
Configuration alias or UUID (optional)

Options

--config <id>
string
Configuration alias or UUID (alternative to positional)
--view <view>
string
default | iterations. iterations returns the cross-study aggregation list. Default: “default”.

ish chat config delete

Delete a chatbot configuration (rejected when iterations reference it) Usage: ish chat config delete [id] [options]

Arguments

id
Configuration alias or UUID (optional)

Options

--config <id>
string
Configuration alias or UUID (alternative to positional)
-y, --yes
boolean
Skip confirmation prompt

Global flags

Every command accepts the global flags.
-V, --version
boolean
output the version number
-t, --token <token>
string
Auth token (or set ISH_TOKEN env var)
--token-file <path>
string
Read auth token from a file (preferred over —token / ISH_TOKEN)
--workspace <id>
string
Default workspace ID; per-subcommand —workspace overrides
--json
boolean
Output as JSON (auto-enabled when piped)
--get <field>
string
Extract a single field from the JSON response and print only its value (implies —json internally; supports dotted paths e.g. person.name)
--human
boolean
Force human-readable output even when stdout is piped (overrides JSON-when-piped auto-detection)
--fields <fields>
string
Comma-separated fields to include in JSON output (e.g. alias,name,status)
--verbose
boolean
Include full UUIDs and timestamps in JSON output
--no-color
boolean
Disable colored output (also honored: NO_COLOR env var)
-q, --quiet
boolean
Suppress progress messages on stderr (no-op for read commands that emit none)