Sign in

v52

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-04170260320.4 KB

GetIFrame returns the iframe URL for the given project

post/v1/orgs/{org}/projects/{project}/iframe

Path parameters

orgstring required

Org that owns the project to embed.

projectstring required

Project that has the resource(s) to embed.

Request body

attributesobject

If set, will use the provided attributes outright.

branchstring

Branch to embed. If not set, the production branch is used.

externalUserIdstring

Optional ID for the external end user of the iframe. If set, the access token enables per-user state, such as AI chat history. Cannot be combined with user_id. If user_email matches a Rill Cloud user, their attributes are used, but this ID takes precedence for per-user state.

hideNavigationBarboolean

HideNavigationBar hides the embed's top navigation bar (the home link and dashboard breadcrumbs) without disabling navigation itself. It is only meaningful when navigation is true; the bar is always hidden when navigation is false. In-dashboard navigation, such as the canvas drill-through to an explore dashboard, remains available.

kindstring

Deprecated: Alias for type.

navigationboolean

Navigation denotes whether navigation between different resources should be enabled in the embed.

queryobject

DEPRECATED: Additional parameters to set outright in the generated URL query.

resourcestring

Name of the resource to embed. This should identify a resource that is valid for embedding, such as a dashboard or component.

statestring

Blob containing UI state for rendering the initial embed. Not currently supported.

superuserForceAccessboolean

If true, superusers can access the project even without org/project membership.

themestring

Theme to use for the embedded resource.

themeModestring

Theme mode to use for the embedded resource. Valid values: "light", "dark", "system".

ttlSecondsinteger

TTL for the iframe's access token. If not set, defaults to 24 hours.

typestring

Type of resource to embed. If not set, defaults to "rill.runtime.v1.Explore".

userEmailstring

If set, will generate attributes corresponding to a user with this email.

userIdstring

If set, will use the attributes of the Rill user with this ID.

Response

A successful response.

accessTokenstring
iframeSrcstring
instanceIdstring
runtimeHoststring
ttlSecondsinteger