Sign in

v2

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-071759268.3 KB
Operators

Update an Operator

put/v3/ControlPlane/Operators/{id}

Headers

If-Matchstring

Current ETag/version required for conditional update

Request body

idstring

The unique identifier for the Language Operator. Assigned by Twilio (TTID).

displayNamestring required

Display name of the Language Operator describing its purpose.

descriptionstring

Description of the Language Operator further explaining its purpose.

versioninteger

Numeric Operator version. Automatically incremented with each update on the resource, used to ensure integrity when updating the Operator.

author'SELF' | 'TWILIO'

The creator and maintainer of the Language Operator.

Available values:

  • SELF - Created and maintained by the customer (Custom Operator)
  • TWILIO - Created and maintained by Twilio (Twilio-Authored Operator)
promptstring required

The natural language instructions used by the operator to analyze the conversation.

Within the prompt, users can reference parameters using the {{parameters.[param_name]}} syntax. Parameter values are provided to the Operator by the Intelligence Configuration Rule at runtime.

Note: Prompts will only be exposed for Custom Operators (author = SELF). Twilio-authored Operators (author = TWILIO) will have their prompts omitted from the API.

outputFormat'TEXT' | 'JSON' | 'CLASSIFICATION' required

The structure of the result returned by the Language Operator (specific to what the LLM returns, not the entirety of the Operator Result resource).

Available values:

  • TEXT: The Operator will return plaintext from the LLM.
  • JSON: the Operator will return a structured object with schema defined in output_schema
  • CLASSIFICATION: The Operator will return the determined classifier string.
outputSchemaOperatorOutputSchema

Required for JSON output only. this will be set to a JSON Schema object describing the properties & data types of the response. Please see https://platform.openai.com/docs/guides/structured-outputs#supported-schemas

Will include the following keywords:

  • type : Must be set to object
  • properties: An object containing the property names and their data types you would like the LLM to return

Additional details on JSON output formatting:

  • The root level type of a JSON schema must be set to object
  • The following property data types are supported : string, number, boolean, integer, object, array, anyOf
  • Definitions with $defs / $ref are supported
  • Max 100 object properties and 10 levels of nesting are supported
  • Max 1000 enum values across all enum properties are supported
  • Notable JSON Schema keywords not supported include:
    • For strings: minLength, maxLength
    • For objects: patternProperties, unevaluatedProperties, propertyNames, minProperties, maxProperties
    • For arrays: unevaluatedItems, contains, minContains, maxContains, uniqueItems
  • Structured Operator Results will be returned in the same order as the ordering of keys in the schema
  • In the event an Operator execution request is refused for safety reasons the Operator Result API response will include a new field called refusal to indicate that the LLM refused to fulfill the request
  • Twilio will automatically set additionalProperties to false and specify all provided fields as required (constraints of Structured Outputs). You don't need to pass these fields as part of your JSON schema. Twilio will automatically overwrite any user-provided values for these fields.
parametersOperatorParameters

Defines the schema of the parameters that are provided when running the operator, including required and optional values that determine the operator's behavior. The values of the parameters themselves are passed in by the attached Intelligence Configuration.

Example request

{
  "id": "intelligence_operator_01k6fc25s7epm9qtk8rszbv3q5"
}

Response

Updated Language Operator resource.

idstring

The unique identifier for the Language Operator. Assigned by Twilio (TTID).

displayNamestring

Display name of the Language Operator describing its purpose.

descriptionstring

Description of the Language Operator further explaining its purpose.

versioninteger

Numeric Operator version. Automatically incremented with each update on the resource, used to ensure integrity when updating the Operator.

author'SELF' | 'TWILIO'

The creator and maintainer of the Language Operator.

Available values:

  • SELF - Created and maintained by the customer (Custom Operator)
  • TWILIO - Created and maintained by Twilio (Twilio-Authored Operator)
promptstring

The natural language instructions used by the operator to analyze the conversation.

Within the prompt, users can reference parameters using the {{parameters.[param_name]}} syntax. Parameter values are provided to the Operator by the Intelligence Configuration Rule at runtime.

Note: Prompts will only be exposed for Custom Operators (author = SELF). Twilio-authored Operators (author = TWILIO) will have their prompts omitted from the API.

outputFormat'TEXT' | 'JSON' | 'CLASSIFICATION'

The structure of the result returned by the Language Operator (specific to what the LLM returns, not the entirety of the Operator Result resource).

Available values:

  • TEXT: The Operator will return plaintext from the LLM.
  • JSON: the Operator will return a structured object with schema defined in output_schema
  • CLASSIFICATION: The Operator will return the determined classifier string.
outputSchemaOperatorOutputSchema

Required for JSON output only. this will be set to a JSON Schema object describing the properties & data types of the response. Please see https://platform.openai.com/docs/guides/structured-outputs#supported-schemas

Will include the following keywords:

  • type : Must be set to object
  • properties: An object containing the property names and their data types you would like the LLM to return

Additional details on JSON output formatting:

  • The root level type of a JSON schema must be set to object
  • The following property data types are supported : string, number, boolean, integer, object, array, anyOf
  • Definitions with $defs / $ref are supported
  • Max 100 object properties and 10 levels of nesting are supported
  • Max 1000 enum values across all enum properties are supported
  • Notable JSON Schema keywords not supported include:
    • For strings: minLength, maxLength
    • For objects: patternProperties, unevaluatedProperties, propertyNames, minProperties, maxProperties
    • For arrays: unevaluatedItems, contains, minContains, maxContains, uniqueItems
  • Structured Operator Results will be returned in the same order as the ordering of keys in the schema
  • In the event an Operator execution request is refused for safety reasons the Operator Result API response will include a new field called refusal to indicate that the LLM refused to fulfill the request
  • Twilio will automatically set additionalProperties to false and specify all provided fields as required (constraints of Structured Outputs). You don't need to pass these fields as part of your JSON schema. Twilio will automatically overwrite any user-provided values for these fields.
parametersOperatorParameters

Defines the schema of the parameters that are provided when running the operator, including required and optional values that determine the operator's behavior. The values of the parameters themselves are passed in by the attached Intelligence Configuration.

Example response

{
  "id": "intelligence_operator_01k6fc25s7epm9qtk8rszbv3q5"
}