OMomni
Documents

Create document

Changed on
<Warning> This endpoint is deprecated. Use the [Documents v2 API](/api/documents-v2/create-document) instead. </Warning>

Create a new document

post/v1/documents

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/documents
  • Auth
    HTTP bearer

Request body

modelIdstring uuid required

The ID of the model to build the document on

namestring required

The name of the document

descriptionstring

Description of the document

identifierstring

Custom identifier for the document. If not provided, an identifier will be auto-generated.

The identifier is used in the document's URL and must be unique across all documents in your organization.

Format requirements:

  • Must match the pattern: lowercase letters, numbers, hyphens, and underscores only
  • Cannot start or end with a hyphen or underscore

Note: Once created, the identifier can be changed using the Rename document identifier endpoint.

Example request

{
  "identifier": "sales-dashboard-2026"
}

Response

Document created successfully

Changes

  • 43290040f88fRevision changes
    • warning

      the optional response header Deprecation removed for the status 200

    • warning

      the optional response header Link removed for the status 200

    • warning

      the optional response header Sunset removed for the status 200

    • info

      added the new optional request property //

    • info

      added the new optional request property //