Omni Documents v2 API
A draft-based workflow for creating and editing documents: create a document, patch a draft, then publish. Replaces the one-shot `PUT`/`PATCH` v1 document write endpoints.
Omni Documents v2 API is one of 38 APIs that Omni publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Documents v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 7 operations across 6 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://{instance}.omniapp.co/api, https://{instance}.playground.exploreomni.dev/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Omni Documents v2 API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
It accepts HTTP bearer tokens (JWT) (orgApiKey).
By default, every request must be authenticated.
bearerAuth— Can be either an [Organization API Key](/api/authenticationorganization-api-keys) or [Personal Access Token (PAT)](/api/authenticationtoken-types). Include in…orgApiKey— Requires an [Organization API Key](/api/authenticationorganization-api-keys). Personal Access Tokens (PATs) are not supported for this endpoint. Include in the…
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 2 GET, 2 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
A draft-based workflow for creating and editing documents: create a document, patch a draft, then publish. Replaces the one-shot PUT/PATCH v1 document write endpoints.
Schemas 17
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DocumentsV2QueryPresentation (16 properties), DocumentsV2CreateBody (10 properties), DocumentsV2CreateDraftBody (10 properties), DocumentsV2PatchDraftBody (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Omni 12
Other APIs Omni publishes across the network.
This is an independent, third-party profile of Omni Documents v2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.