Skip to main content

Ontora CLI — manage interview campaigns, transcripts, reports, and webhooks from the terminal.

Project description

Ontora CLI

Manage Ontora interview campaigns, transcripts, reports, and webhooks from the terminal.

Install

pip install ontora-cli
# or, from this repo:
cd cli && pip install -e .

Setup

ontora auth login           # Paste your API key (or set ONTORA_API_KEY)
ontora auth status          # Verify connection

Get an API key from the Ontora web app (Settings → API Keys) or via POST /v1/api-keys. You'll also need to know your workspace ID.

export ONTORA_WORKSPACE_ID=<uuid>
# or set per-command with --workspace

Campaigns

ontora campaigns list
ontora campaigns create --config campaign.yaml
ontora campaigns show <id>
ontora campaigns start <id>
ontora campaigns pause <id>

Config-as-code (YAML)

name: "Q2 Procurement Discovery"
goal: "Map end-to-end procurement workflow to identify automation opportunities"
channel: in_app_chat
duration_minutes: 30
interview_context_for_employee: >
  We're mapping how procurement works across the organization.
success_criteria: >
  Complete process map with step-level pain points from every department.

topics:
  - name: "Daily Workflow"
    goal: "Understand the step-by-step procurement process"
    priority: required
    success_threshold: "Can describe process end-to-end with tools used"
    sub_topics: ["intake", "approval", "vendor selection", "PO creation"]
    questions:
      - text: "Walk me through a typical purchase request"
        required: true
      - text: "What tools do you use at each step?"

contacts:
  - name: "Jane Smith"
    email: "jane@company.com"
    department: "Procurement"
    job_title: "Senior Buyer"
    seniority_level: 4
  # Or: { file: contacts.csv }

Transcripts and reports

ontora transcripts list <campaign-id>
ontora transcripts get <campaign-id> <conversation-id>
ontora transcripts export <campaign-id> [--output ./out]  # ZIP of .md files
ontora reports show <campaign-id>
ontora reports export <campaign-id> [--output report.md]

Graph RAG query

ontora query <campaign-id> "What are the top pain points across procurement?"

Webhooks

ontora webhooks list
ontora webhooks add https://your-app.example/hook --events interview.completed,campaign.completed
ontora webhooks test <id>
ontora webhooks remove <id>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ontora_cli-0.1.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ontora_cli-0.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file ontora_cli-0.1.0.tar.gz.

File metadata

  • Download URL: ontora_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ontora_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2aaeb72404bfd0e648997caff8d035bccf1cf672b64e7b5323b393eb9f9416ef
MD5 81eeef13c531fb19134e282f9c0bea25
BLAKE2b-256 18c7972a5b8e7951f8269c9440fe12c1d2f582cd04f69ca3083f03480f2623db

See more details on using hashes here.

Provenance

The following attestation bundles were made for ontora_cli-0.1.0.tar.gz:

Publisher: publish-cli.yml on ontora-main/ontora

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ontora_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ontora_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ontora_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91319bd9d6c8ed98c2b019de0ec4c1e894a0b36ec4b3b3c12787dbf70fe73309
MD5 fb9d2cd1fb95a88cf00dc5f0cf209d83
BLAKE2b-256 5146adc50e011feb2a08c890c002145f30cf3014ed2511787a72b25a43243834

See more details on using hashes here.

Provenance

The following attestation bundles were made for ontora_cli-0.1.0-py3-none-any.whl:

Publisher: publish-cli.yml on ontora-main/ontora

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page