Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

This parameter is required to create valid embed requests.
In the Embed URL Builder, this is the Content path field.

Syntax

contentPath=<encoded_path>

Properties

contentPath
string
required
The URL-encoded path to the starting page. Click the following toggles to view examples for each of the pages you can use as a starting page.
If the starting content path is a dashboard path, Omni provides a 24 hour VIEWER content permit to that dashboard for that user.
/dashboards/<dashboard-id>
contentPath=%2Fdashboards%2Fa6908f35
/w/<dashboard-id>/duplicate
 contentPath=%2Fw%2Fa6908f35%2Fduplicate
In this example, a connectionRoles parameter was also provided to associate the chat with a specific connection (MD2) and its models:
/my
 contentPath=%2Fmy
An entity parameter is required when /entity-folder is used as the contentPath.By default, the entity value will be used to create the entity folder. To provide a different name for the folder, use the entityFolderLabel parameter.

Examples

Dashboard path
contentPath=%2Fdashboards%2Fa6908f35
Workbook path
contentPath=%2Fw%2Fa6908f35%2Fduplicate
My Documents path
contentPath=%2Fmy