Skip to main content
The API Explorer is a built-in interactive interface for browsing and testing Omni’s REST API endpoints. It is powered by Swagger UI and uses the same OpenAPI specification that powers this documentation.

Access the API Explorer

The API Explorer is available at the /api-explorer route on your Omni instance. For example, if your Omni instance is https://blobsrus.omniapp.co, the API Explorer is at:
https://blobsrus.omniapp.co/api-explorer
The API Explorer is publicly accessible and does not require authentication to view. However, you will need a valid API key or personal access token to execute API requests from the Explorer.

OpenAPI specification

The raw OpenAPI specification is also available at the /openapi.json route on any Omni instance:
https://blobsrus.omniapp.co/openapi.json
You can use this specification with third-party API tools like Postman or code generation utilities.

Next steps