API reference
Contract: spec/sdk-api.md · Wire: spec/openapi.yaml.
SDK methods
| Method | Gateway operation | Notes |
|---|---|---|
configure / constructor / exchange |
integration_exchange |
Publishable key → access_token |
catalog.list(parentId?) |
forms.catalog.list |
Folders + published form pages |
page.get(pageId) |
forms.page.get |
Page + elements; loads FieldStore |
session.start({ pageId, mode }) |
forms.voice.start |
mode: silent | assistant |
session.resolve |
session.resolve |
Tenant, scopes, submitter_user_id |
submissions.save |
forms.submissions.save |
Values keyed by field_name |
store.set / bind / subscribe |
— | Local only. Patch schema: field-patch.schema.json |
Other gateway operations
Available on the gateway even if a given SDK has no helper yet:
| Operation | Purpose |
|---|---|
forms.submissions.list / .get |
Read submissions; optional subject_id |
session.prepare / .get / .complete |
Server-side subject context; prepared_session on fill URLs |
JS: client.gateway(operation, params). Swift: client.gateway(_:params:).
FieldStore patch
{
"element_id": "string | null",
"field_name": "string",
"value": {},
"source": "user" | "voice" | "bind" | "hydrate"
}Platform defaults
See spec/platform.json (functionsUrl, signup, embed script).
Page JSON: form-page.schema.json.