Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The id you choose becomes the config_id used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with DELETE /records/config/{config_id}/history first.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
id
string
required
Unique identifier. Must be unique across all configurations. Allowed characters: alphanumeric, underscore, hyphen.
Pattern: ^[a-zA-Z0-9_-]+$
name
string
required
Human-readable name for this configuration.
description
string
Optional longer description.
label
string
Optional short label.
schema
object
A JSON Schema document describing the record structure. Always a top-level object. UI and display hints (ui, display) are embedded directly in each field definition.
Show child attributes
views
object
UI layout definitions for different rendering contexts. forms (multiple named forms) is the current model. form (singular) is the deprecated legacy single form — the server still accepts it, but the frontend migrates it to forms: [{ id: "default", ... }] on read and never writes it back.
Show child attributes
index_fields
object[]
Payload fields lifted into the search index: the only ones a query, filter or metric can use. Replaced wholesale on update; an added or changed field, or a journey edit under a derived field, starts a background reindex.
Show child attributes
Response
Created record configuration
status_code
integer
HTTP status code echoed in the response body.
body
object
Response payload.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"QuivaWorks Docs","description":"","colors":{"primary":"#4641F2","light":"#ffffff","dark":"#4641F2"},"logo":{"light":"https://mintcdn.com/microstrate/Eit-IsSh6_6H8X4Q/logo/light.svg?fit=max\u0026auto=format\u0026n=Eit-IsSh6_6H8X4Q\u0026q=85\u0026s=01f10191a8ee36765af69b1436deb5e0","dark":"https://mintcdn.com/microstrate/Eit-IsSh6_6H8X4Q/logo/dark.svg?fit=max\u0026auto=format\u0026n=Eit-IsSh6_6H8X4Q\u0026q=85\u0026s=9dc23bd7a296bc325260ff32d2fc6d17"},"favicon":"https://mintcdn.com/microstrate/bn6ONmpX3KvP6AZn/favicon.svg?fit=max\u0026auto=format\u0026n=bn6ONmpX3KvP6AZn\u0026q=85\u0026s=af71ce7c16b2da43ee49a98290989182","appearance":{"default":"system"},"navbar":{"links":[{"href":"https://app.quiva.ai/en/login","label":"Log in"}],"primary":{"type":"button","label":"Try for free","href":"https://app.quiva.ai/en/signup"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/quivaworks"}},"fonts":{"family":"Be Vietnam Pro"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://quiva.ai/community"},{"anchor":"Support","icon":"headset","href":"https://quiva.ai/help-center/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"microstrate","hasAudioNarration":false,"actualSubdomain":"microstrate","customDomains":["docs.quiva.ai"],"gitSource":{"type":"github","owner":"quivaworks","repo":"quiva.ai","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b01a150bc9bec18ba0f1ea3","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":650},{"language":"default","tag":"Accounts","count":154},{"language":"default","tag":"Guides","count":129},{"language":"default","tag":"Records","count":84},{"language":"default","tag":"Assistants","count":83},{"language":"default","tag":"Workspaces","count":80},{"language":"default","tag":"Hub Flows","count":63},{"language":"default","tag":"Documents","count":52},{"language":"default","tag":"Abbie","count":48},{"language":"default","tag":"Spaces","count":44}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/record-configs/create-a-record-configuration","slug":"/api-reference/record-configs/create-a-record-configuration","pageMetadata":{"title":"Create a record configuration","description":"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The `id` you choose becomes the `config_id` used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with `DELETE /records/config/{config_id}/history` first.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config","href":"/api-reference/record-configs/create-a-record-configuration","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The \", _jsx(_components.code, {\n children: \"id\"\n }), \" you choose becomes the \", _jsx(_components.code, {\n children: \"config_id\"\n }), \" used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with \", _jsx(_components.code, {\n children: \"DELETE /records/config/{config_id}/history\"\n }), \" first.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a record configuration","description":"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The `id` you choose becomes the `config_id` used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with `DELETE /records/config/{config_id}/history` first.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config","href":"/api-reference/record-configs/create-a-record-configuration","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a record configuration","description":"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The `id` you choose becomes the `config_id` used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with `DELETE /records/config/{config_id}/history` first.","operationId":"createRecordConfig","tags":["Record Configs"],"x-resource-type":"service","requestBody":"9900b4d1-6b06-428e-b1fb-c935e4fd89f0","responses":{"200":"fea26257-c538-4bbe-84f2-d6388aa080d8","400":"c8ff410b-77fb-4348-aed5-1f8866a611cb","409":"cfa696cf-f7e1-4d84-ac91-6fb2e09fe8c6"},"method":"post","type":"path","servers":["fb1f0116-168e-4ecc-a177-f7285ec2151a"],"security":["244c586c-c8de-46b2-8ec6-6ed295e39edc","101873b0-49a5-47da-b437-3d1d872cdd6c"],"path":"/records/config","baseUrlOptions":["https://api.quiva.ai"],"title":"Create a record configuration","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"Unique identifier. Must be unique across all configurations. Allowed characters: alphanumeric, underscore, hyphen.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"Human-readable name for this configuration.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"Optional longer description.","uniqueKey":"description","typeLabel":"string"},"label":{"type":"string","description":"Optional short label.","uniqueKey":"label","typeLabel":"string"},"schema":{"type":"object","description":"A JSON Schema document describing the record structure. Always a top-level object. UI and display hints (`ui`, `display`) are embedded directly in each field definition.","required":["type","properties"],"properties":{"type":{"type":"string","enum":["object"],"description":"Must be \"object\" — a record schema always describes a top-level object.","isRequired":true,"uniqueKey":"schema.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Definition of a single field at any depth of the schema tree. Recurses via `properties` (objects) and `items` (arrays). Only `type` is required. Input config for a placed form field belongs on the view node (ViewFieldNode.inputType/props), NOT here; the legacy `ui` hint is a fallback only.","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","description":"JSON type(s) for this field. Use an array to allow multiple types (e.g. [\"string\", \"null\"]).","enum":["string","number","integer","boolean","object","array","null"],"isRequired":true,"uniqueKey":"schema.properties.additionalProperties.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"type":"string","description":"Allowed JSON primitive/composite types for a schema field.","enum":["string","number","integer","boolean","object","array","null"],"uniqueKey":"schema.properties.additionalProperties.type.oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"JSON type(s) for this field. Use an array to allow multiple types (e.g. [\"string\", \"null\"]).","uniqueItems":true,"isRequired":true,"uniqueKey":"schema.properties.additionalProperties.type.oneOf.1","typeLabel":"enum\u003cstring>[]"}],"isRequired":true,"uniqueKey":"schema.properties.additionalProperties.type","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"label":{"type":"string","description":"Human-readable label shown in UI.","uniqueKey":"schema.properties.additionalProperties.label","typeLabel":"string"},"title":{"type":"string","description":"JSON Schema title.","uniqueKey":"schema.properties.additionalProperties.title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"schema.properties.additionalProperties.description","typeLabel":"string"},"minimum":{"type":"number","uniqueKey":"schema.properties.additionalProperties.minimum","typeLabel":"number"},"maximum":{"type":"number","uniqueKey":"schema.properties.additionalProperties.maximum","typeLabel":"number"},"exclusiveMinimum":{"type":"number","uniqueKey":"schema.properties.additionalProperties.exclusiveMinimum","typeLabel":"number"},"exclusiveMaximum":{"type":"number","uniqueKey":"schema.properties.additionalProperties.exclusiveMaximum","typeLabel":"number"},"minLength":{"type":"integer","minimum":0,"uniqueKey":"schema.properties.additionalProperties.minLength","typeLabel":"integer"},"maxLength":{"type":"integer","minimum":0,"uniqueKey":"schema.properties.additionalProperties.maxLength","typeLabel":"integer"},"pattern":{"type":"string","uniqueKey":"schema.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","uniqueKey":"schema.properties.additionalProperties.format","typeLabel":"string"},"enum":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"schema.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"any"},"uniqueKey":"schema.properties.additionalProperties.enum","typeLabel":"any[]"},"default":{"oneOf":[{}],"uniqueKey":"schema.properties.additionalProperties.default","typeLabel":"any"},"properties":{"type":"object","additionalProperties":{"$circularRef":"3cc1cc3a-7277-4699-b795-b5c62e48760b"},"description":"Nested field definitions for object-typed fields.","uniqueKey":"schema.properties.additionalProperties.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"schema.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"description":"Names of required nested fields. Only meaningful when `type` is \"object\".","uniqueKey":"schema.properties.additionalProperties.required","typeLabel":"string[]"},"items":{"$circularRef":"3cc1cc3a-7277-4699-b795-b5c62e48760b","description":"Item schema for array-typed fields.","uniqueKey":"schema.properties.additionalProperties.\\items","typeLabel":"any"},"ui":{"type":"object","description":"LEGACY UI fallback (not standard JSON Schema). Prefer node-level inputType/props on the view field node; this is only read for descendants that are not their own view node and is stripped from placed fields on save.","properties":{"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"],"uniqueKey":"schema.properties.additionalProperties.ui.inputType","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this.","uniqueKey":"schema.properties.additionalProperties.ui.props.label","typeLabel":"string"},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty.","uniqueKey":"schema.properties.additionalProperties.ui.props.placeholder","typeLabel":"string"},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format.","uniqueKey":"schema.properties.additionalProperties.ui.props.helpText.markdown","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"schema.properties.additionalProperties.ui.props.helpText","typeLabel":"object"},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true,"uniqueKey":"schema.properties.additionalProperties.ui.props.options.items.[INDEX].text","typeLabel":"string"},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true,"uniqueKey":"schema.properties.additionalProperties.ui.props.options.items.[INDEX].value","typeLabel":"string"},"note":{"type":"string","description":"Optional extra description shown alongside the option.","uniqueKey":"schema.properties.additionalProperties.ui.props.options.items.[INDEX].note","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"schema.properties.additionalProperties.ui.props.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"schema.properties.additionalProperties.ui.props.options","typeLabel":"object[]"},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering.","uniqueKey":"schema.properties.additionalProperties.ui.props.sort","typeLabel":"boolean"},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"schema.properties.additionalProperties.ui.props.minDate","typeLabel":"string\u003cdate-time>"},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"schema.properties.additionalProperties.ui.props.maxDate","typeLabel":"string\u003cdate-time>"},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"schema.properties.additionalProperties.ui.props.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"schema.properties.additionalProperties.ui.props.max","typeLabel":"number"},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs.","uniqueKey":"schema.properties.additionalProperties.ui.props.decimalPlace","typeLabel":"integer"},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`.","uniqueKey":"schema.properties.additionalProperties.ui.props.maxItems","typeLabel":"integer"},"includedCountries":{"type":"array","items":{"type":"string","uniqueKey":"schema.properties.additionalProperties.ui.props.includedCountries.items.[INDEX]","typeLabel":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`.","uniqueKey":"schema.properties.additionalProperties.ui.props.includedCountries","typeLabel":"string[]"},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`.","uniqueKey":"schema.properties.additionalProperties.ui.props.showNativeName","typeLabel":"boolean"}},"uniqueKey":"schema.properties.additionalProperties.ui.props","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.properties.additionalProperties.ui","typeLabel":"object"},"display":{"type":"object","description":"Display configuration embedded in a schema field.","properties":{"formatter":{"type":"object","description":"Formatter applied when displaying a field value.","required":["type"],"properties":{"type":{"type":"string","description":"Display formatter applied when rendering a field value.","enum":["text","number","currency","percent","date","datetime","time","boolean"],"isRequired":true,"uniqueKey":"schema.properties.additionalProperties.display.formatter.type","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Extra props forwarded to the formatter.","uniqueKey":"schema.properties.additionalProperties.display.formatter.props","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.properties.additionalProperties.display.formatter","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.properties.additionalProperties.display","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"schema.properties.additionalProperties","typeLabel":"object"},"description":"Top-level field definitions keyed by field name.","isRequired":true,"uniqueKey":"schema.properties","typeLabel":"object"},"$schema":{"type":"string","description":"Optional JSON Schema dialect URI (e.g. \"https://json-schema.org/draft/2020-12/schema\").","uniqueKey":"schema.$schema","typeLabel":"string"},"required":{"type":"array","items":{"type":"string","uniqueKey":"schema.required.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"description":"Names of required top-level fields.","uniqueKey":"schema.required","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"schema","typeLabel":"object"},"views":{"type":"object","description":"UI layout definitions for different rendering contexts. `forms` (multiple named forms) is the current model. `form` (singular) is the deprecated legacy single form — the server still accepts it, but the frontend migrates it to `forms: [{ id: \"default\", ... }]` on read and never writes it back.","properties":{"forms":{"type":"array","description":"Current model — multiple named forms per config.","items":{"type":"object","description":"One named form for a config: metadata plus a grid layout tree. `id` is unique within the config and appears in the app URL; the migrated legacy single form always gets id \"default\".","required":["id","title","layout"],"properties":{"id":{"type":"string","description":"Unique within the config.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].title","typeLabel":"string"},"layout":{"type":"object","description":"A grid layout container that arranges child nodes in CSS grid columns.","required":["type","props","children"],"properties":{"type":{"type":"string","enum":["grid"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.type","typeLabel":"enum\u003cstring>"},"props":{"type":"object","description":"CSS Grid container properties.","required":["gridTemplateColumns"],"properties":{"gridTemplateColumns":{"type":"string","description":"CSS grid-template-columns value (e.g. \"1fr 1fr\", \"repeat(3, 1fr)\").","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.props.gridTemplateColumns","typeLabel":"string"},"gap":{"type":"number","description":"Gap between grid cells in pixels.","uniqueKey":"views.forms.items.[INDEX].layout.props.gap","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.props","typeLabel":"object"},"children":{"type":"array","items":{"oneOf":[{"description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.0","typeLabel":"any"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field"],"example":{"type":"field","field":"policyNumber","inputType":"text","props":{"label":"Policy number"}},"properties":{"type":{"type":"string","enum":["field"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to the schema field (e.g. \"name\", \"address.city\"). The property key is `field` (a `ref` key is ignored by the engine).","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.field","typeLabel":"string"},"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"],"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.inputType","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.label","typeLabel":"string"},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.placeholder","typeLabel":"string"},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.helpText.markdown","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.helpText","typeLabel":"object"},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].text","typeLabel":"string"},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].value","typeLabel":"string"},"note":{"type":"string","description":"Optional extra description shown alongside the option.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].note","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options","typeLabel":"object[]"},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.sort","typeLabel":"boolean"},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.minDate","typeLabel":"string\u003cdate-time>"},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.maxDate","typeLabel":"string\u003cdate-time>"},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.max","typeLabel":"number"},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.decimalPlace","typeLabel":"integer"},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.maxItems","typeLabel":"integer"},"includedCountries":{"type":"array","items":{"type":"string","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.includedCountries.items.[INDEX]","typeLabel":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.includedCountries","typeLabel":"string[]"},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.showNativeName","typeLabel":"boolean"}},"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props","typeLabel":"object"},"rules":{"type":"array","description":"Conditional rules for this field. Field nodes support all five rule properties.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field","children"],"example":{"type":"array-field","field":"products","props":{"label":"Products","itemLabel":"Product","required":true,"minItems":1},"children":[{"type":"field","field":"title","inputType":"text","props":{"label":"Title"}},{"type":"field","field":"price","inputType":"currency","props":{"label":"Price","min":0,"decimalPlace":2}}]},"properties":{"type":{"type":"string","enum":["array-field"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to an array-of-object schema field.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.field","typeLabel":"string"},"children":{"type":"array","description":"View nodes for one item, with element-relative `field` refs. Child field nodes carry their own node-level inputType/props/rules.","items":{"$circularRef":"18502427-ad58-45a5-9347-1f037d0a8014"},"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.children","typeLabel":"array"},"props":{"type":"object","description":"UI-only container config: label, required (at least one item), minItems, maxItems, collapsible, defaultCollapsed.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.props","typeLabel":"object"},"rules":{"type":"array","description":"Reserved — array-field rules are NOT evaluated in v1. Put rules on the child field nodes instead.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns.items.[INDEX].field","typeLabel":"string"},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns.items.[INDEX].order","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"views.forms.items.[INDEX].layout.children.items.[INDEX]","typeLabel":"any · object · object · object"},"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.children","typeLabel":"any · object · object · object[]"},"rules":{"type":"array","description":"Conditional rules for this container. Only the `visible` property is honoured on a grid.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"views.forms.items.[INDEX].layout.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.forms.items.[INDEX].layout.rules","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"views.forms.items.[INDEX].layout","typeLabel":"object"},"description":{"type":"string","uniqueKey":"views.forms.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"views.forms.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.forms","typeLabel":"object[]"},"form":{"type":"object","description":"Deprecated legacy single form. Use `forms` instead.","required":["type","props","children"],"properties":{"type":{"type":"string","enum":["grid"],"isRequired":true,"uniqueKey":"views.form.type","typeLabel":"enum\u003cstring>"},"props":{"type":"object","description":"CSS Grid container properties.","required":["gridTemplateColumns"],"properties":{"gridTemplateColumns":{"type":"string","description":"CSS grid-template-columns value (e.g. \"1fr 1fr\", \"repeat(3, 1fr)\").","isRequired":true,"uniqueKey":"views.form.props.gridTemplateColumns","typeLabel":"string"},"gap":{"type":"number","description":"Gap between grid cells in pixels.","uniqueKey":"views.form.props.gap","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"views.form.props","typeLabel":"object"},"children":{"type":"array","items":{"oneOf":[{"description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","uniqueKey":"views.form.children.items.[INDEX].oneOf.0","typeLabel":"any"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field"],"example":{"type":"field","field":"policyNumber","inputType":"text","props":{"label":"Policy number"}},"properties":{"type":{"type":"string","enum":["field"],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to the schema field (e.g. \"name\", \"address.city\"). The property key is `field` (a `ref` key is ignored by the engine).","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.field","typeLabel":"string"},"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"],"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.inputType","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.label","typeLabel":"string"},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.placeholder","typeLabel":"string"},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.helpText.markdown","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.helpText","typeLabel":"object"},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].text","typeLabel":"string"},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].value","typeLabel":"string"},"note":{"type":"string","description":"Optional extra description shown alongside the option.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].note","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.options","typeLabel":"object[]"},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.sort","typeLabel":"boolean"},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.minDate","typeLabel":"string\u003cdate-time>"},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.maxDate","typeLabel":"string\u003cdate-time>"},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.max","typeLabel":"number"},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.decimalPlace","typeLabel":"integer"},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.maxItems","typeLabel":"integer"},"includedCountries":{"type":"array","items":{"type":"string","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.includedCountries.items.[INDEX]","typeLabel":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.includedCountries","typeLabel":"string[]"},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props.showNativeName","typeLabel":"boolean"}},"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.props","typeLabel":"object"},"rules":{"type":"array","description":"Conditional rules for this field. Field nodes support all five rule properties.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.form.children.items.[INDEX].oneOf.1.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.form.children.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field","children"],"example":{"type":"array-field","field":"products","props":{"label":"Products","itemLabel":"Product","required":true,"minItems":1},"children":[{"type":"field","field":"title","inputType":"text","props":{"label":"Title"}},{"type":"field","field":"price","inputType":"currency","props":{"label":"Price","min":0,"decimalPlace":2}}]},"properties":{"type":{"type":"string","enum":["array-field"],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to an array-of-object schema field.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.field","typeLabel":"string"},"children":{"type":"array","description":"View nodes for one item, with element-relative `field` refs. Child field nodes carry their own node-level inputType/props/rules.","items":{"$circularRef":"18502427-ad58-45a5-9347-1f037d0a8014"},"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.children","typeLabel":"array"},"props":{"type":"object","description":"UI-only container config: label, required (at least one item), minItems, maxItems, collapsible, defaultCollapsed.","uniqueKey":"views.form.children.items.[INDEX].oneOf.2.props","typeLabel":"object"},"rules":{"type":"array","description":"Reserved — array-field rules are NOT evaluated in v1. Put rules on the child field nodes instead.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.form.children.items.[INDEX].oneOf.2.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.form.children.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.3.columns.items.[INDEX].field","typeLabel":"string"},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.3.columns.items.[INDEX].order","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"views.form.children.items.[INDEX].oneOf.3.columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"views.form.children.items.[INDEX].oneOf.3.columns","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.form.children.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"views.form.children.items.[INDEX]","typeLabel":"any · object · object · object"},"isRequired":true,"uniqueKey":"views.form.children","typeLabel":"any · object · object · object[]"},"rules":{"type":"array","description":"Conditional rules for this container. Only the `visible` property is honoured on a grid.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"views.form.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"views.form.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.form.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"views.form.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"views.form.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"views.form.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"views.form.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"views.form.rules","typeLabel":"object[]"}},"additionalProperties":false,"deprecated":true,"uniqueKey":"views.form","typeLabel":"object"},"table":{"type":"object","description":"A table view that lists columns to display and their order.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true,"uniqueKey":"views.table.type","typeLabel":"enum\u003cstring>"},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true,"uniqueKey":"views.table.columns.items.[INDEX].field","typeLabel":"string"},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true,"uniqueKey":"views.table.columns.items.[INDEX].order","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"views.table.columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"views.table.columns","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"views.table","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"views","typeLabel":"object"},"index_fields":{"type":"array","description":"Payload fields lifted into the search index: the only ones a query, filter or metric can use. Replaced wholesale on update; an added or changed field, or a journey edit under a derived field, starts a background reindex.","items":{"type":"object","required":["field"],"properties":{"field":{"type":"string","description":"Dotted path into the record's data; also accepted as `key`. Indexed as `data_\u003cpath with dots as underscores>`.","isRequired":true,"uniqueKey":"index_fields.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["keyword","text","text_sortable","number","numeric","date","datetime"],"description":"Empty means keyword.","uniqueKey":"index_fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"sortable":{"type":"boolean","description":"Usable as sort_by.","uniqueKey":"index_fields.items.[INDEX].sortable","typeLabel":"boolean"},"derive":{"type":"object","description":"Computes the field's value when the record is indexed instead of reading `data[field]`. The field must be a keyword, a single name, and not a schema property. A metric can filter on it and group by it; a run grouped by it is refused when it cannot be pushed down to the index.","required":["kind"],"properties":{"kind":{"type":"string","enum":["journey_round","member_progress"],"description":"`journey_round`: `turn` or `handed` for an open round of the journey the record runs (`views.forms[].journey`); absent once the round is ended, closed or at an unknown stage. `member_progress`: how far a member's form row has got, by the rule's other fields: `done`, `done_agreed`, `to_confirm`, `answered_sent`, `answered_unsent`, `sent` or `open`, on the member's one row only (see `anchor`).","isRequired":true,"uniqueKey":"index_fields.items.[INDEX].derive.kind","typeLabel":"enum\u003cstring>"},"done_field":{"type":"string","description":"`member_progress`: filled once the row is finished. Without it, the record's `completed` flag.","uniqueKey":"index_fields.items.[INDEX].derive.done_field","typeLabel":"string"},"answer_fields":{"type":"array","items":{"type":"string","uniqueKey":"index_fields.items.[INDEX].derive.answer_fields.items.[INDEX]","typeLabel":"string"},"description":"`member_progress`: the dotted fields that count as answers. Wins over `answer_prefix`.","uniqueKey":"index_fields.items.[INDEX].derive.answer_fields","typeLabel":"string[]"},"answer_prefix":{"type":"string","description":"`member_progress`: top-level keys starting with this are answers. Without either, every key but bookkeeping and `sent_field` is.","uniqueKey":"index_fields.items.[INDEX].derive.answer_prefix","typeLabel":"string"},"form":{"type":"string","description":"`member_progress`: a finished row with readiness gaps on this form (`state.readiness[form].missing`) is `to_confirm`.","uniqueKey":"index_fields.items.[INDEX].derive.form","typeLabel":"string"},"sent_field":{"type":"string","description":"`member_progress`: filled when the row was sent. Without it, no row reads as sent.","uniqueKey":"index_fields.items.[INDEX].derive.sent_field","typeLabel":"string"},"agreed_field":{"type":"string","description":"`member_progress`: a finished row whose field holds a number is `done_agreed`.","uniqueKey":"index_fields.items.[INDEX].derive.agreed_field","typeLabel":"string"},"reset_on_send":{"type":"array","items":{"type":"string","uniqueKey":"index_fields.items.[INDEX].derive.reset_on_send.items.[INDEX]","typeLabel":"string"},"description":"`member_progress`: fields a send clears to `false`. `false` in one of them is no answer; `false` elsewhere is.","uniqueKey":"index_fields.items.[INDEX].derive.reset_on_send","typeLabel":"string[]"},"anchor":{"type":"boolean","description":"`member_progress`: the members' own anchor config, whose row is each member's anchor record (filed under a parent folder, at a bare member folder). Without it, only the row at the member's fixed id gets a value.","uniqueKey":"index_fields.items.[INDEX].derive.anchor","typeLabel":"boolean"}},"uniqueKey":"index_fields.items.[INDEX].derive","typeLabel":"object"}},"uniqueKey":"index_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"index_fields","typeLabel":"object[]"}},"example":{"id":"customer_feedback","name":"Customer Feedback","description":"Feedback submissions from customers","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rating":{"type":"number","title":"Rating","description":"Rating (1–5)","display":{"formatter":{"type":"number"}}},"category":{"type":"string","title":"Category","enum":["bug","feature","general"]},"comment":{"type":"string","title":"Comment"}},"required":["rating","category"]},"views":{"forms":[{"id":"default","title":"Default","layout":{"type":"grid","props":{"gridTemplateColumns":"1fr"},"children":[{"type":"grid","props":{"gridTemplateColumns":"1fr 1fr"},"children":[{"type":"field","field":"rating","inputType":"slider","props":{"label":"Rating","min":1,"max":5}},{"type":"field","field":"category","inputType":"dropdown","props":{"label":"Category","options":[{"text":"Bug","value":"bug"},{"text":"Feature","value":"feature"},{"text":"General","value":"general"}]}}]},{"type":"field","field":"comment","inputType":"textarea","props":{"label":"Comment"},"rules":[{"id":"comment.required","property":"required","logic":{"\u003c=":[{"var":"rating"},2]},"description":"A comment is required when the rating is 2 or lower."}]}]}}],"table":{"type":"table","columns":[{"field":"rating","order":0},{"field":"category","order":1},{"field":"comment","order":2}]}}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"customer_feedback","name":"Customer Feedback","description":"Feedback submissions from customers","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rating":{"type":"number","title":"Rating","description":"Rating (1–5)","display":{"formatter":{"type":"number"}}},"category":{"type":"string","title":"Category","enum":["bug","feature","general"]},"comment":{"type":"string","title":"Comment"}},"required":["rating","category"]},"views":{"forms":[{"id":"default","title":"Default","layout":{"type":"grid","props":{"gridTemplateColumns":"1fr"},"children":[{"type":"grid","props":{"gridTemplateColumns":"1fr 1fr"},"children":[{"type":"field","field":"rating","inputType":"slider","props":{"label":"Rating","min":1,"max":5}},{"type":"field","field":"category","inputType":"dropdown","props":{"label":"Category","options":[{"text":"Bug","value":"bug"},{"text":"Feature","value":"feature"},{"text":"General","value":"general"}]}}]},{"type":"field","field":"comment","inputType":"textarea","props":{"label":"Comment"},"rules":[{"id":"comment.required","property":"required","logic":{"\u003c=":[{"var":"rating"},2]},"description":"A comment is required when the rating is 2 or lower."}]}]}}],"table":{"type":"table","columns":[{"field":"rating","order":0},{"field":"category","order":1},{"field":"comment","order":2}]}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"fea26257-c538-4bbe-84f2-d6388aa080d8":{"description":"Created record configuration","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","description":"HTTP status code echoed in the response body.","uniqueKey":"status_code","typeLabel":"integer"},"body":{"type":"object","description":"Response payload.","required":["id","name","schema"],"properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"Unique identifier. Immutable after creation. Allowed characters: alphanumeric, underscore, hyphen.","isRequired":true,"uniqueKey":"body.id","typeLabel":"string"},"name":{"type":"string","description":"Human-readable name for this configuration.","isRequired":true,"uniqueKey":"body.name","typeLabel":"string"},"schema":{"type":"object","description":"A JSON Schema document describing the record structure. Always a top-level object. UI and display hints (`ui`, `display`) are embedded directly in each field definition.","required":["type","properties"],"properties":{"type":{"type":"string","enum":["object"],"description":"Must be \"object\" — a record schema always describes a top-level object.","isRequired":true,"uniqueKey":"body.schema.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Definition of a single field at any depth of the schema tree. Recurses via `properties` (objects) and `items` (arrays). Only `type` is required. Input config for a placed form field belongs on the view node (ViewFieldNode.inputType/props), NOT here; the legacy `ui` hint is a fallback only.","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","description":"JSON type(s) for this field. Use an array to allow multiple types (e.g. [\"string\", \"null\"]).","enum":["string","number","integer","boolean","object","array","null"],"isRequired":true,"uniqueKey":"body.schema.properties.additionalProperties.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"type":"string","description":"Allowed JSON primitive/composite types for a schema field.","enum":["string","number","integer","boolean","object","array","null"],"uniqueKey":"body.schema.properties.additionalProperties.type.oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"JSON type(s) for this field. Use an array to allow multiple types (e.g. [\"string\", \"null\"]).","uniqueItems":true,"isRequired":true,"uniqueKey":"body.schema.properties.additionalProperties.type.oneOf.1","typeLabel":"enum\u003cstring>[]"}],"isRequired":true,"uniqueKey":"body.schema.properties.additionalProperties.type","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"label":{"type":"string","description":"Human-readable label shown in UI.","uniqueKey":"body.schema.properties.additionalProperties.label","typeLabel":"string"},"title":{"type":"string","description":"JSON Schema title.","uniqueKey":"body.schema.properties.additionalProperties.title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"body.schema.properties.additionalProperties.description","typeLabel":"string"},"minimum":{"type":"number","uniqueKey":"body.schema.properties.additionalProperties.minimum","typeLabel":"number"},"maximum":{"type":"number","uniqueKey":"body.schema.properties.additionalProperties.maximum","typeLabel":"number"},"exclusiveMinimum":{"type":"number","uniqueKey":"body.schema.properties.additionalProperties.exclusiveMinimum","typeLabel":"number"},"exclusiveMaximum":{"type":"number","uniqueKey":"body.schema.properties.additionalProperties.exclusiveMaximum","typeLabel":"number"},"minLength":{"type":"integer","minimum":0,"uniqueKey":"body.schema.properties.additionalProperties.minLength","typeLabel":"integer"},"maxLength":{"type":"integer","minimum":0,"uniqueKey":"body.schema.properties.additionalProperties.maxLength","typeLabel":"integer"},"pattern":{"type":"string","uniqueKey":"body.schema.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","uniqueKey":"body.schema.properties.additionalProperties.format","typeLabel":"string"},"enum":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"body.schema.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"any"},"uniqueKey":"body.schema.properties.additionalProperties.enum","typeLabel":"any[]"},"default":{"oneOf":[{}],"uniqueKey":"body.schema.properties.additionalProperties.default","typeLabel":"any"},"properties":{"type":"object","additionalProperties":{"$circularRef":"3cc1cc3a-7277-4699-b795-b5c62e48760b"},"description":"Nested field definitions for object-typed fields.","uniqueKey":"body.schema.properties.additionalProperties.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"body.schema.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"description":"Names of required nested fields. Only meaningful when `type` is \"object\".","uniqueKey":"body.schema.properties.additionalProperties.required","typeLabel":"string[]"},"items":{"$circularRef":"3cc1cc3a-7277-4699-b795-b5c62e48760b","description":"Item schema for array-typed fields.","uniqueKey":"body.schema.properties.additionalProperties.\\items","typeLabel":"any"},"ui":{"type":"object","description":"LEGACY UI fallback (not standard JSON Schema). Prefer node-level inputType/props on the view field node; this is only read for descendants that are not their own view node and is stripped from placed fields on save.","properties":{"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"],"uniqueKey":"body.schema.properties.additionalProperties.ui.inputType","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.label","typeLabel":"string"},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.placeholder","typeLabel":"string"},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.helpText.markdown","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.schema.properties.additionalProperties.ui.props.helpText","typeLabel":"object"},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true,"uniqueKey":"body.schema.properties.additionalProperties.ui.props.options.items.[INDEX].text","typeLabel":"string"},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true,"uniqueKey":"body.schema.properties.additionalProperties.ui.props.options.items.[INDEX].value","typeLabel":"string"},"note":{"type":"string","description":"Optional extra description shown alongside the option.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.options.items.[INDEX].note","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.schema.properties.additionalProperties.ui.props.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.schema.properties.additionalProperties.ui.props.options","typeLabel":"object[]"},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.sort","typeLabel":"boolean"},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.minDate","typeLabel":"string\u003cdate-time>"},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.maxDate","typeLabel":"string\u003cdate-time>"},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.max","typeLabel":"number"},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.decimalPlace","typeLabel":"integer"},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.maxItems","typeLabel":"integer"},"includedCountries":{"type":"array","items":{"type":"string","uniqueKey":"body.schema.properties.additionalProperties.ui.props.includedCountries.items.[INDEX]","typeLabel":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.includedCountries","typeLabel":"string[]"},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`.","uniqueKey":"body.schema.properties.additionalProperties.ui.props.showNativeName","typeLabel":"boolean"}},"uniqueKey":"body.schema.properties.additionalProperties.ui.props","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"body.schema.properties.additionalProperties.ui","typeLabel":"object"},"display":{"type":"object","description":"Display configuration embedded in a schema field.","properties":{"formatter":{"type":"object","description":"Formatter applied when displaying a field value.","required":["type"],"properties":{"type":{"type":"string","description":"Display formatter applied when rendering a field value.","enum":["text","number","currency","percent","date","datetime","time","boolean"],"isRequired":true,"uniqueKey":"body.schema.properties.additionalProperties.display.formatter.type","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Extra props forwarded to the formatter.","uniqueKey":"body.schema.properties.additionalProperties.display.formatter.props","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"body.schema.properties.additionalProperties.display.formatter","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"body.schema.properties.additionalProperties.display","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"body.schema.properties.additionalProperties","typeLabel":"object"},"description":"Top-level field definitions keyed by field name.","isRequired":true,"uniqueKey":"body.schema.properties","typeLabel":"object"},"$schema":{"type":"string","description":"Optional JSON Schema dialect URI (e.g. \"https://json-schema.org/draft/2020-12/schema\").","uniqueKey":"body.schema.$schema","typeLabel":"string"},"required":{"type":"array","items":{"type":"string","uniqueKey":"body.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueItems":true,"description":"Names of required top-level fields.","uniqueKey":"body.schema.required","typeLabel":"string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"body.schema","typeLabel":"object"},"description":{"type":"string","description":"Optional longer description of what this configuration represents.","uniqueKey":"body.description","typeLabel":"string"},"label":{"type":"string","description":"Optional short label, e.g. for UI badges or tabs.","uniqueKey":"body.label","typeLabel":"string"},"views":{"type":"object","description":"UI layout definitions for different rendering contexts. `forms` (multiple named forms) is the current model. `form` (singular) is the deprecated legacy single form — the server still accepts it, but the frontend migrates it to `forms: [{ id: \"default\", ... }]` on read and never writes it back.","properties":{"forms":{"type":"array","description":"Current model — multiple named forms per config.","items":{"type":"object","description":"One named form for a config: metadata plus a grid layout tree. `id` is unique within the config and appears in the app URL; the migrated legacy single form always gets id \"default\".","required":["id","title","layout"],"properties":{"id":{"type":"string","description":"Unique within the config.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].title","typeLabel":"string"},"layout":{"type":"object","description":"A grid layout container that arranges child nodes in CSS grid columns.","required":["type","props","children"],"properties":{"type":{"type":"string","enum":["grid"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.type","typeLabel":"enum\u003cstring>"},"props":{"type":"object","description":"CSS Grid container properties.","required":["gridTemplateColumns"],"properties":{"gridTemplateColumns":{"type":"string","description":"CSS grid-template-columns value (e.g. \"1fr 1fr\", \"repeat(3, 1fr)\").","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.props.gridTemplateColumns","typeLabel":"string"},"gap":{"type":"number","description":"Gap between grid cells in pixels.","uniqueKey":"body.views.forms.items.[INDEX].layout.props.gap","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.props","typeLabel":"object"},"children":{"type":"array","items":{"oneOf":[{"description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.0","typeLabel":"any"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field"],"example":{"type":"field","field":"policyNumber","inputType":"text","props":{"label":"Policy number"}},"properties":{"type":{"type":"string","enum":["field"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to the schema field (e.g. \"name\", \"address.city\"). The property key is `field` (a `ref` key is ignored by the engine).","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.field","typeLabel":"string"},"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"],"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.inputType","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.label","typeLabel":"string"},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.placeholder","typeLabel":"string"},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.helpText.markdown","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.helpText","typeLabel":"object"},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].text","typeLabel":"string"},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].value","typeLabel":"string"},"note":{"type":"string","description":"Optional extra description shown alongside the option.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].note","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.options","typeLabel":"object[]"},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.sort","typeLabel":"boolean"},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.minDate","typeLabel":"string\u003cdate-time>"},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.maxDate","typeLabel":"string\u003cdate-time>"},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.max","typeLabel":"number"},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.decimalPlace","typeLabel":"integer"},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.maxItems","typeLabel":"integer"},"includedCountries":{"type":"array","items":{"type":"string","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.includedCountries.items.[INDEX]","typeLabel":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.includedCountries","typeLabel":"string[]"},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props.showNativeName","typeLabel":"boolean"}},"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.props","typeLabel":"object"},"rules":{"type":"array","description":"Conditional rules for this field. Field nodes support all five rule properties.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field","children"],"example":{"type":"array-field","field":"products","props":{"label":"Products","itemLabel":"Product","required":true,"minItems":1},"children":[{"type":"field","field":"title","inputType":"text","props":{"label":"Title"}},{"type":"field","field":"price","inputType":"currency","props":{"label":"Price","min":0,"decimalPlace":2}}]},"properties":{"type":{"type":"string","enum":["array-field"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to an array-of-object schema field.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.field","typeLabel":"string"},"children":{"type":"array","description":"View nodes for one item, with element-relative `field` refs. Child field nodes carry their own node-level inputType/props/rules.","items":{"$circularRef":"18502427-ad58-45a5-9347-1f037d0a8014"},"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.children","typeLabel":"array"},"props":{"type":"object","description":"UI-only container config: label, required (at least one item), minItems, maxItems, collapsible, defaultCollapsed.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.props","typeLabel":"object"},"rules":{"type":"array","description":"Reserved — array-field rules are NOT evaluated in v1. Put rules on the child field nodes instead.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns.items.[INDEX].field","typeLabel":"string"},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns.items.[INDEX].order","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3.columns","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"body.views.forms.items.[INDEX].layout.children.items.[INDEX]","typeLabel":"any · object · object · object"},"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.children","typeLabel":"any · object · object · object[]"},"rules":{"type":"array","description":"Conditional rules for this container. Only the `visible` property is honoured on a grid.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"body.views.forms.items.[INDEX].layout.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.forms.items.[INDEX].layout.rules","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"body.views.forms.items.[INDEX].layout","typeLabel":"object"},"description":{"type":"string","uniqueKey":"body.views.forms.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.views.forms.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.forms","typeLabel":"object[]"},"form":{"type":"object","description":"Deprecated legacy single form. Use `forms` instead.","required":["type","props","children"],"properties":{"type":{"type":"string","enum":["grid"],"isRequired":true,"uniqueKey":"body.views.form.type","typeLabel":"enum\u003cstring>"},"props":{"type":"object","description":"CSS Grid container properties.","required":["gridTemplateColumns"],"properties":{"gridTemplateColumns":{"type":"string","description":"CSS grid-template-columns value (e.g. \"1fr 1fr\", \"repeat(3, 1fr)\").","isRequired":true,"uniqueKey":"body.views.form.props.gridTemplateColumns","typeLabel":"string"},"gap":{"type":"number","description":"Gap between grid cells in pixels.","uniqueKey":"body.views.form.props.gap","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"body.views.form.props","typeLabel":"object"},"children":{"type":"array","items":{"oneOf":[{"description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.0","typeLabel":"any"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field"],"example":{"type":"field","field":"policyNumber","inputType":"text","props":{"label":"Policy number"}},"properties":{"type":{"type":"string","enum":["field"],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to the schema field (e.g. \"name\", \"address.city\"). The property key is `field` (a `ref` key is ignored by the engine).","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.field","typeLabel":"string"},"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"],"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.inputType","typeLabel":"enum\u003cstring>"},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.label","typeLabel":"string"},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.placeholder","typeLabel":"string"},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.helpText.markdown","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.helpText","typeLabel":"object"},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].text","typeLabel":"string"},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].value","typeLabel":"string"},"note":{"type":"string","description":"Optional extra description shown alongside the option.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX].note","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.options","typeLabel":"object[]"},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.sort","typeLabel":"boolean"},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.minDate","typeLabel":"string\u003cdate-time>"},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.maxDate","typeLabel":"string\u003cdate-time>"},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.max","typeLabel":"number"},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.decimalPlace","typeLabel":"integer"},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.maxItems","typeLabel":"integer"},"includedCountries":{"type":"array","items":{"type":"string","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.includedCountries.items.[INDEX]","typeLabel":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.includedCountries","typeLabel":"string[]"},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props.showNativeName","typeLabel":"boolean"}},"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.props","typeLabel":"object"},"rules":{"type":"array","description":"Conditional rules for this field. Field nodes support all five rule properties.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field","children"],"example":{"type":"array-field","field":"products","props":{"label":"Products","itemLabel":"Product","required":true,"minItems":1},"children":[{"type":"field","field":"title","inputType":"text","props":{"label":"Title"}},{"type":"field","field":"price","inputType":"currency","props":{"label":"Price","min":0,"decimalPlace":2}}]},"properties":{"type":{"type":"string","enum":["array-field"],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"field":{"type":"string","description":"Dotted path to an array-of-object schema field.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.field","typeLabel":"string"},"children":{"type":"array","description":"View nodes for one item, with element-relative `field` refs. Child field nodes carry their own node-level inputType/props/rules.","items":{"$circularRef":"18502427-ad58-45a5-9347-1f037d0a8014"},"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.children","typeLabel":"array"},"props":{"type":"object","description":"UI-only container config: label, required (at least one item), minItems, maxItems, collapsible, defaultCollapsed.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.props","typeLabel":"object"},"rules":{"type":"array","description":"Reserved — array-field rules are NOT evaluated in v1. Put rules on the child field nodes instead.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2.rules","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.3.columns.items.[INDEX].field","typeLabel":"string"},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.3.columns.items.[INDEX].order","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.3.columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.3.columns","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.form.children.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"body.views.form.children.items.[INDEX]","typeLabel":"any · object · object · object"},"isRequired":true,"uniqueKey":"body.views.form.children","typeLabel":"any · object · object · object[]"},"rules":{"type":"array","description":"Conditional rules for this container. Only the `visible` property is honoured on a grid.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true,"uniqueKey":"body.views.form.rules.items.[INDEX].id","typeLabel":"string"},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true,"uniqueKey":"body.views.form.rules.items.[INDEX].property","typeLabel":"enum\u003cstring>"},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.form.rules.items.[INDEX].logic.oneOf.0","typeLabel":"object"},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true,"uniqueKey":"body.views.form.rules.items.[INDEX].logic.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"body.views.form.rules.items.[INDEX].logic","typeLabel":"object | boolean"},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation.","uniqueKey":"body.views.form.rules.items.[INDEX].description","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"body.views.form.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.views.form.rules","typeLabel":"object[]"}},"additionalProperties":false,"deprecated":true,"uniqueKey":"body.views.form","typeLabel":"object"},"table":{"type":"object","description":"A table view that lists columns to display and their order.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true,"uniqueKey":"body.views.table.type","typeLabel":"enum\u003cstring>"},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true,"uniqueKey":"body.views.table.columns.items.[INDEX].field","typeLabel":"string"},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true,"uniqueKey":"body.views.table.columns.items.[INDEX].order","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"body.views.table.columns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"body.views.table.columns","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"body.views.table","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"body.views","typeLabel":"object"},"index_fields":{"type":"array","description":"Payload fields lifted into the search index: the only ones a query, filter or metric can use. Replaced wholesale on update; an added or changed field, or a journey edit under a derived field, starts a background reindex.","items":{"type":"object","required":["field"],"properties":{"field":{"type":"string","description":"Dotted path into the record's data; also accepted as `key`. Indexed as `data_\u003cpath with dots as underscores>`.","isRequired":true,"uniqueKey":"body.index_fields.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["keyword","text","text_sortable","number","numeric","date","datetime"],"description":"Empty means keyword.","uniqueKey":"body.index_fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"sortable":{"type":"boolean","description":"Usable as sort_by.","uniqueKey":"body.index_fields.items.[INDEX].sortable","typeLabel":"boolean"},"derive":{"type":"object","description":"Computes the field's value when the record is indexed instead of reading `data[field]`. The field must be a keyword, a single name, and not a schema property. A metric can filter on it and group by it; a run grouped by it is refused when it cannot be pushed down to the index.","required":["kind"],"properties":{"kind":{"type":"string","enum":["journey_round","member_progress"],"description":"`journey_round`: `turn` or `handed` for an open round of the journey the record runs (`views.forms[].journey`); absent once the round is ended, closed or at an unknown stage. `member_progress`: how far a member's form row has got, by the rule's other fields: `done`, `done_agreed`, `to_confirm`, `answered_sent`, `answered_unsent`, `sent` or `open`, on the member's one row only (see `anchor`).","isRequired":true,"uniqueKey":"body.index_fields.items.[INDEX].derive.kind","typeLabel":"enum\u003cstring>"},"done_field":{"type":"string","description":"`member_progress`: filled once the row is finished. Without it, the record's `completed` flag.","uniqueKey":"body.index_fields.items.[INDEX].derive.done_field","typeLabel":"string"},"answer_fields":{"type":"array","items":{"type":"string","uniqueKey":"body.index_fields.items.[INDEX].derive.answer_fields.items.[INDEX]","typeLabel":"string"},"description":"`member_progress`: the dotted fields that count as answers. Wins over `answer_prefix`.","uniqueKey":"body.index_fields.items.[INDEX].derive.answer_fields","typeLabel":"string[]"},"answer_prefix":{"type":"string","description":"`member_progress`: top-level keys starting with this are answers. Without either, every key but bookkeeping and `sent_field` is.","uniqueKey":"body.index_fields.items.[INDEX].derive.answer_prefix","typeLabel":"string"},"form":{"type":"string","description":"`member_progress`: a finished row with readiness gaps on this form (`state.readiness[form].missing`) is `to_confirm`.","uniqueKey":"body.index_fields.items.[INDEX].derive.form","typeLabel":"string"},"sent_field":{"type":"string","description":"`member_progress`: filled when the row was sent. Without it, no row reads as sent.","uniqueKey":"body.index_fields.items.[INDEX].derive.sent_field","typeLabel":"string"},"agreed_field":{"type":"string","description":"`member_progress`: a finished row whose field holds a number is `done_agreed`.","uniqueKey":"body.index_fields.items.[INDEX].derive.agreed_field","typeLabel":"string"},"reset_on_send":{"type":"array","items":{"type":"string","uniqueKey":"body.index_fields.items.[INDEX].derive.reset_on_send.items.[INDEX]","typeLabel":"string"},"description":"`member_progress`: fields a send clears to `false`. `false` in one of them is no answer; `false` elsewhere is.","uniqueKey":"body.index_fields.items.[INDEX].derive.reset_on_send","typeLabel":"string[]"},"anchor":{"type":"boolean","description":"`member_progress`: the members' own anchor config, whose row is each member's anchor record (filed under a parent folder, at a bare member folder). Without it, only the row at the member's fixed id gets a value.","uniqueKey":"body.index_fields.items.[INDEX].derive.anchor","typeLabel":"boolean"}},"uniqueKey":"body.index_fields.items.[INDEX].derive","typeLabel":"object"}},"uniqueKey":"body.index_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"body.index_fields","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","readOnly":true,"description":"ISO 8601 timestamp set automatically on creation.","uniqueKey":"body.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","readOnly":true,"description":"ISO 8601 timestamp updated automatically on every modification.","uniqueKey":"body.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"body","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status_code":123,"body":{"id":"\u003cstring>","name":"\u003cstring>","schema":{"type":"object","properties":{},"$schema":"\u003cstring>","required":["\u003cstring>"]},"description":"\u003cstring>","label":"\u003cstring>","views":{"forms":[{"id":"\u003cstring>","title":"\u003cstring>","layout":{"type":"grid","props":{"gridTemplateColumns":"\u003cstring>","gap":123},"children":["\u003cunknown>"],"rules":[{"id":"\u003cstring>","property":"visible","logic":{},"description":"\u003cstring>"}]},"description":"\u003cstring>"}],"form":{"type":"grid","props":{"gridTemplateColumns":"\u003cstring>","gap":123},"children":["\u003cunknown>"],"rules":[{"id":"\u003cstring>","property":"visible","logic":{},"description":"\u003cstring>"}]},"table":{"type":"table","columns":[{"field":"\u003cstring>","order":123}]}},"index_fields":[{"field":"\u003cstring>","type":"keyword","sortable":true,"derive":{"kind":"journey_round","done_field":"\u003cstring>","answer_fields":["\u003cstring>"],"answer_prefix":"\u003cstring>","form":"\u003cstring>","sent_field":"\u003cstring>","agreed_field":"\u003cstring>","reset_on_send":["\u003cstring>"],"anchor":true}}],"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c8ff410b-77fb-4348-aed5-1f8866a611cb":{"description":"Validation error (invalid ID format, invalid schema, missing required fields)","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","uniqueKey":"status_code","typeLabel":"integer"},"body":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"body.error","typeLabel":"string"}},"uniqueKey":"body","typeLabel":"object"}},"example":{"status_code":400,"body":{"error":"field 'rating' is required"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status_code":400,"body":{"error":"field 'rating' is required"}}}},"exampleType":"generated"}},"exampleType":"generated"},"cfa696cf-f7e1-4d84-ac91-6fb2e09fe8c6":{"description":"A record configuration with the given ID already exists, a deleted one with that ID is still being removed, or history kept from a deleted one with that ID has not been erased","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"integer","uniqueKey":"status_code","typeLabel":"integer"},"body":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message.","uniqueKey":"body.error","typeLabel":"string"}},"uniqueKey":"body","typeLabel":"object"}},"example":{"status_code":400,"body":{"error":"field 'rating' is required"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status_code":400,"body":{"error":"field 'rating' is required"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"244c586c-c8de-46b2-8ec6-6ed295e39edc":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}},"101873b0-49a5-47da-b437-3d1d872cdd6c":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"fb1f0116-168e-4ecc-a177-f7285ec2151a":{"url":"https://api.quiva.ai","description":"Production API server"}},"schemas":{"3cc1cc3a-7277-4699-b795-b5c62e48760b":{"type":"object","description":"Definition of a single field at any depth of the schema tree. Recurses via `properties` (objects) and `items` (arrays). Only `type` is required. Input config for a placed form field belongs on the view node (ViewFieldNode.inputType/props), NOT here; the legacy `ui` hint is a fallback only.","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","description":"JSON type(s) for this field. Use an array to allow multiple types (e.g. [\"string\", \"null\"]).","enum":["string","number","integer","boolean","object","array","null"],"isRequired":true},{"type":"array","items":{"type":"string","description":"Allowed JSON primitive/composite types for a schema field.","enum":["string","number","integer","boolean","object","array","null"]},"description":"JSON type(s) for this field. Use an array to allow multiple types (e.g. [\"string\", \"null\"]).","uniqueItems":true,"isRequired":true}],"isRequired":true},"label":{"type":"string","description":"Human-readable label shown in UI."},"title":{"type":"string","description":"JSON Schema title."},"description":{"type":"string"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"number"},"exclusiveMaximum":{"type":"number"},"minLength":{"type":"integer","minimum":0},"maxLength":{"type":"integer","minimum":0},"pattern":{"type":"string"},"format":{"type":"string"},"enum":{"type":"array","items":{"oneOf":[{}]}},"default":{"oneOf":[{}]},"properties":{"type":"object","additionalProperties":{"$circularRef":"3cc1cc3a-7277-4699-b795-b5c62e48760b"},"description":"Nested field definitions for object-typed fields."},"required":{"type":"array","items":{"type":"string"},"uniqueItems":true,"description":"Names of required nested fields. Only meaningful when `type` is \"object\"."},"items":{"$circularRef":"3cc1cc3a-7277-4699-b795-b5c62e48760b","description":"Item schema for array-typed fields."},"ui":{"type":"object","description":"LEGACY UI fallback (not standard JSON Schema). Prefer node-level inputType/props on the view field node; this is only read for descendants that are not their own view node and is stripped from placed fields on save.","properties":{"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"]},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this."},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty."},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format."}},"additionalProperties":false},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true},"note":{"type":"string","description":"Optional extra description shown alongside the option."}},"additionalProperties":false}},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering."},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs."},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs."},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs."},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs."},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs."},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`."},"includedCountries":{"type":"array","items":{"type":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`."},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`."}}}},"additionalProperties":false},"display":{"type":"object","description":"Display configuration embedded in a schema field.","properties":{"formatter":{"type":"object","description":"Formatter applied when displaying a field value.","required":["type"],"properties":{"type":{"type":"string","description":"Display formatter applied when rendering a field value.","enum":["text","number","currency","percent","date","datetime","time","boolean"],"isRequired":true},"props":{"type":"object","additionalProperties":true,"description":"Extra props forwarded to the formatter."}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"18502427-ad58-45a5-9347-1f037d0a8014":{"oneOf":[{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","props","children"],"properties":{"type":{"type":"string","enum":["grid"],"isRequired":true},"props":{"type":"object","description":"CSS Grid container properties.","required":["gridTemplateColumns"],"properties":{"gridTemplateColumns":{"type":"string","description":"CSS grid-template-columns value (e.g. \"1fr 1fr\", \"repeat(3, 1fr)\").","isRequired":true},"gap":{"type":"number","description":"Gap between grid cells in pixels."}},"additionalProperties":false,"isRequired":true},"children":{"type":"array","items":{"$circularRef":"18502427-ad58-45a5-9347-1f037d0a8014"},"isRequired":true},"rules":{"type":"array","description":"Conditional rules for this container. Only the `visible` property is honoured on a grid.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true}],"isRequired":true},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation."}},"additionalProperties":true}}},"additionalProperties":false},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field"],"example":{"type":"field","field":"policyNumber","inputType":"text","props":{"label":"Policy number"}},"properties":{"type":{"type":"string","enum":["field"],"isRequired":true},"field":{"type":"string","description":"Dotted path to the schema field (e.g. \"name\", \"address.city\"). The property key is `field` (a `ref` key is ignored by the engine).","isRequired":true},"inputType":{"type":"string","description":"Input widget type for form rendering.","enum":["array","checkbox","country","currency","date","date-range","dropdown","key-value","multi-country","multi-select","multi-toggle","number","phone","slider","tags","text","textarea","toggle"]},"props":{"type":"object","additionalProperties":true,"description":"Display / configuration props forwarded to the input widget. `label` should always be set. Which props apply depends on the input type (e.g. `options`/`sort` for dropdown, `min`/`max`/`decimalPlace` for number/currency, `minDate`/`maxDate` for date, `includedCountries`/`showNativeName` for country, `maxItems` for multi-select).","properties":{"label":{"type":"string","description":"Display label shown above/beside the input. Always set this."},"placeholder":{"type":"string","description":"Placeholder text shown inside the input when empty."},"helpText":{"type":"object","description":"Optional help text rendered below the input.","properties":{"markdown":{"type":"string","description":"Help text content in Markdown format."}},"additionalProperties":false},"options":{"type":"array","description":"Choices for dropdown / multi-select / multi-toggle. Seed from the schema field's enum.","items":{"type":"object","required":["text","value"],"properties":{"text":{"type":"string","description":"Human-readable label for the option.","isRequired":true},"value":{"type":"string","description":"Machine value submitted when this option is selected.","isRequired":true},"note":{"type":"string","description":"Optional extra description shown alongside the option."}},"additionalProperties":false}},"sort":{"type":"boolean","description":"When `true`, options are sorted alphabetically before rendering."},"minDate":{"type":"string","format":"date-time","description":"Earliest selectable date (ISO 8601). Applies to `date` / `date-range` inputs."},"maxDate":{"type":"string","format":"date-time","description":"Latest selectable date (ISO 8601). Applies to `date` / `date-range` inputs."},"min":{"type":"number","description":"Minimum allowed numeric value. Applies to `number` / `currency` / `slider` inputs."},"max":{"type":"number","description":"Maximum allowed numeric value. Applies to `number` / `currency` / `slider` inputs."},"decimalPlace":{"type":"integer","description":"Number of decimal places displayed. Applies to `number` / `currency` inputs."},"maxItems":{"type":"integer","description":"Maximum number of selections. Applies to `multi-select`."},"includedCountries":{"type":"array","items":{"type":"string"},"description":"Restrict the country list to these ISO codes (e.g. [\"uk\",\"ua\"]). Applies to `country` / `multi-country`."},"showNativeName":{"type":"boolean","description":"Show each country's native name. Applies to `country` / `multi-country`."}}},"rules":{"type":"array","description":"Conditional rules for this field. Field nodes support all five rule properties.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true}],"isRequired":true},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation."}},"additionalProperties":true}}},"additionalProperties":false},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","field","children"],"example":{"type":"array-field","field":"products","props":{"label":"Products","itemLabel":"Product","required":true,"minItems":1},"children":[{"type":"field","field":"title","inputType":"text","props":{"label":"Title"}},{"type":"field","field":"price","inputType":"currency","props":{"label":"Price","min":0,"decimalPlace":2}}]},"properties":{"type":{"type":"string","enum":["array-field"],"isRequired":true},"field":{"type":"string","description":"Dotted path to an array-of-object schema field.","isRequired":true},"children":{"type":"array","description":"View nodes for one item, with element-relative `field` refs. Child field nodes carry their own node-level inputType/props/rules.","items":{"$circularRef":"18502427-ad58-45a5-9347-1f037d0a8014"},"isRequired":true},"props":{"type":"object","description":"UI-only container config: label, required (at least one item), minItems, maxItems, collapsible, defaultCollapsed."},"rules":{"type":"array","description":"Reserved — array-field rules are NOT evaluated in v1. Put rules on the child field nodes instead.","items":{"type":"object","description":"A conditional rule attached to a view node. `logic` is a json-logic-engine expression evaluated against the live form value ({ \"var\": \"FieldPath\" } reads another field; dotted paths allowed); at the form root it reads the whole record, inside an array-field item it reads that item. `logic` may also be a bare boolean for an unconditional state. The result sets `property` (booleans are coerced; `value` keeps the raw computed value).","required":["id","property","logic"],"properties":{"id":{"type":"string","description":"Convention \"\u003cFieldPath>.\u003cproperty>\", e.g. \"email.required\".","isRequired":true},"property":{"type":"string","description":"The element property a rule drives. Field nodes support all five; grid (container) nodes support `visible` only.","enum":["visible","required","disabled","readonly","value"],"isRequired":true},"logic":{"oneOf":[{"type":"object","description":"A json-logic-engine expression object, or a boolean.","isRequired":true},{"type":"boolean","description":"A json-logic-engine expression object, or a boolean.","isRequired":true}],"isRequired":true},"description":{"type":"string","description":"One plain-English sentence describing the condition and outcome. Does not affect evaluation."}},"additionalProperties":true}}},"additionalProperties":false},{"type":"object","description":"A node in the view tree — a grid container, a field leaf, an array-field repeater, or a table.","required":["type","columns"],"properties":{"type":{"type":"string","enum":["table"],"isRequired":true},"columns":{"type":"array","items":{"type":"object","description":"A column descriptor in a table view.","required":["field","order"],"properties":{"field":{"type":"string","description":"Schema field key this column displays.","isRequired":true},"order":{"type":"integer","description":"Display order of this column (ascending).","isRequired":true}},"additionalProperties":false},"isRequired":true}},"additionalProperties":false}]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/endpoint/records/openapi.json"},"subdomain":"microstrate","siteName":"QuivaWorks Docs","title":"Create a record configuration - QuivaWorks Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T13:49:21.996Z","originalFileLocation":"api-reference/record-configs/create-a-record-configuration.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The id you choose becomes the config_id used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with DELETE /records/config/{config_id}/history first.\">\u003cmeta data-mint-head name=\"application-name\" content=\"QuivaWorks Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a record configuration - QuivaWorks Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The id you choose becomes the config_id used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with DELETE /records/config/{config_id}/history first.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"QuivaWorks Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://microstrate.mintlify.site/_mintlify/api/og/v2?division=Record+Configs\u0026amp;title=Create+a+record+configuration\u0026amp;description=Defines+a+new+category+of+records+by+specifying+a+schema+%28field+names%2C+types%2C+validation+constraints%29+and+UI+rendering+hints.+The+%60id%60+you+choose+becomes+the+%60c\u0026amp;theme=749a3bdf44d0afc15e32a17f\u0026amp;signature=2bd35572742863b2d0136934e76ef46dc2a988447df5a62c75bfa8249f755979\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a record configuration - QuivaWorks Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The id you choose becomes the config_id used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with DELETE /records/config/{config_id}/history first.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://microstrate.mintlify.site/_mintlify/api/og/v2?division=Record+Configs\u0026amp;title=Create+a+record+configuration\u0026amp;description=Defines+a+new+category+of+records+by+specifying+a+schema+%28field+names%2C+types%2C+validation+constraints%29+and+UI+rendering+hints.+The+%60id%60+you+choose+becomes+the+%60c\u0026amp;theme=749a3bdf44d0afc15e32a17f\u0026amp;signature=2bd35572742863b2d0136934e76ef46dc2a988447df5a62c75bfa8249f755979\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/microstrate/rkD4iFTLdo_icBn3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"QuivaWorks Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4641F2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/record-configs/create-a-record-configuration.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.quiva.ai/#organization\",\"name\":\"QuivaWorks Docs\",\"url\":\"https://docs.quiva.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/microstrate/Eit-IsSh6_6H8X4Q/logo/light.svg?fit=max\u0026auto=format\u0026n=Eit-IsSh6_6H8X4Q\u0026q=85\u0026s=01f10191a8ee36765af69b1436deb5e0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.quiva.ai#website\",\"name\":\"QuivaWorks Docs\",\"url\":\"https://docs.quiva.ai\",\"publisher\":{\"@id\":\"https://docs.quiva.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration#webpage\",\"url\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration\",\"name\":\"Create a record configuration\",\"description\":\"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The id you choose becomes the config_id used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with DELETE /records/config/{config_id}/history first.\",\"dateModified\":\"2026-11-21T13:49:21.996Z\",\"isPartOf\":{\"@id\":\"https://docs.quiva.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Records\",\"item\":\"https://docs.quiva.ai/api-reference/record-configs/list-record-configurations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Record Configs\",\"item\":\"https://docs.quiva.ai/api-reference/record-configs/list-record-configurations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a record configuration\",\"item\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration#apireference\",\"headline\":\"Create a record configuration\",\"name\":\"Create a record configuration\",\"description\":\"Defines a new category of records by specifying a schema (field names, types, validation constraints) and UI rendering hints. The id you choose becomes the config_id used in all subsequent record operations for this type. Returns 409 if a configuration with the same ID already exists. Also 409 while a deleted set with the same ID is still having its records tombstoned, and while history kept from a deleted set with the same ID exists: erase it with DELETE /records/config/{config_id}/history first.\",\"url\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration\",\"mainEntityOfPage\":{\"@id\":\"https://docs.quiva.ai/api-reference/record-configs/create-a-record-configuration#webpage\"},\"dateModified\":\"2026-11-21T13:49:21.996Z\",\"publisher\":{\"@id\":\"https://docs.quiva.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.quiva.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"QuivaWorks Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"QuivaWorks Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/record-configs/create-a-record-configuration.md","siteName":"QuivaWorks Docs","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://quiva.ai/community"},{"anchor":"Support","icon":"headset","href":"https://quiva.ai/help-center/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/get-started/overview"}]},{"tab":"Abbie","pages":[{"title":"Abbie","href":"/abbie/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Accounts","pages":[{"group":"Authentication","pages":[{"title":"Initiate OAuth login flow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/oauth/login","href":"/api-reference/authentication/initiate-oauth-login-flow"},{"title":"OAuth callback handler","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/oauth/callback","href":"/api-reference/authentication/oauth-callback-handler"},{"title":"Authenticate with password","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-password","href":"/api-reference/authentication/authenticate-with-password"},{"title":"Authenticate with recovery code","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-recovery-code","href":"/api-reference/authentication/authenticate-with-recovery-code"},{"title":"Request password reset","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/request-reset-password","href":"/api-reference/authentication/request-password-reset"},{"title":"Reset password","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/reset-password","href":"/api-reference/authentication/reset-password"},{"title":"Set password","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/set-password","href":"/api-reference/authentication/set-password"},{"title":"Authenticate with TOTP","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-totp","href":"/api-reference/authentication/authenticate-with-totp"},{"title":"Get email verification code","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/email-code","href":"/api-reference/authentication/get-email-verification-code"},{"title":"Begin passkey authentication","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/begin-auth-with-passkey","href":"/api-reference/authentication/begin-passkey-authentication"},{"title":"Validate token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/token-validate","href":"/api-reference/authentication/validate-token"},{"title":"Authenticate with API key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-api-key","href":"/api-reference/authentication/authenticate-with-api-key"},{"title":"Get session tokens","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/session-tokens","href":"/api-reference/authentication/get-session-tokens"},{"title":"Revoke auth token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/auth-token","href":"/api-reference/authentication/revoke-auth-token"},{"title":"Refresh authentication token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/refresh-token","href":"/api-reference/authentication/refresh-authentication-token"},{"title":"Revoke refresh token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/refresh-token","href":"/api-reference/authentication/revoke-refresh-token"},{"title":"Revoke all tokens","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/tokens","href":"/api-reference/authentication/revoke-all-tokens"},{"title":"Complete passkey authentication","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/complete-auth-with-passkey","href":"/api-reference/authentication/complete-passkey-authentication"},{"title":"Mint an integration token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /oauth/token","href":"/api-reference/authentication/mint-an-integration-token"},{"title":"Finish sign-in on the chosen account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-select-account","href":"/api-reference/authentication/finish-sign-in-on-the-chosen-account"},{"title":"Email a client a sign-in link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/send-client-sign-in","href":"/api-reference/authentication/email-a-client-a-sign-in-link"}]},{"group":"Account Management","pages":[{"title":"Get account information","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/info","href":"/api-reference/account-management/get-account-information"},{"title":"Set emergency credit","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/set-emergency-credit","href":"/api-reference/account-management/set-emergency-credit"},{"title":"Rename account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/rename","href":"/api-reference/account-management/rename-account"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts","href":"/api-reference/account-management/create-account"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts","href":"/api-reference/account-management/update-account"},{"title":"Delete account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/account","href":"/api-reference/account-management/delete-account"},{"title":"Cancel account deletion","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/cancel-account-deletion","href":"/api-reference/account-management/cancel-account-deletion"},{"title":"Add import","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/import","href":"/api-reference/account-management/add-import"},{"title":"Remove import","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/import","href":"/api-reference/account-management/remove-import"},{"title":"Add export","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/export","href":"/api-reference/account-management/add-export"},{"title":"Remove export","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/export","href":"/api-reference/account-management/remove-export"},{"title":"List accounts by user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/list","href":"/api-reference/account-management/list-accounts-by-user"},{"title":"Confirm email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/confirm-email","href":"/api-reference/account-management/confirm-email"},{"title":"Resend email confirmation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/resend-confirmation","href":"/api-reference/account-management/resend-email-confirmation"},{"title":"Submit contact form","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/submit-contact-form","href":"/api-reference/account-management/submit-contact-form"},{"title":"Change the sign-in address (slug)","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/slug","href":"/api-reference/account-management/change-the-sign-in-address-slug"},{"title":"List vertical template updates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/vertical-updates","href":"/api-reference/account-management/list-vertical-template-updates"},{"title":"Mint an export activation token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/export-activation","href":"/api-reference/account-management/mint-an-export-activation-token"}]},{"group":"API Keys","pages":[{"title":"Issue API key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/api-key","href":"/api-reference/api-keys/issue-api-key"},{"title":"Delete API key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/api-key","href":"/api-reference/api-keys/delete-api-key"},{"title":"View API keys","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/api-keys","href":"/api-reference/api-keys/view-api-keys"},{"title":"Get API credentials","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/api-creds","href":"/api-reference/api-keys/get-api-credentials"}]},{"group":"User Management","pages":[{"title":"Upload profile image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/profile-image","href":"/api-reference/user-management/upload-profile-image"},{"title":"Delete profile image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/profile-image","href":"/api-reference/user-management/delete-profile-image"},{"title":"Remove user from account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/remove-user","href":"/api-reference/user-management/remove-user-from-account"},{"title":"Create/Add user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/users","href":"/api-reference/user-management/createadd-user"},{"title":"Delete user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/user","href":"/api-reference/user-management/delete-user"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/user","href":"/api-reference/user-management/update-user"},{"title":"Request email address change","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/request-email-address-change","href":"/api-reference/user-management/request-email-address-change"},{"title":"Complete email address change","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/change-email-address-action","href":"/api-reference/user-management/complete-email-address-change"},{"title":"List users by account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/users/list","href":"/api-reference/user-management/list-users-by-account"},{"title":"Update user role","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/role","href":"/api-reference/user-management/update-user-role"},{"title":"Suspend user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/suspend-user","href":"/api-reference/user-management/suspend-user"},{"title":"Get user login data","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/user-login-data","href":"/api-reference/user-management/get-user-login-data"}]},{"group":"Multi-Factor Authentication","pages":[{"title":"View recovery codes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/recovery-codes","href":"/api-reference/multi-factor-authentication/view-recovery-codes"},{"title":"Issue recovery codes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/recovery-codes","href":"/api-reference/multi-factor-authentication/issue-recovery-codes"},{"title":"Generate TOTP key","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/generate-totp-key","href":"/api-reference/multi-factor-authentication/generate-totp-key"},{"title":"Confirm TOTP registration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/confirm-totp-registration","href":"/api-reference/multi-factor-authentication/confirm-totp-registration"},{"title":"Remove TOTP","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/totp","href":"/api-reference/multi-factor-authentication/remove-totp"},{"title":"Begin passkey registration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/begin-passkey-registration","href":"/api-reference/multi-factor-authentication/begin-passkey-registration"},{"title":"Complete passkey registration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/complete-passkey-registration","href":"/api-reference/multi-factor-authentication/complete-passkey-registration"},{"title":"Remove passkey","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/passkey","href":"/api-reference/multi-factor-authentication/remove-passkey"},{"title":"Get user MFA info","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/user-mfa-info","href":"/api-reference/multi-factor-authentication/get-user-mfa-info"},{"title":"Update MFA settings","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/mfa-settings","href":"/api-reference/multi-factor-authentication/update-mfa-settings"},{"title":"Remove all passkeys","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/all-passkeys","href":"/api-reference/multi-factor-authentication/remove-all-passkeys"}]},{"group":"Mesh Nodes","pages":[{"title":"Update mesh nodes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json put /accounts/mesh-nodes","href":"/api-reference/mesh-nodes/update-mesh-nodes"}]},{"group":"Payment","pages":[{"title":"Process payment webhook","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/webhook","href":"/api-reference/payment/process-payment-webhook"},{"title":"Get products","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/products","href":"/api-reference/payment/get-products"},{"title":"Get prices","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/prices","href":"/api-reference/payment/get-prices"},{"title":"Get checkout URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/checkout-url","href":"/api-reference/payment/get-checkout-url"},{"title":"Get dashboard URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/dashboard-url","href":"/api-reference/payment/get-dashboard-url"},{"title":"Get subscription items","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/subscription-items","href":"/api-reference/payment/get-subscription-items"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/subscription","href":"/api-reference/payment/get-subscription"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/payment/subscription","href":"/api-reference/payment/cancel-subscription"},{"title":"Update subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/payment/subscription","href":"/api-reference/payment/update-subscription"},{"title":"Create free subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/free-subscription","href":"/api-reference/payment/create-free-subscription"},{"title":"List credit packs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/credit-packs","href":"/api-reference/payment/list-credit-packs"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/payment/payment-methods","href":"/api-reference/payment/list-payment-methods"},{"title":"Buy a credit pack","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/payment/ai-budget","href":"/api-reference/payment/buy-a-credit-pack"},{"title":"Cancel a scheduled downgrade","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/payment/subscription-schedule","href":"/api-reference/payment/cancel-a-scheduled-downgrade"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"Create an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Read an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations/{id}","href":"/api-reference/integrations/read-an-integration"},{"title":"Delete an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/integrations/{id}","href":"/api-reference/integrations/delete-an-integration"},{"title":"Update or disable an integration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/integrations/{id}","href":"/api-reference/integrations/update-or-disable-an-integration"},{"title":"Rotate the client secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations/{id}/secrets","href":"/api-reference/integrations/rotate-the-client-secret"},{"title":"Revoke a client secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/integrations/{id}/secrets/{secret_id}","href":"/api-reference/integrations/revoke-a-client-secret"}]},{"group":"Task Subscriptions","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations/{id}/subscriptions","href":"/api-reference/task-subscriptions/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations/{id}/subscriptions","href":"/api-reference/task-subscriptions/create-a-webhook-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/integrations/{id}/subscriptions/{sid}","href":"/api-reference/task-subscriptions/delete-a-subscription"},{"title":"Update, resume or rotate a subscription","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/integrations/{id}/subscriptions/{sid}","href":"/api-reference/task-subscriptions/update-resume-or-rotate-a-subscription"},{"title":"Replay events or send a test event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/integrations/{id}/subscriptions/{sid}/replay","href":"/api-reference/task-subscriptions/replay-events-or-send-a-test-event"},{"title":"Read the delivery log","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/integrations/{id}/subscriptions/{sid}/deliveries","href":"/api-reference/task-subscriptions/read-the-delivery-log"}]},{"group":"Branding","pages":[{"title":"Get sign-in branding","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/client-branding","href":"/api-reference/branding/get-sign-in-branding"},{"title":"Upload the dark-mode favicon","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/favicon-dark","href":"/api-reference/branding/upload-the-dark-mode-favicon"},{"title":"Remove the dark-mode favicon","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/favicon-dark","href":"/api-reference/branding/remove-the-dark-mode-favicon"},{"title":"Publish a record image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/record-image","href":"/api-reference/branding/publish-a-record-image"},{"title":"Delete a record image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/record-image","href":"/api-reference/branding/delete-a-record-image"},{"title":"Get an icon font access token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /fontawesome/token","href":"/api-reference/branding/get-an-icon-font-access-token"}]},{"group":"Email Templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/email-templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Get an email template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/email-template","href":"/api-reference/email-templates/get-an-email-template"},{"title":"Create a template or replace its draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template","href":"/api-reference/email-templates/create-a-template-or-replace-its-draft"},{"title":"Delete an email template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/email-template","href":"/api-reference/email-templates/delete-an-email-template"},{"title":"Publish the draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-publish","href":"/api-reference/email-templates/publish-the-draft"},{"title":"Discard the draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-discard","href":"/api-reference/email-templates/discard-the-draft"},{"title":"Render a template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-render","href":"/api-reference/email-templates/render-a-template"},{"title":"Attach a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-attachment","href":"/api-reference/email-templates/attach-a-file"},{"title":"Remove an attachment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/email-template-attachment-remove","href":"/api-reference/email-templates/remove-an-attachment"}]},{"group":"Client Access","pages":[{"title":"Request a client sign-in link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/request-client-magic-link","href":"/api-reference/client-access/request-a-client-sign-in-link"},{"title":"Sign in with a magic link or code","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/auth-with-magic-link","href":"/api-reference/client-access/sign-in-with-a-magic-link-or-code"},{"title":"Send a client invitation email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/send-client-invite","href":"/api-reference/client-access/send-a-client-invitation-email"},{"title":"Clear a client sign-in lock","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/clear-client-signin-lock","href":"/api-reference/client-access/clear-a-client-sign-in-lock"}]},{"group":"Document Branding","pages":[{"title":"Get the document theme","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/document-theme","href":"/api-reference/document-branding/get-the-document-theme"},{"title":"Set the document logo","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/document-logo","href":"/api-reference/document-branding/set-the-document-logo"},{"title":"Remove the document logo","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/document-logo","href":"/api-reference/document-branding/remove-the-document-logo"}]},{"group":"Resource Access","pages":[{"title":"Assign resources to a user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/assign-resources","href":"/api-reference/resource-access/assign-resources-to-a-user"},{"title":"Remove resource assignments from a user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/unassign-resources","href":"/api-reference/resource-access/remove-resource-assignments-from-a-user"},{"title":"List resources assigned to a user","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/assigned-resources","href":"/api-reference/resource-access/list-resources-assigned-to-a-user"}]},{"group":"Sync Packages","pages":[{"title":"List sync packages","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/sync-packages","href":"/api-reference/sync-packages/list-sync-packages"},{"title":"List sync package installs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/sync-packages/installs","href":"/api-reference/sync-packages/list-sync-package-installs"},{"title":"Install a sync package","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sync-packages/install","href":"/api-reference/sync-packages/install-a-sync-package"},{"title":"Upgrade a sync package install","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sync-packages/upgrade","href":"/api-reference/sync-packages/upgrade-a-sync-package-install"},{"title":"Uninstall a sync package","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sync-packages/uninstall","href":"/api-reference/sync-packages/uninstall-a-sync-package"}]},{"group":"Terms","pages":[{"title":"List terms documents","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/documents","href":"/api-reference/terms/list-terms-documents"},{"title":"Update a terms document draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json put /accounts/terms/document","href":"/api-reference/terms/update-a-terms-document-draft"},{"title":"Create a terms document draft","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/document","href":"/api-reference/terms/create-a-terms-document-draft"},{"title":"Archive a terms document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json delete /accounts/terms/document","href":"/api-reference/terms/archive-a-terms-document"},{"title":"Publish a terms document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/document/publish","href":"/api-reference/terms/publish-a-terms-document"},{"title":"List terms document versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/document/versions","href":"/api-reference/terms/list-terms-document-versions"},{"title":"Get a terms version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/version","href":"/api-reference/terms/get-a-terms-version"},{"title":"Enable or disable a provider","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json put /accounts/terms/provider","href":"/api-reference/terms/enable-or-disable-a-provider"},{"title":"Get provider terms status","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/provider-status","href":"/api-reference/terms/get-provider-terms-status"},{"title":"List terms the caller must accept","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/pending","href":"/api-reference/terms/list-terms-the-caller-must-accept"},{"title":"Accept terms","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/accept","href":"/api-reference/terms/accept-terms"},{"title":"Preview terms for a sign-in link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/terms/pending-for-signin","href":"/api-reference/terms/preview-terms-for-a-sign-in-link"},{"title":"Export the acceptance log","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/terms/acceptances","href":"/api-reference/terms/export-the-acceptance-log"}]},{"group":"Email Sending","pages":[{"title":"Get the sending identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/sender-identity","href":"/api-reference/email-sending/get-the-sending-identity"},{"title":"Set the sending identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sender-identity","href":"/api-reference/email-sending/set-the-sending-identity"},{"title":"Verify the sending identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/sender-identity-verify","href":"/api-reference/email-sending/verify-the-sending-identity"},{"title":"Send an email from the account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/send-commercial-email","href":"/api-reference/email-sending/send-an-email-from-the-account"}]},{"group":"Usage and Billing","pages":[{"title":"List cost events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/cost-events","href":"/api-reference/usage-and-billing/list-cost-events"},{"title":"List billing events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/billing-events","href":"/api-reference/usage-and-billing/list-billing-events"},{"title":"Email a cost events export","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/admin/export-cost-events","href":"/api-reference/usage-and-billing/email-a-cost-events-export"},{"title":"Get budget limits and spend guard","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/ai-budget-limits","href":"/api-reference/usage-and-billing/get-budget-limits-and-spend-guard"},{"title":"Set the spend guard","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/ai-budget-limits","href":"/api-reference/usage-and-billing/set-the-spend-guard"},{"title":"Override the spend guard","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json post /accounts/ai-budget-limits/override","href":"/api-reference/usage-and-billing/override-the-spend-guard"},{"title":"Get the credit balance","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/ai-budget","href":"/api-reference/usage-and-billing/get-the-credit-balance"},{"title":"Get a usage summary","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/usage-summary","href":"/api-reference/usage-and-billing/get-a-usage-summary"},{"title":"Set auto top-up","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/auto-topup","href":"/api-reference/usage-and-billing/set-auto-top-up"},{"title":"Set the credit warning level","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/credit-warning","href":"/api-reference/usage-and-billing/set-the-credit-warning-level"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json get /accounts/users/notifications","href":"/api-reference/notifications/list-notifications"},{"title":"Mark a notification viewed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/users/notifications/viewed","href":"/api-reference/notifications/mark-a-notification-viewed"},{"title":"Mark notifications viewed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/accounts/openapi.json patch /accounts/users/notifications/viewed-all","href":"/api-reference/notifications/mark-notifications-viewed"}]}]},{"group":"Task sync","pages":[{"title":"Task sync authentication","icon":"key","href":"/api-reference/task-sync-auth"},{"title":"Task sync errors and limits","icon":"triangle-exclamation","href":"/api-reference/task-sync-errors"}]},{"group":"Workspaces","pages":[{"group":"Spaces","pages":[{"title":"List all spaces","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/spaces","href":"/api-reference/spaces/list-all-spaces"},{"title":"Create a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space","href":"/api-reference/spaces/create-a-space"},{"title":"Get a space by ID","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{id}","href":"/api-reference/spaces/get-a-space-by-id"},{"title":"Delete a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/space/{id}","href":"/api-reference/spaces/delete-a-space"},{"title":"Update a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/space/{id}","href":"/api-reference/spaces/update-a-space"},{"title":"List tasks in a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{space_id}/tasks","href":"/api-reference/spaces/list-tasks-in-a-space"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task","href":"/api-reference/spaces/create-a-task"},{"title":"Update multiple tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/tasks","href":"/api-reference/spaces/update-multiple-tasks"},{"title":"Get a task by ID","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{id}","href":"/api-reference/spaces/get-a-task-by-id"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{id}","href":"/api-reference/spaces/delete-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/task/{id}","href":"/api-reference/spaces/update-a-task"},{"title":"Create a comment on a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/comment","href":"/api-reference/spaces/create-a-comment-on-a-task"},{"title":"List comments on a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/comments","href":"/api-reference/spaces/list-comments-on-a-task"},{"title":"Add or remove a reaction on a comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/comment/{id}/reaction","href":"/api-reference/spaces/add-or-remove-a-reaction-on-a-comment"},{"title":"Get a comment by ID","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/comment/{id}","href":"/api-reference/spaces/get-a-comment-by-id"},{"title":"Delete a comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/comment/{id}","href":"/api-reference/spaces/delete-a-comment"},{"title":"Update a comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/task/{task_id}/comment/{id}","href":"/api-reference/spaces/update-a-comment"},{"title":"List a task's time logs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/time-log","href":"/api-reference/spaces/list-a-tasks-time-logs"},{"title":"Log time against a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task/{task_id}/time-log","href":"/api-reference/spaces/log-time-against-a-task"},{"title":"List task templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task-templates","href":"/api-reference/spaces/list-task-templates"},{"title":"Create a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task-template","href":"/api-reference/spaces/create-a-task-template"},{"title":"Get a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task-template/{id}","href":"/api-reference/spaces/get-a-task-template"},{"title":"Delete a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task-template/{id}","href":"/api-reference/spaces/delete-a-task-template"},{"title":"Update a task template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/task-template/{id}","href":"/api-reference/spaces/update-a-task-template"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/client","href":"/api-reference/spaces/create-a-contact"},{"title":"List meeting files in a Space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/meetings","href":"/api-reference/spaces/list-meeting-files-in-a-space"}]},{"group":"Tasks","pages":[{"title":"Delete every task in a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/tasks","href":"/api-reference/tasks/delete-every-task-in-a-folder"},{"title":"Create or update a task by external id","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/space/{space_id}/tasks/external/{external_id}","href":"/api-reference/tasks/create-or-update-a-task-by-external-id"},{"title":"Create a task from a template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task-from-template","href":"/api-reference/tasks/create-a-task-from-a-template"},{"title":"Watch a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/watch","href":"/api-reference/tasks/watch-a-task"},{"title":"Stop watching a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/watch","href":"/api-reference/tasks/stop-watching-a-task"},{"title":"Mute a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/mute","href":"/api-reference/tasks/mute-a-task"},{"title":"Unmute a task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/mute","href":"/api-reference/tasks/unmute-a-task"},{"title":"List my tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/tasks/my-tasks","href":"/api-reference/tasks/list-my-tasks"},{"title":"List a client's tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/client/tasks","href":"/api-reference/tasks/list-a-clients-tasks"},{"title":"Get a task's change log","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/change-log","href":"/api-reference/tasks/get-a-tasks-change-log"},{"title":"Export a space's tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{space_id}/export-tasks","href":"/api-reference/tasks/export-a-spaces-tasks"}]},{"group":"Task Actions","pages":[{"title":"List task checklist actions — currently unavailable","deprecated":true,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/action","href":"/api-reference/task-actions/list-task-checklist-actions-—-currently-unavailable"},{"title":"Create or update a task checklist action","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task/{task_id}/action","href":"/api-reference/task-actions/create-or-update-a-task-checklist-action"},{"title":"Delete a task checklist action","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/action/{id}","href":"/api-reference/task-actions/delete-a-task-checklist-action"}]},{"group":"Changes","pages":[{"title":"Read the changes feed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space/{space_id}/changes","href":"/api-reference/changes/read-the-changes-feed"}]},{"group":"Sandbox","pages":[{"title":"Copy a space's structure","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space/{space_id}/copy-structure","href":"/api-reference/sandbox/copy-a-spaces-structure"},{"title":"Reset a staging space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space/{space_id}/reset","href":"/api-reference/sandbox/reset-a-staging-space"}]},{"group":"Entity Comments","pages":[{"title":"List entity comments","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/entity/{entity_type}/{entity_id}/comments","href":"/api-reference/entity-comments/list-entity-comments"},{"title":"Create an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/entity/{entity_type}/{entity_id}/comment","href":"/api-reference/entity-comments/create-an-entity-comment"},{"title":"Get an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/entity/{entity_type}/{entity_id}/comment/{id}","href":"/api-reference/entity-comments/get-an-entity-comment"},{"title":"Delete an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/entity/{entity_type}/{entity_id}/comment/{id}","href":"/api-reference/entity-comments/delete-an-entity-comment"},{"title":"Update an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/entity/{entity_type}/{entity_id}/comment/{id}","href":"/api-reference/entity-comments/update-an-entity-comment"},{"title":"Add or remove a reaction on an entity comment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/entity/{entity_type}/{entity_id}/comment/{id}/reaction","href":"/api-reference/entity-comments/add-or-remove-a-reaction-on-an-entity-comment"},{"title":"Download an entity comment attachment","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/entity/{entity_type}/{entity_id}/comment/{id}/attachment","href":"/api-reference/entity-comments/download-an-entity-comment-attachment"}]},{"group":"Task Relations","pages":[{"title":"List related tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/relations","href":"/api-reference/task-relations/list-related-tasks"},{"title":"Link two tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task-relation","href":"/api-reference/task-relations/link-two-tasks"},{"title":"Unlink two tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/relation/{related_task_id}","href":"/api-reference/task-relations/unlink-two-tasks"}]},{"group":"Space Collections","pages":[{"title":"List space collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/space-collections","href":"/api-reference/space-collections/list-space-collections"},{"title":"Create a space collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/space-collection","href":"/api-reference/space-collections/create-a-space-collection"},{"title":"Delete a space collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/space-collection/{id}","href":"/api-reference/space-collections/delete-a-space-collection"},{"title":"Update a space collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/space-collection/{id}","href":"/api-reference/space-collections/update-a-space-collection"},{"title":"Reorder space collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/space-collections-order","href":"/api-reference/space-collections/reorder-space-collections"}]},{"group":"Folders","pages":[{"title":"Rename a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/folder-name","href":"/api-reference/folders/rename-a-folder"},{"title":"Resolve a folder display path","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/resolve-folder","href":"/api-reference/folders/resolve-a-folder-display-path"},{"title":"File a case under its client folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/case-folder","href":"/api-reference/folders/file-a-case-under-its-client-folder"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/files/folder","href":"/api-reference/folders/create-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/files/folder","href":"/api-reference/folders/delete-a-folder"}]},{"group":"Task Schedules","pages":[{"title":"List a task's scheduled events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/{task_id}/scheduled-events","href":"/api-reference/task-schedules/list-a-tasks-scheduled-events"},{"title":"Schedule a task event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/scheduled-events","href":"/api-reference/task-schedules/schedule-a-task-event"},{"title":"List scheduled events in a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/task/scheduled-events","href":"/api-reference/task-schedules/list-scheduled-events-in-a-space"},{"title":"Update a scheduled task event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json put /workspaces/task/{task_id}/scheduled-events/{id}","href":"/api-reference/task-schedules/update-a-scheduled-task-event"},{"title":"Cancel a scheduled task event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/task/{task_id}/scheduled-events/{id}","href":"/api-reference/task-schedules/cancel-a-scheduled-task-event"},{"title":"Mark a task event notification read","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/task/{task_id}/scheduled-events/{id}/read","href":"/api-reference/task-schedules/mark-a-task-event-notification-read"}]},{"group":"Files","pages":[{"title":"List a space's files","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files","href":"/api-reference/files/list-a-spaces-files"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/files","href":"/api-reference/files/delete-a-file"},{"title":"List trashed files","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files/trash","href":"/api-reference/files/list-trashed-files"},{"title":"Restore from trash","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/files/restore","href":"/api-reference/files/restore-from-trash"},{"title":"Update a file's metadata","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json patch /workspaces/file/{name}/metadata","href":"/api-reference/files/update-a-files-metadata"},{"title":"List a file's versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files/versions","href":"/api-reference/files/list-a-files-versions"},{"title":"Get one file version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json get /workspaces/files/version","href":"/api-reference/files/get-one-file-version"},{"title":"Restore a file version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/files/version/restore","href":"/api-reference/files/restore-a-file-version"},{"title":"Save a chat-session file to a space","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/save-session-file","href":"/api-reference/files/save-a-chat-session-file-to-a-space"}]},{"group":"Distribution","pages":[{"title":"Bind a distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json post /workspaces/distribution-binding","href":"/api-reference/distribution/bind-a-distribution"},{"title":"Remove a distribution binding","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/workspaces/openapi.json delete /workspaces/distribution-binding","href":"/api-reference/distribution/remove-a-distribution-binding"}]}]},{"group":"Records","pages":[{"group":"Record Configs","pages":[{"title":"List record configurations","description":"Returns all record configurations in the account. Each configuration defines the schema (field names, types, validation rules) and UI hints for a category of records. Call this first to discover available record types before listing or querying records. Pass `ids` to batch-fetch specific configurations instead of all.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config","href":"/api-reference/record-configs/list-record-configurations"},{"title":"Create a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config","href":"/api-reference/record-configs/create-a-record-configuration"},{"title":"Get a record configuration","description":"Retrieves the full schema and UI layout for a specific record configuration. Use this to inspect field definitions and validation rules before creating or updating records of that type.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config/{id}","href":"/api-reference/record-configs/get-a-record-configuration"},{"title":"Update a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json put /records/config/{id}","href":"/api-reference/record-configs/update-a-record-configuration"},{"title":"Delete a record configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/config/{id}","href":"/api-reference/record-configs/delete-a-record-configuration"},{"title":"List shipped fields a config can adopt","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config/upgrades","href":"/api-reference/record-configs/list-shipped-fields-a-config-can-adopt"},{"title":"Adopt shipped fields into a config","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config/upgrade","href":"/api-reference/record-configs/adopt-shipped-fields-into-a-config"}]},{"group":"Record History","pages":[{"title":"Erase a deleted record set's history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/config/{config_id}/history","href":"/api-reference/record-history/erase-a-deleted-record-sets-history"},{"title":"Get a record's change history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/{config_id}/{id}/history","href":"/api-reference/record-history/get-a-records-change-history"},{"title":"Erase a record's history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/{id}/history","href":"/api-reference/record-history/erase-a-records-history"},{"title":"Correct a past version's stored values","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/amend","href":"/api-reference/record-history/correct-a-past-versions-stored-values"},{"title":"Hide a past version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/hide","href":"/api-reference/record-history/hide-a-past-version"},{"title":"Permanently erase a past version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/erase","href":"/api-reference/record-history/permanently-erase-a-past-version"},{"title":"Restore a past version as the record's next version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}/{id}/history/{version}/restore","href":"/api-reference/record-history/restore-a-past-version-as-the-records-next-version"},{"title":"Read a time-series field across a config's records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/{config_id}/series","href":"/api-reference/record-history/read-a-time-series-field-across-a-configs-records"}]},{"group":"Records","pages":[{"title":"Query records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records","href":"/api-reference/records/query-records"},{"title":"Create a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/{config_id}","href":"/api-reference/records/create-a-record"},{"title":"Get a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/{config_id}/{id}","href":"/api-reference/records/get-a-record"},{"title":"Update a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json put /records/{config_id}/{id}","href":"/api-reference/records/update-a-record"},{"title":"Delete a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/{id}","href":"/api-reference/records/delete-a-record"},{"title":"Import records from a CSV","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/csv-import","href":"/api-reference/records/import-records-from-a-csv"},{"title":"Delete records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/bulk","href":"/api-reference/records/delete-records"},{"title":"Purge records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/{config_id}/purge","href":"/api-reference/records/purge-records"},{"title":"Create a record once","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/record-once","href":"/api-reference/records/create-a-record-once"},{"title":"Get or make a member's row","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/member-rows","href":"/api-reference/records/get-or-make-a-members-row"},{"title":"Send a members step to every member","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/member-send","href":"/api-reference/records/send-a-members-step-to-every-member"},{"title":"Read a members step send","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/member-send/{id}","href":"/api-reference/records/read-a-members-step-send"},{"title":"Upsert a record by identity","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/upsert-record","href":"/api-reference/records/upsert-a-record-by-identity"},{"title":"Delete a record while a field is unset","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/record-if","href":"/api-reference/records/delete-a-record-while-a-field-is-unset"},{"title":"Reindex a config's records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/reindex","href":"/api-reference/records/reindex-a-configs-records"},{"title":"Export a record set as a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/export-records","href":"/api-reference/records/export-a-record-set-as-a-file"},{"title":"Count records per config","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/records-count-by-config","href":"/api-reference/records/count-records-per-config"}]},{"group":"Record Config Collections","pages":[{"title":"List record config collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-collections","href":"/api-reference/record-config-collections/list-record-config-collections"},{"title":"Create a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config-collections","href":"/api-reference/record-config-collections/create-a-record-config-collection"},{"title":"Get a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-collections/{id}","href":"/api-reference/record-config-collections/get-a-record-config-collection"},{"title":"Update a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json put /records/config-collections/{id}","href":"/api-reference/record-config-collections/update-a-record-config-collection"},{"title":"Delete a record config collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json delete /records/config-collections/{id}","href":"/api-reference/record-config-collections/delete-a-record-config-collection"}]},{"group":"Record Config Versions","pages":[{"title":"List a record configuration's published versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-versions/{id}","href":"/api-reference/record-config-versions/list-a-record-configurations-published-versions"},{"title":"Get one published version with its snapshot","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/config-version/{id}","href":"/api-reference/record-config-versions/get-one-published-version-with-its-snapshot"},{"title":"Publish the stored configuration as a new version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/config-publish/{id}","href":"/api-reference/record-config-versions/publish-the-stored-configuration-as-a-new-version"}]},{"group":"Record Metrics","pages":[{"title":"Run metrics","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/metrics-run","href":"/api-reference/record-metrics/run-metrics"},{"title":"Validate metric definitions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/metrics-validate","href":"/api-reference/record-metrics/validate-metric-definitions"}]},{"group":"Record Assessment","pages":[{"title":"Interpret a scored record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/interpret","href":"/api-reference/record-assessment/interpret-a-scored-record"},{"title":"Re-run interpretation for a record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/reinterpret","href":"/api-reference/record-assessment/re-run-interpretation-for-a-record"},{"title":"Re-extract a record's stored report","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/re-extract","href":"/api-reference/record-assessment/re-extract-a-records-stored-report"},{"title":"Publish the assessment policy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-publish","href":"/api-reference/record-assessment/publish-the-assessment-policy"},{"title":"List policy profiles","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-profiles","href":"/api-reference/record-assessment/list-policy-profiles"},{"title":"Preview a policy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-preview","href":"/api-reference/record-assessment/preview-a-policy"},{"title":"Measure a policy's impact","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/policy-impact","href":"/api-reference/record-assessment/measure-a-policys-impact"},{"title":"Run the assessment setup test","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/setup-test","href":"/api-reference/record-assessment/run-the-assessment-setup-test"},{"title":"Approve discussion notes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/approve-notes","href":"/api-reference/record-assessment/approve-discussion-notes"},{"title":"Agree a score","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/agree-score","href":"/api-reference/record-assessment/agree-a-score"},{"title":"Approve a client report","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/approve-client-report","href":"/api-reference/record-assessment/approve-a-client-report"},{"title":"Render a client report","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/client-report-render","href":"/api-reference/record-assessment/render-a-client-report"},{"title":"Create a discussion note","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/discussion-note","href":"/api-reference/record-assessment/create-a-discussion-note"},{"title":"Mark a discussion note signed","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/mark-signed","href":"/api-reference/record-assessment/mark-a-discussion-note-signed"},{"title":"Get approval status","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/approval-status","href":"/api-reference/record-assessment/get-approval-status"},{"title":"Get assessment setup status","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/assess-setup-status","href":"/api-reference/record-assessment/get-assessment-setup-status"},{"title":"Get assessment health","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/assess-health","href":"/api-reference/record-assessment/get-assessment-health"}]},{"group":"Strategy and Simulation","pages":[{"title":"Publish a strategy version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/strategy-publish","href":"/api-reference/strategy-and-simulation/publish-a-strategy-version"},{"title":"Get a strategy version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/strategy-version","href":"/api-reference/strategy-and-simulation/get-a-strategy-version"},{"title":"List strategy versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/strategy-versions","href":"/api-reference/strategy-and-simulation/list-strategy-versions"},{"title":"Get a strategy method text","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json get /records/strategy-method","href":"/api-reference/strategy-and-simulation/get-a-strategy-method-text"},{"title":"Run a simulation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-run","href":"/api-reference/strategy-and-simulation/run-a-simulation"},{"title":"Compare simulation variants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-compare","href":"/api-reference/strategy-and-simulation/compare-simulation-variants"},{"title":"Solve for a simulation target","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-solve","href":"/api-reference/strategy-and-simulation/solve-for-a-simulation-target"},{"title":"Save a simulation result","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/records/openapi.json post /records/simulation-save","href":"/api-reference/strategy-and-simulation/save-a-simulation-result"}]}]},{"group":"Documents","pages":[{"group":"Templates","pages":[{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/templates/{key}","href":"/api-reference/templates/get-template"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json delete /file-generator/templates/{key}","href":"/api-reference/templates/delete-template"},{"title":"Update template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /file-generator/templates/{key}","href":"/api-reference/templates/update-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/templates","href":"/api-reference/templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates","href":"/api-reference/templates/create-template"},{"title":"Publish template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/{key}/publish","href":"/api-reference/templates/publish-template"},{"title":"Validate template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/validate","href":"/api-reference/templates/validate-template"},{"title":"Unset template paths","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/{key}/unset","href":"/api-reference/templates/unset-template-paths"},{"title":"Trigger template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/templates/trigger","href":"/api-reference/templates/trigger-template"}]},{"group":"Documents","pages":[{"title":"Get document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/documents/{key}","href":"/api-reference/documents/get-document"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json delete /file-generator/documents/{key}","href":"/api-reference/documents/delete-document"},{"title":"Update document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /file-generator/documents/{key}","href":"/api-reference/documents/update-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/documents","href":"/api-reference/documents/list-documents"},{"title":"Unset document paths","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /file-generator/documents/{key}/unset","href":"/api-reference/documents/unset-document-paths"},{"title":"List files assigned to me","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/assigned-files","href":"/api-reference/documents/list-files-assigned-to-me"},{"title":"Read fonts and colours from an Office file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/brand-extract","href":"/api-reference/documents/read-fonts-and-colours-from-an-office-file"}]},{"group":"Signatures","pages":[{"title":"Get document signature URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /file-generator/documents/{key}/signature-url","href":"/api-reference/signatures/get-document-signature-url"},{"title":"HelloSign callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/webhooks/hellosign/{account}","href":"/api-reference/signatures/hellosign-callback"}]},{"group":"Approvals","pages":[{"title":"List approvals for a file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /workspaces/approvals","href":"/api-reference/approvals/list-approvals-for-a-file"},{"title":"Request an approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /workspaces/approvals","href":"/api-reference/approvals/request-an-approval"},{"title":"Get an approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /workspaces/approvals/{id}","href":"/api-reference/approvals/get-an-approval"},{"title":"Delete an approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json delete /workspaces/approvals/{id}","href":"/api-reference/approvals/delete-an-approval"},{"title":"Approve a document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /workspaces/approvals/{id}/approve","href":"/api-reference/approvals/approve-a-document"},{"title":"Reject a document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json patch /workspaces/approvals/{id}/reject","href":"/api-reference/approvals/reject-a-document"},{"title":"List approval events","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json get /workspaces/approvals/{id}/events","href":"/api-reference/approvals/list-approval-events"},{"title":"Record a signatory event","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /workspaces/approvals/{id}/events","href":"/api-reference/approvals/record-a-signatory-event"}]},{"group":"Generation","pages":[{"title":"Generate a PPTX presentation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/pptx","href":"/api-reference/generation/generate-a-pptx-presentation"},{"title":"Convert HTML to PDF","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/html-pdf","href":"/api-reference/generation/convert-html-to-pdf"},{"title":"Generate a DOCX document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-generator","href":"/api-reference/generation/generate-a-docx-document"},{"title":"Edit a DOCX document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-editor","href":"/api-reference/generation/edit-a-docx-document"},{"title":"Generate a PDF with Python","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/pdf-python","href":"/api-reference/generation/generate-a-pdf-with-python"},{"title":"Create or edit an XLSX spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/xlsx","href":"/api-reference/generation/create-or-edit-an-xlsx-spreadsheet"},{"title":"Read an XLSX spreadsheet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/xlsx-read","href":"/api-reference/generation/read-an-xlsx-spreadsheet"},{"title":"Convert a document between formats","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/document-convert","href":"/api-reference/generation/convert-a-document-between-formats"}]},{"group":"Template Source","pages":[{"title":"Render-check a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-render-check","href":"/api-reference/template-source/render-check-a-docx-template-source"},{"title":"Lint a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-lint","href":"/api-reference/template-source/lint-a-docx-template-source"},{"title":"Tag a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-tag","href":"/api-reference/template-source/tag-a-docx-template-source"},{"title":"Repair a DOCX template source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-repair","href":"/api-reference/template-source/repair-a-docx-template-source"},{"title":"List DOCX template source versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-source-versions","href":"/api-reference/template-source/list-docx-template-source-versions"},{"title":"Restore a DOCX template source version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-source-restore","href":"/api-reference/template-source/restore-a-docx-template-source-version"},{"title":"Discard DOCX template edits","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-discard-edits","href":"/api-reference/template-source/discard-docx-template-edits"},{"title":"Edit DOCX template wording","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-edit-text","href":"/api-reference/template-source/edit-docx-template-wording"},{"title":"Locate a DOCX template working copy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-working-locate","href":"/api-reference/template-source/locate-a-docx-template-working-copy"},{"title":"Adopt a sandbox candidate as the working copy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-adopt","href":"/api-reference/template-source/adopt-a-sandbox-candidate-as-the-working-copy"},{"title":"Promote a scratch copy to the working copy","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/documents/openapi.json post /file-generator/docx-promote-scratch","href":"/api-reference/template-source/promote-a-scratch-copy-to-the-working-copy"}]}]},{"group":"Secrets Manager","pages":[{"group":"Secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json get /secrets","href":"/api-reference/secrets/list-secrets"},{"title":"Create or update a secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json put /secrets","href":"/api-reference/secrets/create-or-update-a-secret"},{"title":"Get a secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json get /secrets/{key}","href":"/api-reference/secrets/get-a-secret"},{"title":"Delete a secret","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json delete /secrets/{key}","href":"/api-reference/secrets/delete-a-secret"},{"title":"List personal secrets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/secrets-manager/openapi.json get /secrets/user","href":"/api-reference/secrets/list-personal-secrets"}]}]},{"group":"Hub Flows","pages":[{"group":"Collections","pages":[{"title":"List collections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/collections","href":"/api-reference/collections/list-collections"},{"title":"Create a new collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/collections","href":"/api-reference/collections/create-a-new-collection"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/collections/{collection_type}/{collection_topic}","href":"/api-reference/collections/get-a-collection"},{"title":"Delete a collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/collections/{collection_type}/{collection_topic}","href":"/api-reference/collections/delete-a-collection"},{"title":"Update a Workflow or Node collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/collections/{collection_type}/{collection_topic}","href":"/api-reference/collections/update-a-workflow-or-node-collection"}]},{"group":"Nodes","pages":[{"title":"List node templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/nodes","href":"/api-reference/nodes/list-node-templates"},{"title":"Create a new node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/nodes","href":"/api-reference/nodes/create-a-new-node"},{"title":"Get a node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/nodes/{collection_topic}/{node_topic}","href":"/api-reference/nodes/get-a-node"},{"title":"Delete a node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/nodes/{collection_topic}/{node_topic}","href":"/api-reference/nodes/delete-a-node"},{"title":"Update a node","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/nodes/{collection_topic}/{node_topic}","href":"/api-reference/nodes/update-a-node"},{"title":"Update multiple nodes","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/nodes/batch","href":"/api-reference/nodes/update-multiple-nodes"},{"title":"Get a node projection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/nodes/{collection_topic}/{node_topic}/projection","href":"/api-reference/nodes/get-a-node-projection"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create a new workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows","href":"/api-reference/workflows/create-a-new-workflow"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}","href":"/api-reference/workflows/get-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/workflows/{collection_topic}/{flow_topic}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"Update a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/workflows/{collection_topic}/{flow_topic}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Run a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/{collection_topic}/{flow_topic}/run","href":"/api-reference/workflows/run-a-workflow"},{"title":"Workflow Configuration History","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}/history","href":"/api-reference/workflows/workflow-configuration-history"},{"title":"Publish a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/publish","href":"/api-reference/workflows/publish-a-workflow"},{"title":"Get a node of a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}/node/{node_topic}","href":"/api-reference/workflows/get-a-node-of-a-workflow"},{"title":"Check a workflow's node and edge lists","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/{collection_topic}/{flow_topic}/integrity","href":"/api-reference/workflows/check-a-workflows-node-and-edge-lists"},{"title":"Validate a workflow config","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/validate","href":"/api-reference/workflows/validate-a-workflow-config"},{"title":"Run a workflow as a test","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/run-test","href":"/api-reference/workflows/run-a-workflow-as-a-test"},{"title":"Get run statistics","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/run-stats","href":"/api-reference/workflows/get-run-statistics"}]},{"group":"Oauth","pages":[{"title":"List OAuth configurations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-config","href":"/api-reference/oauth/list-oauth-configurations"},{"title":"Get OAuth configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-config","href":"/api-reference/oauth/get-oauth-configuration"},{"title":"Update an OAuth configuration.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json put /hub/integrations/{integration_id}/oauth-config","href":"/api-reference/oauth/update-an-oauth-configuration"},{"title":"Delete an OAuth configuration.","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/integrations/{integration_id}/oauth-config","href":"/api-reference/oauth/delete-an-oauth-configuration"},{"title":"List OAuth connections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-connections","href":"/api-reference/oauth/list-oauth-connections"},{"title":"Get OAuth connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-token/{connection_id}","href":"/api-reference/oauth/get-oauth-connection"},{"title":"Get integration connections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-connections","href":"/api-reference/oauth/get-integration-connections"},{"title":"Delete OAuth connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/integrations/{integration_id}/oauth-connections/{connection_id}","href":"/api-reference/oauth/delete-oauth-connection"},{"title":"OAuth callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-callback","href":"/api-reference/oauth/oauth-callback"},{"title":"Refresh OAuth token","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/{integration_id}/oauth-refresh-token/{connection_id}","href":"/api-reference/oauth/refresh-oauth-token"},{"title":"Get OAuth variables","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/integrations/oauth-variables","href":"/api-reference/oauth/get-oauth-variables"},{"title":"Save OAuth variables","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/integrations/oauth-variables","href":"/api-reference/oauth/save-oauth-variables"}]},{"group":"API Reference","pages":[{"title":"Execute a workflow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/workflows/run","href":"/api-reference/execute-a-workflow"},{"title":"List paused workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/paused","href":"/api-reference/list-paused-workflow-runs"},{"title":"List errored workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/workflows/errored","href":"/api-reference/list-errored-workflow-runs"},{"title":"Search run logs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/run-logs/search","href":"/api-reference/search-run-logs"},{"title":"List Quiva endpoints","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/quiva-endpoints","href":"/api-reference/list-quiva-endpoints"},{"title":"Test a JSONPath expression","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/test-jpath","href":"/api-reference/test-a-jsonpath-expression"},{"title":"Test an eval-node payload","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/test-eval","href":"/api-reference/test-an-eval-node-payload"},{"title":"Test an http/integration-node request","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/test-http","href":"/api-reference/test-an-httpintegration-node-request"}]},{"group":"Schedules","pages":[{"title":"Schedule a flow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/schedule","href":"/api-reference/schedules/schedule-a-flow"},{"title":"Unschedule a flow","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/unschedule/{topic}","href":"/api-reference/schedules/unschedule-a-flow"},{"title":"List scheduled flows","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/scheduled","href":"/api-reference/schedules/list-scheduled-flows"}]},{"group":"Eval snippets","pages":[{"title":"Get an eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/eval-snippet","href":"/api-reference/eval-snippets/get-an-eval-snippet"},{"title":"Delete an eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/eval-snippet","href":"/api-reference/eval-snippets/delete-an-eval-snippet"},{"title":"Store an eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/eval-snippet","href":"/api-reference/eval-snippets/store-an-eval-snippet"},{"title":"Run a stored eval snippet","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/eval","href":"/api-reference/eval-snippets/run-a-stored-eval-snippet"}]},{"group":"Marketplace","pages":[{"title":"List marketplace flows","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace","href":"/api-reference/marketplace/list-marketplace-flows"},{"title":"Get a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/product","href":"/api-reference/marketplace/get-a-marketplace-product"},{"title":"Get product download statistics","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/product-download-stats","href":"/api-reference/marketplace/get-product-download-statistics"},{"title":"Obtain a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/obtain-marketplace-product","href":"/api-reference/marketplace/obtain-a-marketplace-product"},{"title":"Download a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/marketplace/workflows/download","href":"/api-reference/marketplace/download-a-marketplace-product"},{"title":"Rate a marketplace product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/marketplace/rate-product","href":"/api-reference/marketplace/rate-a-marketplace-product"},{"title":"List marketplace submissions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/submissions","href":"/api-reference/marketplace/list-marketplace-submissions"},{"title":"Create a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json post /hub/marketplace/submissions","href":"/api-reference/marketplace/create-a-marketplace-submission"},{"title":"View a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json get /hub/marketplace/submissions/{topic}","href":"/api-reference/marketplace/view-a-marketplace-submission"},{"title":"Delete a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json delete /hub/marketplace/submissions/{topic}","href":"/api-reference/marketplace/delete-a-marketplace-submission"},{"title":"Update a marketplace submission","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/hub-flows/openapi.json patch /hub/marketplace/submissions/{topic}","href":"/api-reference/marketplace/update-a-marketplace-submission"}]}]},{"group":"Assistants","pages":[{"group":"Assistants","pages":[{"title":"Cancel assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/cancel","href":"/api-reference/assistants/cancel-assistants"},{"title":"Invoke an AI assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/invoke","href":"/api-reference/assistants/invoke-an-ai-assistant"},{"title":"List assistant templates","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent","href":"/api-reference/assistants/list-assistant-templates"},{"title":"Create a new assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent","href":"/api-reference/assistants/create-a-new-assistant"},{"title":"Get an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/{id}","href":"/api-reference/assistants/get-an-assistant"},{"title":"Update an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json put /hub/agent/{id}","href":"/api-reference/assistants/update-an-assistant"},{"title":"Delete an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json delete /hub/agent/{id}","href":"/api-reference/assistants/delete-an-assistant"},{"title":"Browse the MCP registry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/mcp/registry","href":"/api-reference/assistants/browse-the-mcp-registry"},{"title":"Register an MCP server to your account","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/mcp/register","href":"/api-reference/assistants/register-an-mcp-server-to-your-account"},{"title":"List favorite assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/favorites","href":"/api-reference/assistants/list-favorite-assistants"},{"title":"Favorite an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/favorites/add","href":"/api-reference/assistants/favorite-an-assistant"},{"title":"Unfavorite an assistant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/favorites/remove","href":"/api-reference/assistants/unfavorite-an-assistant"},{"title":"List private assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/list/private","href":"/api-reference/assistants/list-private-assistants"},{"title":"List team assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/list/team","href":"/api-reference/assistants/list-team-assistants"},{"title":"Get assistant version history","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/{id}/history","href":"/api-reference/assistants/get-assistant-version-history"},{"title":"Search assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/query","href":"/api-reference/assistants/search-assistants"},{"title":"Set an assistant image","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/image","href":"/api-reference/assistants/set-an-assistant-image"},{"title":"Rate an assistant definition","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/rate","href":"/api-reference/assistants/rate-an-assistant-definition"},{"title":"Steer running assistants","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/steer","href":"/api-reference/assistants/steer-running-assistants"},{"title":"Get an assistant session","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent-session/{id}","href":"/api-reference/assistants/get-an-assistant-session"},{"title":"Set a session unread","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/set-agent-session-unread","href":"/api-reference/assistants/set-a-session-unread"},{"title":"Add session members","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/add-agent-session-members","href":"/api-reference/assistants/add-session-members"},{"title":"Save assistant learning","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json put /hub/agent/learning/{id}","href":"/api-reference/assistants/save-assistant-learning"},{"title":"Get an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent-interaction/{id}","href":"/api-reference/assistants/get-an-assistant-interaction"},{"title":"Update an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json put /hub/agent-interaction/{id}","href":"/api-reference/assistants/update-an-assistant-interaction"},{"title":"Delete an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json delete /hub/agent-interaction/{id}","href":"/api-reference/assistants/delete-an-assistant-interaction"},{"title":"Record an assistant interaction","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent-interaction","href":"/api-reference/assistants/record-an-assistant-interaction"},{"title":"Resolve an escalation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/resolve-escalation","href":"/api-reference/assistants/resolve-an-escalation"},{"title":"Autocomplete a place","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/places-autocomplete","href":"/api-reference/assistants/autocomplete-a-place"},{"title":"Get place details","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/places-details","href":"/api-reference/assistants/get-place-details"}]},{"group":"MCP servers","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/mcp","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create an MCP server from an OpenAPI spec","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/mcp","href":"/api-reference/mcp-servers/create-an-mcp-server-from-an-openapi-spec"},{"title":"Get an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json get /hub/agent/mcp/{id}","href":"/api-reference/mcp-servers/get-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json delete /hub/agent/mcp/{id}","href":"/api-reference/mcp-servers/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json patch /hub/agent/mcp/{id}","href":"/api-reference/mcp-servers/update-an-mcp-server"},{"title":"Create an MCP server from a Postman collection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/agent/mcp-postman-collection","href":"/api-reference/mcp-servers/create-an-mcp-server-from-a-postman-collection"},{"title":"Convert an MCP tool to JSON schema","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/mcp-json-schema","href":"/api-reference/mcp-servers/convert-an-mcp-tool-to-json-schema"},{"title":"Bind OAuth to an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/mcp/server-oauth","href":"/api-reference/mcp-servers/bind-oauth-to-an-mcp-server"},{"title":"Validate an OpenAPI document","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/assistants/openapi.json post /hub/validate-openapi-schema","href":"/api-reference/mcp-servers/validate-an-openapi-document"}]}]},{"group":"Gateway","pages":[{"group":"Gateways","pages":[{"title":"Create a new gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway","href":"/api-reference/gateways/create-a-new-gateway"},{"title":"Get a specific gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}","href":"/api-reference/gateways/get-a-specific-gateway"},{"title":"Delete a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/{gateway_topic}","href":"/api-reference/gateways/delete-a-gateway"},{"title":"Update a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/{gateway_topic}","href":"/api-reference/gateways/update-a-gateway"},{"title":"Get all gateways","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/all","href":"/api-reference/gateways/get-all-gateways"}]},{"group":"Mappings","pages":[{"title":"Get all mappings for a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/mapping","href":"/api-reference/mappings/get-all-mappings-for-a-gateway"},{"title":"Create a new mapping for a gateway","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/{gateway_topic}/mapping","href":"/api-reference/mappings/create-a-new-mapping-for-a-gateway"},{"title":"Get a specific mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/mapping/details","href":"/api-reference/mappings/get-a-specific-mapping"},{"title":"Delete a mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/{gateway_topic}/mapping/details","href":"/api-reference/mappings/delete-a-mapping"},{"title":"Update a mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/{gateway_topic}/mapping/details","href":"/api-reference/mappings/update-a-mapping"},{"title":"Get all mappings","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/mapping/all","href":"/api-reference/mappings/get-all-mappings"}]},{"group":"Mapping Versions","pages":[{"title":"Get all versions for a mapping","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/mapping/version","href":"/api-reference/mapping-versions/get-all-versions-for-a-mapping"},{"title":"Create a new mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/{gateway_topic}/mapping/version","href":"/api-reference/mapping-versions/create-a-new-mapping-version"},{"title":"Get a specific mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/mapping-version/{gateway_topic}/{version_number}","href":"/api-reference/mapping-versions/get-a-specific-mapping-version"},{"title":"Delete a mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/mapping-version/{gateway_topic}/{version_number}","href":"/api-reference/mapping-versions/delete-a-mapping-version"},{"title":"Update a mapping version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/mapping-version/{gateway_topic}/{version_number}","href":"/api-reference/mapping-versions/update-a-mapping-version"},{"title":"Get all mapping versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/mapping-version/all","href":"/api-reference/mapping-versions/get-all-mapping-versions"}]},{"group":"DNS Zones","pages":[{"title":"Create a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/dns-zone","href":"/api-reference/dns-zones/create-a-dns-zone"},{"title":"List DNS zones","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/all","href":"/api-reference/dns-zones/list-dns-zones"},{"title":"Get a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/{zone_id}","href":"/api-reference/dns-zones/get-a-dns-zone"},{"title":"Delete a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/dns-zone/{zone_id}","href":"/api-reference/dns-zones/delete-a-dns-zone"},{"title":"Update a DNS zone","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/dns-zone/{zone_id}","href":"/api-reference/dns-zones/update-a-dns-zone"}]},{"group":"DNS Records","pages":[{"title":"List DNS records","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/{zone_id}/record","href":"/api-reference/dns-records/list-dns-records"},{"title":"Create a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/dns-zone/{zone_id}/record","href":"/api-reference/dns-records/create-a-dns-record"},{"title":"Get a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/dns-zone/{zone_id}/record/{record_id}","href":"/api-reference/dns-records/get-a-dns-record"},{"title":"Delete a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/dns-zone/{zone_id}/record/{record_id}","href":"/api-reference/dns-records/delete-a-dns-record"},{"title":"Update a DNS record","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/dns-zone/{zone_id}/record/{record_id}","href":"/api-reference/dns-records/update-a-dns-record"},{"title":"List a gateway's domains","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/{gateway_topic}/dns-records","href":"/api-reference/dns-records/list-a-gateways-domains"}]},{"group":"Certificates","pages":[{"title":"Get a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json get /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/get-a-certificate"},{"title":"Request a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json post /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/request-a-certificate"},{"title":"Revoke a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json delete /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/revoke-a-certificate"},{"title":"Renew a certificate","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/gateway/openapi.json patch /gateway/cert/{zone_id}/{record_id}","href":"/api-reference/certificates/renew-a-certificate"}]}]},{"group":"Storage","pages":[{"group":"KV Buckets","pages":[{"title":"List all KV buckets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv","href":"/api-reference/kv-buckets/list-all-kv-buckets"},{"title":"Create a new KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/kv","href":"/api-reference/kv-buckets/create-a-new-kv-bucket"},{"title":"Get KV bucket details","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}","href":"/api-reference/kv-buckets/get-kv-bucket-details"},{"title":"Create or update a KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/kv/{bucket}","href":"/api-reference/kv-buckets/create-or-update-a-kv-bucket"},{"title":"Delete KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}","href":"/api-reference/kv-buckets/delete-kv-bucket"},{"title":"Purge KV bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}/purge","href":"/api-reference/kv-buckets/purge-kv-bucket"}]},{"group":"KV Entries","pages":[{"title":"Get latest KV entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}/entries","href":"/api-reference/kv-entries/get-latest-kv-entries"},{"title":"Create or update several KV entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/kv/{bucket}/entries","href":"/api-reference/kv-entries/create-or-update-several-kv-entries"},{"title":"Delete several KV entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}/entries","href":"/api-reference/kv-entries/delete-several-kv-entries"},{"title":"Get KV entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}/entries/{key}","href":"/api-reference/kv-entries/get-kv-entry"},{"title":"Create or update KV entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/kv/{bucket}/entries/{key}","href":"/api-reference/kv-entries/create-or-update-kv-entry"},{"title":"Delete KV entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/kv/{bucket}/entries/{key}","href":"/api-reference/kv-entries/delete-kv-entry"}]},{"group":"KV Search","pages":[{"title":"Search KV entries by key pattern","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/kv/{bucket}/search-by-key","href":"/api-reference/kv-search/search-kv-entries-by-key-pattern"}]},{"group":"Object Store","pages":[{"title":"List all object store buckets","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj","href":"/api-reference/object-store/list-all-object-store-buckets"},{"title":"Create object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/obj","href":"/api-reference/object-store/create-object-store-bucket"},{"title":"Get an object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj/{bucket}","href":"/api-reference/object-store/get-an-object-store-bucket"},{"title":"Create or update object store","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/obj/{bucket}","href":"/api-reference/object-store/create-or-update-object-store"},{"title":"Delete an object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}","href":"/api-reference/object-store/delete-an-object-store-bucket"},{"title":"Purge object store bucket","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}/purge","href":"/api-reference/object-store/purge-object-store-bucket"},{"title":"List object store entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj/{bucket}/entries","href":"/api-reference/object-store/list-object-store-entries"},{"title":"Delete several object store entries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}/entries","href":"/api-reference/object-store/delete-several-object-store-entries"},{"title":"Get an object store entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/obj/{bucket}/entries/{key}","href":"/api-reference/object-store/get-an-object-store-entry"},{"title":"Delete an object store entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/obj/{bucket}/entries/{key}","href":"/api-reference/object-store/delete-an-object-store-entry"},{"title":"Sync an object store entry","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/obj/sync","href":"/api-reference/object-store/sync-an-object-store-entry"}]},{"group":"Streams","pages":[{"title":"List all streams","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/streams","href":"/api-reference/streams/list-all-streams"},{"title":"Create a new stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/streams","href":"/api-reference/streams/create-a-new-stream"},{"title":"Get information about a stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/streams/{name}","href":"/api-reference/streams/get-information-about-a-stream"},{"title":"Create or update a stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/streams/{name}","href":"/api-reference/streams/create-or-update-a-stream"},{"title":"Delete a stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/streams/{name}","href":"/api-reference/streams/delete-a-stream"},{"title":"Purge stream messages","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/stream/{name}/purge","href":"/api-reference/streams/purge-stream-messages"}]},{"group":"Messages","pages":[{"title":"Publish message to stream","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/streams/{name}/messages","href":"/api-reference/messages/publish-message-to-stream"},{"title":"Deletes stream messages","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json delete /storage/streams/{name}/messages","href":"/api-reference/messages/deletes-stream-messages"}]},{"group":"Stream Search","pages":[{"title":"Search stream messages by subject pattern","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/streams/{stream}/search-by-subject","href":"/api-reference/stream-search/search-stream-messages-by-subject-pattern"}]},{"group":"Agent Sessions","pages":[{"title":"List an assistant session's files","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files","href":"/api-reference/agent-sessions/list-an-assistant-sessions-files"},{"title":"Add a file to an assistant session","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/agent-sessions/{session_id}/files","href":"/api-reference/agent-sessions/add-a-file-to-an-assistant-session"},{"title":"Read a session file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files/{key}","href":"/api-reference/agent-sessions/read-a-session-file"},{"title":"Overwrite a session file","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json put /storage/agent-sessions/{session_id}/files/{key}","href":"/api-reference/agent-sessions/overwrite-a-session-file"},{"title":"List a session file's versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files/{key}/versions","href":"/api-reference/agent-sessions/list-a-session-files-versions"},{"title":"Read an archived session file version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/files/{key}/versions/{content_key}","href":"/api-reference/agent-sessions/read-an-archived-session-file-version"},{"title":"List a session's stored tool responses","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/tool-responses","href":"/api-reference/agent-sessions/list-a-sessions-stored-tool-responses"},{"title":"Read a stored tool response","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json get /storage/agent-sessions/{session_id}/tool-responses/{key}","href":"/api-reference/agent-sessions/read-a-stored-tool-response"}]},{"group":"Index","pages":[{"title":"Query a search index","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/storage/openapi.json post /storage/index/{name}/query","href":"/api-reference/index/query-a-search-index"}]}]},{"group":"Trigger","pages":[{"group":"Triggers","pages":[{"title":"Retrieve all triggers","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json get /trigger/triggers","href":"/api-reference/triggers/retrieve-all-triggers"},{"title":"Retrieve a specific trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json get /trigger/triggers/{trigger_type}/{topic}","href":"/api-reference/triggers/retrieve-a-specific-trigger"},{"title":"Delete a trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json delete /trigger/triggers/{trigger_type}/{topic}","href":"/api-reference/triggers/delete-a-trigger"},{"title":"Update a trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json patch /trigger/triggers/{trigger_type}/{topic}","href":"/api-reference/triggers/update-a-trigger"}]},{"group":"Gateway Triggers","pages":[{"title":"Create a gateway trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/gateway","href":"/api-reference/gateway-triggers/create-a-gateway-trigger"}]},{"group":"Stream Triggers","pages":[{"title":"Create a stream trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/stream","href":"/api-reference/stream-triggers/create-a-stream-trigger"}]},{"group":"Object Store Triggers","pages":[{"title":"Create an object store trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/obj","href":"/api-reference/object-store-triggers/create-an-object-store-trigger"}]},{"group":"Email Triggers","pages":[{"title":"Create an email trigger","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/email","href":"/api-reference/email-triggers/create-an-email-trigger"}]},{"group":"Email triggers","pages":[{"title":"Search received emails","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/emails/search","href":"/api-reference/email-triggers/search-received-emails"},{"title":"Get a received email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json get /trigger/emails/{uid}","href":"/api-reference/email-triggers/get-a-received-email"},{"title":"Delete a received email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json delete /trigger/emails/{uid}","href":"/api-reference/email-triggers/delete-a-received-email"},{"title":"Re-run the flow for an email","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/trigger/openapi.json post /trigger/emails/{uid}/trigger","href":"/api-reference/email-triggers/re-run-the-flow-for-an-email"}]}]},{"group":"Monitoring","pages":[{"group":"metrics","pages":[{"title":"Get metric statistics over time","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/monitoring/openapi.json get /monitoring/metrics/{metric}/stats","href":"/api-reference/metrics/get-metric-statistics-over-time"},{"title":"Get current metric value","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/monitoring/openapi.json get /monitoring/metrics/{metric}/current","href":"/api-reference/metrics/get-current-metric-value"},{"title":"Get multiple current metric values","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/monitoring/openapi.json post /monitoring/metrics/current","href":"/api-reference/metrics/get-multiple-current-metric-values"}]}]},{"group":"Microsoft 365","pages":[{"group":"Mail","pages":[{"title":"Start connecting the caller's mailbox","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/connect-url","href":"/api-reference/mail/start-connecting-the-callers-mailbox"},{"title":"Record a connect error that needs admin approval","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/mail/connect-result","href":"/api-reference/mail/record-a-connect-error-that-needs-admin-approval"},{"title":"Get the caller's mailbox connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/connection","href":"/api-reference/mail/get-the-callers-mailbox-connection"},{"title":"Disconnect the caller's mailbox","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/mail/connection","href":"/api-reference/mail/disconnect-the-callers-mailbox"},{"title":"Update the caller's mailbox connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json patch /m365/mail/connection","href":"/api-reference/mail/update-the-callers-mailbox-connection"},{"title":"List who has connected mail","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/connections","href":"/api-reference/mail/list-who-has-connected-mail"},{"title":"Remove a member's mailbox","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/mail/connections/{user_id}","href":"/api-reference/mail/remove-a-members-mailbox"},{"title":"List the caller's mail folders","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/folders","href":"/api-reference/mail/list-the-callers-mail-folders"},{"title":"Get the tenant admin-consent URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/consent-url","href":"/api-reference/mail/get-the-tenant-admin-consent-url"},{"title":"Mail admin-consent callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/consent-callback","href":"/api-reference/mail/mail-admin-consent-callback"}]},{"group":"Mail filing","pages":[{"title":"List mail filters and automations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/filings","href":"/api-reference/mail-filing/list-mail-filters-and-automations"},{"title":"Create a mail filter or automation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/mail/filings","href":"/api-reference/mail-filing/create-a-mail-filter-or-automation"},{"title":"Stop a mail filter or automation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/mail/filings/{id}","href":"/api-reference/mail-filing/stop-a-mail-filter-or-automation"},{"title":"Update a mail filter or automation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json patch /m365/mail/filings/{id}","href":"/api-reference/mail-filing/update-a-mail-filter-or-automation"},{"title":"Recent inbox items for the filing picker","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/recent","href":"/api-reference/mail-filing/recent-inbox-items-for-the-filing-picker"}]},{"group":"Mail automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/automations","href":"/api-reference/mail-automations/list-automations"},{"title":"List an automation's runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/automations/{id}/runs","href":"/api-reference/mail-automations/list-an-automations-runs"},{"title":"Get the actions run on a filed message","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/mail/activity","href":"/api-reference/mail-automations/get-the-actions-run-on-a-filed-message"}]},{"group":"Files connection","pages":[{"title":"Get the files admin-consent URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/consent-url","href":"/api-reference/files-connection/get-the-files-admin-consent-url"},{"title":"Files admin-consent callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/consent-callback","href":"/api-reference/files-connection/files-admin-consent-callback"},{"title":"Get the files admin sign-in URL","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/admin-auth-url","href":"/api-reference/files-connection/get-the-files-admin-sign-in-url"},{"title":"Files admin sign-in callback","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/admin-callback","href":"/api-reference/files-connection/files-admin-sign-in-callback"},{"title":"Get the files connection","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/connection","href":"/api-reference/files-connection/get-the-files-connection"}]},{"group":"SharePoint browse","pages":[{"title":"Search SharePoint sites","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/browse/sites","href":"/api-reference/sharepoint-browse/search-sharepoint-sites"},{"title":"List document libraries","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/browse/drives","href":"/api-reference/sharepoint-browse/list-document-libraries"},{"title":"List folders in a library","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/files/browse/children","href":"/api-reference/sharepoint-browse/list-folders-in-a-library"}]},{"group":"SharePoint sync sources","pages":[{"title":"List sync sources","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources","href":"/api-reference/sharepoint-sync-sources/list-sync-sources"},{"title":"Create a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/sources","href":"/api-reference/sharepoint-sync-sources/create-a-sync-source"},{"title":"Get a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources/{id}","href":"/api-reference/sharepoint-sync-sources/get-a-sync-source"},{"title":"Remove a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json delete /m365/sources/{id}","href":"/api-reference/sharepoint-sync-sources/remove-a-sync-source"},{"title":"Update a sync source","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json patch /m365/sources/{id}","href":"/api-reference/sharepoint-sync-sources/update-a-sync-source"},{"title":"Sync a source now","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json post /m365/sources/{id}/run","href":"/api-reference/sharepoint-sync-sources/sync-a-source-now"},{"title":"Get a sync run","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources/{id}/runs/{run_id}","href":"/api-reference/sharepoint-sync-sources/get-a-sync-run"},{"title":"List sync runs","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/m365/openapi.json get /m365/sources/{id}/runs","href":"/api-reference/sharepoint-sync-sources/list-sync-runs"}]}]},{"group":"Distribution","pages":[{"group":"Distribution Invitations","pages":[{"title":"Create a distribution invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-invite","href":"/api-reference/distribution-invitations/create-a-distribution-invitation"},{"title":"Withdraw a distribution invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json delete /accounts/distribution-invite","href":"/api-reference/distribution-invitations/withdraw-a-distribution-invitation"},{"title":"List outstanding invitations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-invites","href":"/api-reference/distribution-invitations/list-outstanding-invitations"},{"title":"Email an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/send-distribution-invite","href":"/api-reference/distribution-invitations/email-an-invitation"},{"title":"Resend or reopen an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/resend-distribution-invite","href":"/api-reference/distribution-invitations/resend-or-reopen-an-invitation"},{"title":"Re-fetch an invitation link","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-invite-link","href":"/api-reference/distribution-invitations/re-fetch-an-invitation-link"},{"title":"Preview an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/preview-distribution-invite","href":"/api-reference/distribution-invitations/preview-an-invitation"},{"title":"Redeem an invitation","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/redeem-distribution-invite","href":"/api-reference/distribution-invitations/redeem-an-invitation"},{"title":"Get the invitation an account signed up from","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/pending-distribution-invite","href":"/api-reference/distribution-invitations/get-the-invitation-an-account-signed-up-from"},{"title":"List invitations addressed to me","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-invite-inbox","href":"/api-reference/distribution-invitations/list-invitations-addressed-to-me"},{"title":"Get the link for an invitation addressed to me","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-invite-inbox-link","href":"/api-reference/distribution-invitations/get-the-link-for-an-invitation-addressed-to-me"}]},{"group":"Distribution Register","pages":[{"title":"Check a distribution is provisioned","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-status","href":"/api-reference/distribution-register/check-a-distribution-is-provisioned"},{"title":"Get one distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution","href":"/api-reference/distribution-register/get-one-distribution"},{"title":"Amend a distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json patch /accounts/distribution","href":"/api-reference/distribution-register/amend-a-distribution"},{"title":"List distributions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distributions","href":"/api-reference/distribution-register/list-distributions"},{"title":"Get the link to a counterparty","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-link","href":"/api-reference/distribution-register/get-the-link-to-a-counterparty"},{"title":"Reprovision a distribution","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-reprovision","href":"/api-reference/distribution-register/reprovision-a-distribution"},{"title":"Get the distributor firm behind a grant","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-brokerage","href":"/api-reference/distribution-register/get-the-distributor-firm-behind-a-grant"},{"title":"List distributors a product can be sent to","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-connected-accounts","href":"/api-reference/distribution-register/list-distributors-a-product-can-be-sent-to"}]},{"group":"Distributor Setup","pages":[{"title":"Get a distributor's features","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distributor-features","href":"/api-reference/distributor-setup/get-a-distributors-features"},{"title":"Replace a distributor's feature overrides","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json put /accounts/distributor-features","href":"/api-reference/distributor-setup/replace-a-distributors-feature-overrides"},{"title":"Set the distributor space template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distributor-space-template","href":"/api-reference/distributor-setup/set-the-distributor-space-template"},{"title":"Clear the distributor space template","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json delete /accounts/distributor-space-template","href":"/api-reference/distributor-setup/clear-the-distributor-space-template"}]},{"group":"Distribution Products","pages":[{"title":"Publish a record set definition","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/product-definition","href":"/api-reference/distribution-products/publish-a-record-set-definition"},{"title":"List definition versions","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/product-definitions","href":"/api-reference/distribution-products/list-definition-versions"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-product","href":"/api-reference/distribution-products/get-a-product"},{"title":"Publish a product","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-product","href":"/api-reference/distribution-products/publish-a-product"},{"title":"Publish the next product version","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json patch /accounts/distribution-product","href":"/api-reference/distribution-products/publish-the-next-product-version"},{"title":"List my products","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-products","href":"/api-reference/distribution-products/list-my-products"},{"title":"List products granted by a publisher","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/distribution-granted-products","href":"/api-reference/distribution-products/list-products-granted-by-a-publisher"},{"title":"Sync products to distributors","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-products-sync","href":"/api-reference/distribution-products/sync-products-to-distributors"},{"title":"Clear stored space cards","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-clear-space-cards","href":"/api-reference/distribution-products/clear-stored-space-cards"}]},{"group":"Distribution Messages","pages":[{"title":"Send a distribution message","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json post /accounts/distribution-message","href":"/api-reference/distribution-messages/send-a-distribution-message"}]},{"group":"Config Reservations","pages":[{"title":"Release a config id","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json delete /accounts/config-reservation","href":"/api-reference/config-reservations/release-a-config-id"},{"title":"List my config id reservations","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/distribution/openapi.json get /accounts/config-reservations","href":"/api-reference/config-reservations/list-my-config-id-reservations"}]}]},{"group":"Abbie (beta)","pages":[{"group":"Skills","pages":[{"title":"List builtin and user-defined skills","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/skills","href":"/api-reference/skills/list-builtin-and-user-defined-skills"},{"title":"Dry-run skill activation against a message","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/skill/test","href":"/api-reference/skills/dry-run-skill-activation-against-a-message"},{"title":"List skill drafts awaiting review","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/skill-drafts","href":"/api-reference/skills/list-skill-drafts-awaiting-review"},{"title":"Read the account's script-execution opt-in","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/skill-exec","href":"/api-reference/skills/read-the-accounts-script-execution-opt-in"}]},{"group":"Todos","pages":[{"title":"List the caller's backlog (personal + organisation)","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/todos","href":"/api-reference/todos/list-the-callers-backlog-personal-+-organisation"},{"title":"Update one backlog item","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/todo","href":"/api-reference/todos/update-one-backlog-item"},{"title":"Promote a backlog item to a workspace task","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/todo/promote/task","href":"/api-reference/todos/promote-a-backlog-item-to-a-workspace-task"},{"title":"Read the default space for promoted tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/task-space","href":"/api-reference/todos/read-the-default-space-for-promoted-tasks"},{"title":"Set the default space for promoted tasks","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/task-space","href":"/api-reference/todos/set-the-default-space-for-promoted-tasks"}]},{"group":"Memory","pages":[{"title":"List memories","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/org-memories","href":"/api-reference/memory/list-memories"},{"title":"Create a memory","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/org-memory","href":"/api-reference/memory/create-a-memory"},{"title":"Update a memory","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/org-memory/{id}","href":"/api-reference/memory/update-a-memory"},{"title":"Delete a memory","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json delete /hub/coworker/org-memory/{id}","href":"/api-reference/memory/delete-a-memory"},{"title":"Read the memory-consolidation setting","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/memory-consolidation","href":"/api-reference/memory/read-the-memory-consolidation-setting"}]},{"group":"Profile and personality","pages":[{"title":"Read the account's organisation profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/profile","href":"/api-reference/profile-and-personality/read-the-accounts-organisation-profile"},{"title":"Set the account's organisation profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/profile","href":"/api-reference/profile-and-personality/set-the-accounts-organisation-profile"},{"title":"Read your own personal profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/personal-profile","href":"/api-reference/profile-and-personality/read-your-own-personal-profile"},{"title":"Set your own personal profile","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/personal-profile","href":"/api-reference/profile-and-personality/set-your-own-personal-profile"},{"title":"Read the account's voice layer","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/personality","href":"/api-reference/profile-and-personality/read-the-accounts-voice-layer"}]},{"group":"Corrections","pages":[{"title":"Read your own corrections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/corrections","href":"/api-reference/corrections/read-your-own-corrections"},{"title":"Replace your own corrections list","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/corrections","href":"/api-reference/corrections/replace-your-own-corrections-list"},{"title":"Read the organisation's corrections","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/org-corrections","href":"/api-reference/corrections/read-the-organisations-corrections"},{"title":"List proposed corrections awaiting your decision","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/correction-drafts","href":"/api-reference/corrections/list-proposed-corrections-awaiting-your-decision"}]},{"group":"Environment","pages":[{"title":"List declared environment variables","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/env","href":"/api-reference/environment/list-declared-environment-variables"},{"title":"Replace an existing environment variable","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json put /hub/coworker/env","href":"/api-reference/environment/replace-an-existing-environment-variable"},{"title":"Declare a new environment variable","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json post /hub/coworker/env","href":"/api-reference/environment/declare-a-new-environment-variable"},{"title":"Remove an environment variable","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json delete /hub/coworker/env","href":"/api-reference/environment/remove-an-environment-variable"}]},{"group":"Models","pages":[{"title":"Merged model catalogue","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/coworker/model-catalog","href":"/api-reference/models/merged-model-catalogue"},{"title":"Read the account's model pool configuration","deprecated":null,"version":null,"openapi":"/api-reference/endpoint/abbie/openapi.json get /hub/agent/model-pool","href":"/api-reference/models/read-the-accounts-model-pool-configuration"}]}]}]},{"tab":"Change Log","pages":[{"title":"Change Log","href":"/changelog/product-updates"}]}]},"basePath":"","title":"Create a record configuration - QuivaWorks Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}