Introduction

These libraries talk to the Forms integration API: list published forms, load a page, keep field values in a FieldStore, and save a submission.

On this page

What you build

A host app that fills a published Comprehendly form. You pick one of two UI surfaces; both share the same store and save path.

Surface When
Generated FormView The host has no form widgets. The SDK draws a linear list of inputs.
Bind The host already has widgets. Map element.id → control.

Voice writes the same store through a hosted WebView/iframe. Do not implement Realtime in the native SDK.

The CDN script forms.js is a separate iframe widget. Use it when you want the hosted fill UI, not FieldStore.

Request flow

  1. Exchange a publishable key (pk_*) for a short-lived access_token.
  2. Call gateway operations with that token (catalog.list, page.get, save, voice mint).
  3. page.get loads fillable fields into FieldStore.
  4. User, bind, or voice patches merge in the store.
  5. submissions.save sends values keyed by field_name.

Method names are the same on every platform (idiomatic casing: page.get ≡ pageGet). apiVersion 1.

Choose a guide

Task Guide
First working call Quickstart
Draw fields from a page Render a form
Keep existing widgets Bind existing fields
Mic fill (silent or assistant) Fill with voice
Persist the store Save a submission

Packages

Platform Repository
JavaScript UD-Ultradigital/comprehendly-sdk-js
Swift UD-Ultradigital/comprehendly-sdk-swift
NextQuickstart