Skip to main content

Import an Overlay

Import a complete Customer Overlay top-down: doctypes and fields in one call, optionally published immediately. Blank anchors auto-map to Talonic types.

Import is the fast path for standing up an overlay from a definition you already have. You post the whole thing — name, doctypes, and fields — in one call, and optionally publish it immediately with publish: true. Any doctype you leave without a maps_to anchor is auto-mapped to the best-matching Talonic type by embedding similarity before it is saved, so you do not have to hand-anchor every doctype.

Each doctype carries a key, a name, an optional category, classification signals, and the maps_to Talonic anchor. Each field carries a key plus optional canonical_name, display_name, data_type, synonyms, a doctype_scope (a doctype key, or null/empty/* for a global field), required, format, enum_values, and examples.

Auto-mapping is advisory and never overwrites a maps_to you supplied. A doctype whose top match is ambiguous is left blank for you to resolve with the suggest-mappings endpoint.
POST/v1/customer-ontologies/import

Body parameters

name*stringOverlay name.
descriptionstringOptional description.
doctypesobject[]Custom doctypes (key, name, category?, maps_to?, signals?).
fieldsobject[]Field concepts (key, canonical_name?, data_type?, doctype_scope?, …).
publishbooleanPublish immediately after import.

curl

Import is idempotent authoring, not a merge: the posted definition becomes the draft wholesale. Keep your overlay definition in version control and re-import it on change, the same way you would apply configuration as code.