OperatorCreate

Body for creating a custom operator.

description
Type: string · Description
required

Human-readable statement of what this operator assesses.
model_tier
Type: string · Model Tierenum
required

fast for high-frequency, latency-sensitive analysis; standard for quality over speed.
values
- fast
- standard
name
Type: string · Name
required

Operator name (kebab-case), unique within your account and not colliding with a platform operator's name.
output_type
Type: string · Output Typeenum
required

The shape of the result this operator emits — see the output type vocabulary.
values
- classification
- boolean
- score
- multi_tag
- extraction
- text
prompt
Type: string · Prompt
required

Natural-language instructions for the model, describing what to look for and how to reason.
include_reasoning
Type: boolean · Include Reasoning

When true, the model is asked to justify its result and reasoning is populated on events.
output_config
Type: object · Output Config

Type-specific configuration: e.g. {values: [...]} for classification, {min, max} for score, {tags: [...]} for multi_tag, {description} for extraction. Empty for boolean/text.
- propertyName
  Type: anything
parameters
Type: array object[] · Parameters

Parameters the prompt references, whose values are supplied where the operator is configured.
A value an operator's prompt references, supplied per configuration rather than baked into the prompt.
- name
  Type: string · Name
  required
  
  Parameter name (kebab-case), referenced in the prompt as {{parameters.<name>}}.
- type
  Type: string · Typeenum
  required
  
  Parameter type. kb_document resolves to a knowledge base document whose extracted text is substituted into the prompt at session start.
  
  values
  kb_document
  string
  integer
  number
  boolean
- description
  Type: string · Descriptionnullable
  
  Optional hint shown to the configuration author supplying this parameter's value.