Instances

An instance is one tenant’s materialized deployment of a published template version: a real project (type hotline), with real flows/flow versions, an agent profile, knowledge-base shells, and integration rows — created by substituting that tenant’s field values into the template payload.

Creating an instance (dashboard)

From headless.v2.nairon.xyz → Instances → New Instance:

1. Pick a template and published version.
2. Fill in the required field values.
3. Choose an existing tenant organization or create a new one.
4. Confirm — this materializes the project, flows/versions, agent profile, KB shells, and integration rows in one operation.

Phone numbers are not auto-assigned as part of materialization — numbers are physical/allocated resources, so an instance records phone-number requirements that get fulfilled by manually assigning a number afterward (or, in the future, by API-driven provisioning).

Creating an instance (API)

The same materialization logic is exposed as POST /v1/templates/{templateId}/instances on service-api (and the equivalent flow through MCP/the dashboard) — useful for rolling out instances as part of your own onboarding flow.

Instance status

An instance’s status reflects its lifecycle: provisioning, active, update_available (a newer template version has been published), updating, failed, archived.

Working inside an instance’s project

Once materialized, an instance’s project behaves like any other hotline project — see the Client guide for day-to-day editing. Fields substituted at creation time are just the flow’s starting content; the tenant’s own team (or you, on their behalf) can keep editing it directly.