Skip to main content
These concepts come up throughout the Omni documentation. Whether you work in the dashboard or through the API, the terms on this page are the ones used to explain it.

Data hierarchy

Projects and workflows are created only in the dashboard. An API key is issued per project, and that key can only work with the workflows, profiles, items, and analyses inside that project.

Workflows and playbooks

A workflow is made of a policy (plain language), an AI model, and an output schema. When you save a workflow, Omni reads the policy and builds a playbook — the execution plan an analysis actually follows.
Editing the playbook does not change analyses that already finished. An analysis freezes and stores the playbook as it was at run time, and playbookSnapshot, playbookVersion, and snapshotStatus in the response tell you which version ran.

Analysis lifecycle

Analyses are asynchronous. The request returns 202 Accepted and an analysisId immediately, and you poll GET /analyses/:analysisId for the result. While an analysis is running on a profile, a new analysis request on that profile is refused with 409. To run an analysis, every item in the profile must be ACTIVE.

Three levels of verdict

An analysis result carries verdicts at three different levels. Branch your downstream processing on the top-level verificationStatus.

Analysis Score

A 0–100 measure of how completely the analysis was carried out as defined. It is not the AI’s confidence. The API provides it as the confidence object. The score gets a level of HIGH (80–100), MEDIUM (65–79), or LOW (0–64). confidenceScore (0–1) is separate — it is the confidence the agent recorded, and it can be empty.

Output schema and extracted data

The output schema is a JSON Schema you define per workflow. extractedData in an analysis result follows that structure exactly, and each leaf field carries its value along with the grounds for it.
A workflow with no schema, or an analysis where output assembly failed, returns the raw per-action structure without this envelope. How to tell the difference, and how to read a field that came back empty, is covered in reading analysis results.

Credits

A project’s credit usage is aggregated into three categories. The breakdown is on the credit usage tab in the dashboard.

Next steps

Quickstart

From creating a project to reading your first analysis result.

Reading analysis results

The extractedData envelope, reasons for missing values, and the audit log.