A campaign packages everything Ontora needs to run a research project end-to-end: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.
- A goal describing what you’re trying to learn.
- A channel — voice (phone), in-app chat, or async messaging.
- A question set organized as topics and sub-topics, with goals and success thresholds.
- A list of contacts to interview.
- A synthesis target that defines the final report shape.
Lifecycle
| State | Meaning |
|---|---|
draft | Created but not started. Contacts can still be added. |
active | Conversations are being scheduled and conducted. |
paused | No new conversations start. Existing ones complete normally. |
completed | All conversations finished, synthesis available. |
Topics and questions
Each topic carries agoal, a priority, and a success_threshold (the share of contacts that need to cover it before the topic is considered fully explored). Sub-topics and explicit questions narrow the agent’s focus without scripting it.
The interview agent is not a fixed script. It uses topics as a coverage target and improvises follow-ups based on what each respondent says.
Contacts
A contact is the person being interviewed. Minimum required fields are name and email; richer metadata (department, job title, seniority) feeds into persona synthesis. You can add contacts:- One at a time via
POST /v1/interviews/{id}/contacts - In bulk via JSON (
POST /v1/interviews/{id}/contacts/bulk) - In bulk via CSV upload (
POST /v1/interviews/{id}/contacts/csv)
What you get back
Once the campaign reachescompleted, four synthesis outputs become available:
- Cartography — a map of processes, categorized and connected. See Synthesis.
- Roadmap — proposed solutions grouped by horizon (now / next / later).
- Personas — per-contact and per-department behavioral profiles.
- Conversations — individual transcripts with summaries and citations.