Deployment Configuration
The Deployment Configuration is the central composition entity that brings together agent behavior, instructions, and channel configuration to create a deployable unit. Each deployment has exactly one channel (1:1 relationship).
Schema: DeploymentConfigurationSchema
Source: src/core/service-configuration/deployment-config.schema.ts
Attributes
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | — | — | Unique identifier for the deployment |
projectId | string | Yes | — | Project ID for organizational grouping |
deploymentChannelId | string | Yes | — | ID of the deployment channel (1:1) |
deploymentName | string | No | — | Human-readable name for administration |
agentConfigurationId | string | Yes | — | ID of the agent configuration (N:1) |
instructionConfigurationId | string | Yes | — | ID of the instruction configuration (N:1) |
deploymentStatus | enum | Yes | — | Current operational status. One of PENDING, ACTIVE, SUSPENDED, or FAILED. |
provisioningType | enum | No | DIRECT | How deployment processes interactions. One of DIRECT or CHAINED. |
provisioningConfigChainId | string | null | No | — | Voice processing chain ID (for CHAINED type) |
isActive | boolean | No | false | Whether deployment is accepting interactions |
channel | DeploymentChannel | null | No | — | Populated channel configuration |
project | Project | null | No | — | Populated project information |
agent | AgentConfiguration | null | No | — | Populated agent configuration |
instruction | InstructionConfiguration | null | No | — | Populated instruction configuration |
createdAt | number | — | — | Unix timestamp when created |
updatedAt | number | — | — | Unix timestamp when last updated |
Example
{
"id": "deploy_abc123",
"projectId": "proj_456",
"deploymentChannelId": "chan_789",
"deploymentName": "Production Customer Support",
"agentConfigurationId": "agent_def",
"instructionConfigurationId": "inst_ghi",
"deploymentStatus": "ACTIVE",
"provisioningType": "DIRECT",
"isActive": true,
"createdAt": 1709856000000,
"updatedAt": 1709856000000
}
Create / Update Schemas
| Schema | Description | Omits |
|---|---|---|
CreateDeploymentConfigurationSchema | For creating deployments | id, createdAt, updatedAt, populated relations |
CreateChainDeploymentConfigurationSchema | For CHAINED deployments | Same + requires provisioningConfigChainId |
UpdateDeploymentConfigurationSchema | For partial updates | All fields optional except id |
DeploymentConfigurationResultSchema | Lightweight list view | Omits populated relations |
DeploymentConfigurationDetailsSchema | Full detail view | Requires all populated relations |
Related
- Agent Configuration - Defines agent behavior
- Instruction Configuration - Behavioral guidelines
- Interaction Channels - Channel configurations
- Provisioning Config - Voice processing chains