--- title: "Retrieve a specific Operator Version" method: GET path: "/v3/ControlPlane/Operators/{id}/Versions/{version}" tags: ["Operators"] --- # Retrieve a specific Operator Version `GET /v3/ControlPlane/Operators/{id}/Versions/{version}` ## Response `200` A specific Language Operator version. - object — Full detail of a specific Language Operator version. - `id` string — The unique identifier for the Language Operator. Assigned by Twilio (TTID). - `displayName` string — Display name of the Language Operator describing its purpose. - `description` string — Description of the Language Operator further explaining its purpose. - `version` integer — 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) - `prompt` string — 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. - `outputSchema` OperatorOutputSchema — 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. - `trainingExamples` OperatorTrainingExample[] — An array of example input/output pairs used to illustrate the intended behavior of the Language Operator. These examples help guide the model's understanding of expected input–output relationships and improve consistency during evaluation and testing. **Note**: Training examples will only be exposed for Custom Operators (`author` = `SELF`). Twilio-authored Operators (`author` = `TWILIO`) will have their training examples omitted from the API. - `input` string, required — A sample input text that demonstrates the type of content the Operator processes. - `output` string, required — The expected output corresponding to the provided input example. This value must be consistent with the defined `output_format` and `output_schema` of the Operator. - `context` OperatorContext — Optionally specifies which contextual data sources (Memory, Knowledge) the operator can access during execution. Context objects will be passed in by the Intelligence Configuration Rule at runtime. **Note**: this simply gives the LLM access to these context objects – ultimately the LLM will determine whether to actually call for context at runtime. - `memory` object — Defines whether the Operator has access to Memory (past conversational memories and profile traits). - `enabled` boolean — Set to true to allow access to Memory at runtime. - `knowledge` object — Defines whether the Operator has access to organizational Knowledge Sources (e.g., policies, FAQs, scripts) at runtime. - `enabled` boolean — Set to true to allow access to Knowledge Sources at runtime. - `parameters` OperatorParameters — 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. - `status` 'PREVIEW' | 'ACTIVE' | 'DEPRECATED' | 'RETIRED', required — The lifecycle status of an Operator version. Available values: - `PREVIEW`: Available but restricted to internal/testing visibility. Normal execution. - `ACTIVE`: Available for normal use. - `DEPRECATED`: Still executes normally, but a Warn event is emitted via the Watch product lifecycle system. Customers should migrate to a newer version. - `RETIRED`: Hard failure on execution. An Error is logged in Watch. Customers must manually update their Intelligence Configuration to a valid version. - `dateCreated` string, date-time, required — Timestamp of when this version was created. ## Other responses - `404` — Resource not found - `429` — Too Many requests (rate limit exceeded for request originating from public API) - `500` — Internal server error --- [API](https://skmtc.net/twilio/apis/twilio-intelligence.md) · [All operations](https://skmtc.net/twilio/apis/twilio-intelligence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/twilio/twilio-intelligence/revisions/3a830979326d/schema)