Commands

The CLI is grouped by resource. Run ontora <group> --help for in-terminal docs on any command.

`ontora auth`

API key and connection management. Save an API key (and optional defaults) to ~/.ontora/config.yaml.

ontora auth login --api-key ont_live_... [--workspace WS_ID] [--base-url URL]

Flag	Required	Description
`--api-key`, `-k`	yes	Your Ontora API key (starts with `ont_`)
`--workspace`	no	Default workspace id used when commands omit it
`--base-url`	no	Override the API host (e.g. for staging)

`auth status`

ontora auth status

Calls /health and prints whether your saved key works.

`ontora campaigns`

Manage interview campaigns.

ontora campaigns list [-w WS_ID] [--status STATUS]
ontora campaigns show INTERVIEW_ID
ontora campaigns create -c campaign.yaml [-w WS_ID] [--start]
ontora campaigns start INTERVIEW_ID
ontora campaigns pause INTERVIEW_ID

Command	Notes
`list`	`--status` filters by `draft`, `active`, `paused`, or `completed`
`show`	Prints campaign metadata and progress
`create`	Reads a campaign YAML. Add `--start` to launch immediately
`start`	Move from `draft` → `active`
`pause`	Pause an active campaign

`ontora contacts`

Manage contacts on a campaign.

ontora contacts list INTERVIEW_ID [--status STATUS]
ontora contacts add INTERVIEW_ID --name "Sam Rivera" \
    [--email sam@example.com] [--phone +1...] \
    [--job-title "Shift Lead"] [--department Operations] [--seniority 4]
ontora contacts import INTERVIEW_ID contacts.csv

Command	Notes
`list`	Lists contacts and their conversation status
`add`	Adds a single contact. Only `--name` is required
`import`	Bulk import from a CSV file (positional path). Columns: `name,email,phone,job_title,department,seniority`

`ontora transcripts`

ontora transcripts list INTERVIEW_ID
ontora transcripts get INTERVIEW_ID CONVERSATION_ID [-f md|json] [-o transcript.md]
ontora transcripts export INTERVIEW_ID [-o transcripts.zip]

Command	Notes
`list`	Lists conversations in a campaign
`get`	Fetch one transcript. `--format` defaults to `md`. `--output` writes to a file instead of stdout
`export`	Bundle every transcript into a ZIP (defaults to `transcripts.zip` in cwd)

`ontora reports`

ontora reports show INTERVIEW_ID
ontora reports export INTERVIEW_ID [-k report|summary] [-o report.md]

Command	Notes
`show`	Print the dashboard summary as Markdown to stdout
`export`	`--kind report` (default) is the full synthesis report; `--kind summary` is the dashboard view. `--output` writes to a file

`ontora query`

Run a GraphRAG query over a campaign’s transcripts.

ontora query INTERVIEW_ID "What are the most painful manual steps in scheduling?"

Both arguments are positional and required. The CLI prints the answer plus structured patterns and divergences. For finer control (anonymization, top-k), call the REST endpoint directly.

`ontora webhooks`

Outbound webhook endpoints.

ontora webhooks list [-w WS_ID]
ontora webhooks add URL [--events "synthesis.completed,interview.completed"] \
    [--description "Production sync"] [-w WS_ID]
ontora webhooks test ENDPOINT_ID
ontora webhooks remove ENDPOINT_ID
ontora webhooks deliveries ENDPOINT_ID [-n 25]

Command	Notes
`list`	Lists workspace subscriptions
`add`	`--events` is a comma-separated string. Empty/omitted = subscribe to all events
`test`	Sends a synthetic event to the endpoint
`remove`	Deletes the subscription
`deliveries`	Lists recent delivery attempts. `-n` defaults to 25

`ontora version`

ontora version

Prints the installed CLI version.

Environment variables

Variable	Overrides
`ONTORA_API_KEY`	API key from `~/.ontora/config.yaml`
`ONTORA_BASE_URL`	API host
`ONTORA_WORKSPACE_ID`	Default workspace id

These take priority over the saved config — use them in CI to avoid storing credentials on disk.

Get started

Core concepts

Guides

MCP server

CLI

Webhooks

`ontora auth`

`auth status`

`ontora campaigns`

`ontora contacts`

`ontora transcripts`

`ontora reports`

`ontora query`

`ontora webhooks`

`ontora version`

Environment variables

​ontora auth

​auth login

​auth status

​ontora campaigns

​ontora contacts

​ontora transcripts

​ontora reports

​ontora query

​ontora webhooks

​ontora version

​Environment variables

`ontora auth`

`auth login`

`auth status`

`ontora campaigns`

`ontora contacts`

`ontora transcripts`

`ontora reports`

`ontora query`

`ontora webhooks`

`ontora version`

Environment variables