For AI agents: a documentation index is available at /llms.txt
Skip to main content

liveURL

Returns a fully-qualified, user-shareable live-URL for streaming the web-browser to an end-user, optionally interactive.

**Set 30 second timer for interaction**

mutation CreateLiveURL {
  goto(url: "https://example.com") {
    status
  }
  liveURL {
    liveURL
  }
}

**Maintain the current browsers viewport and don't resize it**

mutation CreateLiveURL {
  goto(url: "https://example.com") {
    status
  }
  liveURL(resizable: false) {
    liveURL
  }
}

**Don't allow interaction at all**

mutation CreateLiveURL {
  goto(url: "https://example.com") {
    status
  }
  liveURL(interactable: false) {
    liveURL
  }
}

**Low quality for better bandwidth**

mutation CreateLiveURL {
  goto(url: "https://example.com") {
    status
  }
  liveURL(quality: 20 type: jpeg) {
    liveURL
  }
}

**Field Definition:**

liveURL(
  detached: Boolean = false
  targetId: String
  mode: LiveURLMode
  captureScale: Int = 1
  timeout: Float
  interactable: Boolean = true
  type: LiveURLStreamType = jpeg
  quality: Int = 70
  resizable: Boolean = true
  showBrowserInterface: Boolean = false
  instructionsLayout: InstructionsLayout = modal
  compressed: Boolean = true
  emulateComponents: Boolean = true
  instructions: StringOrInstructions
  instructionsFormat: InstructionsFormat = text
  instructionsTitle: String
  steps: [String!]
  currentStep: Int
  doneLabel: String
  failLabel: String
  requesterName: String
): LiveURLResponse

Arguments​

liveURL.detached ● Boolean scalar​

Give the viewer its own Chrome connection, independent of the minting client. Does not keep the browser alive: request reconnect keep-alive separately before disconnecting. Ends on link expiry, browser termination, explicit close, or secret-fill teardown. Defaults to false.

liveURL.targetId ● String scalar​

Page target id from windows; defaults to the active window. May name a tab in any browser context. Does not switch the active window.

liveURL.mode ● LiveURLMode enum​

Defaults to tab when targetId is supplied, otherwise follow. An explicit mode always wins.

liveURL.captureScale ● Int scalar​

Encoded backing pixels per CSS pixel. Must be 1 or 2. Defaults to 1; 2 increases stream resolution without changing the page's CSS viewport.

liveURL.timeout ● Float scalar​

The maximum link lifetime in milliseconds. Does not extend browser keep-alive. Capped to the session's remaining time; the applied value is returned as timeout. When the link expires, its viewer closes without terminating the browser.

liveURL.interactable ● Boolean scalar​

Whether the session is interactable or not. Set to "false" to not allow click and mouse events to be forwarded through to the end-user

liveURL.type ● LiveURLStreamType enum​

The binary-type of the streamed imaged. "jpeg" will consumer lower bandwidth and useful low bandwidth networks and devices. "png" is a much higher quality but will consume considerably more bandwidth.

Use "jpeg" when setting a custom quality

liveURL.quality ● Int scalar​

The quality of the stream, represented as number from 1 - 100. Only used when "type" is "jpeg". Default is 70.

liveURL.resizable ● Boolean scalar​

Whether or not to resize the underlying browser to match the end-user's screen size. When false the underlying browser will retain it's current viewport, and the end users's screen wil maintain the appropriate aspect ratio.

liveURL.showBrowserInterface ● Boolean scalar​

Whether to show the browser interface and tabs in the live URL. When false (default), only the browser content is shown. When true, navigation bar and tabs are displayed.

liveURL.instructionsLayout ● InstructionsLayout enum​

Instructions layout: modal (default) overlays the page; panel reserves an always-visible 340px right-hand column when instructions are non-empty and interactable is true. The panel has no desktop hide control. Viewers 900px wide or narrower use the collapsible mobile treatment, with Done reachable when hidden. Panel mode hides instructions on read-only links.

liveURL.compressed ● Boolean scalar​

Whether to compress each frame of the streamed image data. When true (default), frames are compressed to reduce bandwidth usage. Set to false to disable compression for lower latency at the cost of increased bandwidth usage.

liveURL.emulateComponents ● Boolean scalar​

Whether to emulate HTML components such as <select> dropdowns and the virtual keyboard. Setting this to false will force the virtual keyboard to not appear on the end-user's screen when interacting with input fields. Defaults to true.

liveURL.instructions ● StringOrInstructions scalar​

A plain string or an instructions object: layout (modal|panel), format (text|markdown), title (80 characters), summary (2048-character cap), steps (up to 10 non-empty strings, 300 characters each), and currentStep (1-based). Object layout overrides instructionsLayout. Text is trimmed; omitted or blank text with no steps hides the card. Variables must use StringOrInstructions, not String.

liveURL.instructionsFormat ● InstructionsFormat enum​

Opt-in inline formatting; defaults to plain text.

liveURL.instructionsTitle ● String scalar​

Card title, at most 80 characters.

liveURL.steps ● [String!] list scalar​

At most 10 non-empty steps, each at most 300 characters.

liveURL.currentStep ● Int scalar​

Current step, a whole number from 1 through the number of steps.

liveURL.doneLabel ● String scalar​

Done button label, at most 40 characters.

liveURL.failLabel ● String scalar​

Failure button label, at most 40 characters.

liveURL.requesterName ● String scalar​

Requester name, at most 60 characters.

Type​

LiveURLResponse object​

The response from the Live-URL query

Was this page helpful?