Command groups - Omni CLI - Omni Docs

View the current OpenAPI spec using the API Explorer in your instance.

How CLI commands map to the API

Most CLI commands are auto-generated from the Omni OpenAPI spec. For the Omni CLI, this means:

API tags become command groups. For example, the documents API tag corresponds to the omni documents command group.

Path parameters become positional arguments, such as documentId in the following example:

# API endpoint
POST /api/documents/<documentId>/duplicate

# CLI
omni documents duplicate <documentid>

Query parameters become flags, such as userId in the following example:

# API endpoint
POST /api/documents/<documentId>/duplicate?userId=<userId>

# CLI
omni documents duplicate <documentid> --userid <userid>

Request bodies, --schema, and the --query escape hatch work the same way across every command. See JSON requests and responses for the full details and examples.

The CLI sends a User-Agent header of the form omni-cli/1.3.0 on every request, so you can tell its traffic apart from other API clients in your logs. Run omni <group> --help to see all commands in a group or omni <group> <command> --help for command-specific argument and flag details.

Command groups

Group	Description
AI	Query generation, jobs, conversations, credit controls
AI Eval	Eval prompt sets and runs
AI model suggestions	Generate, schedule, and manage suggested model improvements
AI routines	Scheduled prompts that run through the Omni Agent
API tokens	Organization API tokens
Color palettes	Custom chart color palettes
Connections	Database connections, connection environments, dbt configuration, schema refresh schedules
Content	List and search content
Dashboards	Dashboard downloads and filters
Documents	Documents, drafts, permissions, labels, favorites, v2 content and app editing
Embed	Embedded SSO sessions
Folders	Folders and folder permissions
Labels	Content labels
Models	Models, views, fields, topics, branches, Git, dbt
Query	Run and monitor query execution
Schedules	Delivery schedules and recipients
SCIM	SCIM user and group provisioning
Skills	Omni Agent skills (experimental)
Unstable	Preview commands that may change without notice
Uploads	CSV and Excel file uploads
User attributes	User attribute definitions
Users	User and group model roles, email-only users, user attribute values
Whoami	The authenticated caller’s identity and permissions
Config & utility	`omni config`, `omni agent-help`, `omni completion`, `omni update`