Omni

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.

GitHub OpenAPI
Business capability
Analytics & BI Management BC-610.50

Operations 7

POST /v2/documents Create document #
GET /v2/documents/{documentId} Get document state #
PATCH /v2/documents/{documentId}/draft Create draft and patch document #
POST /v2/documents/{documentId}/draft/publish Publish draft #
GET /v2/documents/{documentId}/draft/{draftId} Get draft state #
PATCH /v2/documents/{documentId}/draft/{draftId} Patch draft #
PUT /v2/documents/{documentId}/identifier Rename document identifier #

Documentation

📖
Documentation
https://docs.omni.co/api
📖
APIReference
https://docs.omni.co/api/api-explorer

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/omni/refs/heads/main/openapi/omni-documents-v2-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/omni-documents-v2-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

omni-documents-v2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Omni Documents v2 API
  description: The Omni REST API provides programmatic access to your Omni instance for managing users, documents, queries, schedules, and more.
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
  description: Production
  variables:
    instance:
      default: blobsrus
      description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
  description: Playground
  variables:
    instance:
      default: blobsrus
      description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:


# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/omni/refs/heads/main/openapi/omni-documents-v2-api-openapi.yml