Skip to content

Domains

A domain is a business scope under a client. It owns feature definitions and can hold assignments that apply before a service-specific model exists.

/v2/clients/{client_id}/domains/{domain_id}

Domain features are named JSON Schema Draft 2020-12 documents. They describe the inputs needed to initialize or reinitialize services in that domain.

When a service is initialized, the API resolves each feature in order:

  1. Caller-provided value.
  2. Schema default, if present.
  3. Validation error if the feature is required and neither value nor default is available.

Updating domain feature definitions can affect existing services. The API reports which services are unchanged and which need reinitialization.

Domain-scoped assignments are stable keys under the domain. A common pattern is a default assignment that runs during service initialization and produces service state or service-scoped assignments.

Use a domain assignment when the model applies to the domain as a whole. Use a service assignment when the model is specific to an initialized service.

Domain status controls whether the domain can be used by workflows. Treat status changes as operational state changes: consumers should not rely on inactive or unavailable domains for new work.