How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Omni Documents API

Create, retrieve, and manage documents

Omni Documents 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 10 paths, and defines 15 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.

15 operations 10 paths 15 schemas 3 DELETE4 GET1 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://blobsrus.omniapp.co/api
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Omni Documents 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 15

Across 10 paths, the API surfaces 15 operations — 3 DELETE, 4 GET, 1 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 15

Create, retrieve, and manage documents

POST
/v1/documentsdeprecated
Create document
createDocument body → 200400429
GET
/v1/documents
List documents
listDocuments 9 params → 200400404429
PUT
/v1/documents/{documentId}/move
Move document
moveDocument 1 param body → 200400403404429
POST
/v1/documents/{documentId}/duplicate
Duplicate published document
duplicateDocument 2 params body → 201400401403404405429
POST
/v1/documents/{identifier}/upgrade
Upgrade dashboard layout
documentsUpgradeLayout 1 param body → 200400401403404409429
PUT
/v1/documents/{documentId}/transfer-ownership
Transfer document ownership
transferDocumentOwnership 1 param body → 200400403404405429
POST
/v1/documents/{documentId}/draftdeprecated
Create draft
createDraft 1 param body → 200400401403404429
DELETE
/v1/documents/{documentId}/draft
Archive draft
archiveDraft 1 param body → 200404429
GET
/v1/documents/{identifier}/drafts
List document drafts
listDocumentDrafts 2 params → 200400401403404429
GET
/v1/documents/{documentId}/queriesdeprecated
Get document queries
getDocumentQueries 1 param → 200403404429
GET
/v1/documents/{documentId}deprecated
Get dashboard document
getDocument 1 param → 200400403404429
DELETE
/v1/documents/{documentId}
Delete document
deleteDocument 1 param → 200404429
PATCH
/v1/documents/{documentId}deprecated
Update document
renameDocument 1 param body → 200400403404405409429
PUT
/v1/documents/{documentId}deprecated
Update dashboard document
updateDocument 1 param body → 200400403404409429
DELETE
/v2/documents/{documentId}/draft/{draftId}/dashboard
Remove dashboard from document
documentsV2RemoveDashboard 2 params → 200401403404405409422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Document (14 properties), DocumentsV2PatchDraftResponse (4 properties), PageInfo (4 properties), DocumentFolder (4 properties). Each schema is shown below with its type and property counts.

DocumentOwner
object
Document owner
2 properties 2 required
DocumentFolder
objectnull
Folder containing the document
4 properties 4 required
PageInfo
object
Pagination information for paginated responses.
4 properties
Document
object
14 properties 11 required
Error
object
2 properties
ApiError401
object
2 properties 2 required
DocumentsV2PatchDraftResponse
object
4 properties 4 required
ApiError403
object
2 properties 2 required
DocumentsListResponse
object
2 properties 2 required
ApiError400
object
2 properties 2 required
DocumentsUpgradeLayoutBody
object
1 property
DocumentsUpgradeLayoutResponse
object
2 properties 2 required
ApiError404
object
2 properties 2 required
SuccessResponse
object
1 property
ApiError409
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

omni-documents-api-openapi.yml Raw ↑

Other APIs Omni publishes across the network.

Omni AI API
Omni AI Credit Controls API
Omni AI Eval API
Omni AI Model Suggestions API
Omni AI Routines API
Omni API Tokens API
Omni Connection environments API
Omni Connections API
Omni Content API
Omni Content migration API
Omni Content validator API
Omni Dashboard downloads API
Where this information came from

This is an independent, third-party profile of Omni Documents 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.