Skip to main content
Required
  • partnerId
  • partnerToken
Optional (when your integration needs them)
  • environment (for example "staging" or "production")
  • autoRegister
  • loginOnInitialize
Field descriptions and AuthConfig details are in Configuration and Authentication. Invalid partnerId or partnerToken block iframe initialization, as noted on those pages and in Prerequisites.
fieldId is a stable, unique string that names one dictation session. Every callback returns it together with text so you know which field the result belongs to.It does not have to match a DOM id, but using the same string as your input’s id is a simple pattern.Naming examples and guidance: Configuration (Field IDs in practice) and Callbacks.
onSubmit runs when the user commits the transcript. If you omit it, dictation often closes immediately after the user acts, so production integrations should always implement it.Read Configuration and Callbacks for the full callback contract.
rootElement is the DOM node where the SDK mounts the dictation iframe. The iframe sizes to that container, so the node should have real width and height.Layout: Wrapper markup and CSS patterns are described under Wrapper layout on the Configuration page. In-field mode and Error handling cover related layout issues.React: Some examples omit rootElement; the React integration guide explains when the minimal pattern skips it and when to pass it (including refs in real apps). Configuration examples includes sample wiring.
Work through checks in this order:
  1. Runtime: Browser-only use, correct timing (call after the DOM and container exist and have size).
  2. Layout: rootElement (when used), height, and CSS.
  3. Auth and CSP: Valid partner credentials and any CSP rules that affect iframes.
  4. Configuration and callbacks: AuthConfig, ShowOptions, and a working onSubmit.
That order is documented on Error handling. Use Configuration for every option field.
Last modified on April 20, 2026