Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ontora.com/llms.txt

Use this file to discover all available pages before exploring further.

The Ontora CLI is a Python tool that wraps the REST API. It’s the fastest way to launch campaigns, pull transcripts, and run GraphRAG queries from a terminal or CI pipeline.

​
Install

pip install ontora-cli
After install, the ontora command is on your PATH. 
ontora --version

​
First-time setup

Authenticate once and the CLI will remember your key: 
ontora auth login --api-key ont_live_...
Optional flags: --workspace WS_ID to set a default workspace, --base-url URL if you’re hitting a non-default API host. Verify the connection: 
ontora auth status

​
How config is stored

Configuration lives at ~/.ontora/config.yaml with permissions 0600: 
api_key: ont_live_...
base_url: https://api.ontora.com
workspace_id: ws_...
You can override any value at call time with environment variables: 
export ONTORA_API_KEY=ont_live_...
export ONTORA_BASE_URL=https://api.ontora.com
export ONTORA_WORKSPACE_ID=ws_...
This is the recommended pattern in CI — store the API key as a secret, set ONTORA_API_KEY, and skip ontora auth login entirely.

​
Next steps

Commands

Full reference for every CLI command.

Campaign YAML

Define an entire campaign in a single YAML file and launch it with one command.