ConfigurationCreate

A configuration as a single document of operators and actions.

name
Type: string · Name
required

Human label for the configuration, unique within your account.
actions
Type: array object[] · Actions

The actions that fire when operator results meet their conditions.
A delivery instruction that fires when operator results meet its condition.
- type
  Type: string · Typeenum
  required
  
  webhook posts to your endpoint; whisper synthesises a text operator's output into the audio.
  
  values
  webhook
  whisper
- condition
  Type: object · ConditionModelnullable
  
  Optional condition narrowing when the action fires. Omit for an unconditional action.
  
  An action condition: a single clause, or a compound of clauses combined with all / any.
- content
  Type: object · Contentnullable
  
  For a whisper action, {"operator": "<text-operator-name>"} — the text operator to voice.
- once_per_session
  Type: boolean · Once Per Session
  
  When true, the action fires at most once per session, suppressing later matches.
- trigger
  Type: string · Trigger
  
  What the action fires on. Only operator_result is currently accepted; lifecycle triggers are reserved and rejected with 422 until supported.
- webhook_headers
  Type: object · Webhook Headersnullable
  
  Optional headers to send with the webhook, e.g. an auth token.
- webhook_url
  Type: string · Webhook Urlnullable
  
  Destination URL for a webhook action.
- whisper_channel
  Type: string · Whisper Channelenumnullable
  
  For a whisper action, which side of the conversation the synthesised audio is injected into.
  
  values
  caller
  recipient
description
Type: string · Descriptionnullable

Optional human-readable description.
operators
Type: array object[] · Operators

The operators this configuration runs, each with its granularity and context settings.
A reference to an operator within a configuration, with its deployment-time settings.
- granularity
  Type: object · GranularityModel
  required
  
  When this operator runs.
- name
  Type: string · Name
  required
  
  Name of the operator to include.
- context_window
  Type: integer · Context Windownullable
  
  How many prior turns to include in the operator's context.
- include_operator_results
  Type: array string[] · Include Operator Results
  
  Names of other operators in this configuration whose recent results to inject into context.
- include_prior_results
  Type: boolean · Include Prior Results
  
  Inject this operator's own recent results into its context, for cumulative reasoning.
- operator_results_window
  Type: integer · Operator Results Window
  
  How many results to inject per operator named in include_operator_results (latest first).
- parameters
  Type: object · Parameters
  
  Values for the operator's declared parameters, keyed by parameter name.
- prior_results_window
  Type: integer · Prior Results Window
  
  How many of the operator's own prior results to inject when include_prior_results is true.
- version
  Type: integer · Versionnullable
  
  Pin to a specific operator version. Omit on create to bind to the operator's current version.
template_id
Type: integer · Template Idnullable

Optional id of the template this was derived from. Recorded for lineage only; never merged.