Fetch a specific Operator Type.

GET /v2/OperatorTypes/{Sid}

Fetch a specific Operator Type.

Path parameters

  • Sid string Required

    Either a 34 character string that uniquely identifies this Operator Type or the unique name that references an Operator Type.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • name string | null

      A unique name that references an Operator's Operator Type.

    • sid string | null

      A 34 character string that uniquely identifies this Operator Type.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^EY[0-9a-fA-F]{32}$.

    • friendly_name string | null

      A human-readable name of this resource, up to 64 characters.

    • description string | null

      A human-readable description of this resource, longer than the friendly name.

    • output_type string

      Operator Results for this Operator Type will follow this format. Possible values: text-classification, text-extraction, text-extraction-normalized, text-generation.

      Values are text-classification, text-extraction, text-extraction-normalized, or text-generation.

    • supported_languages array[string] | null

      List of languages this Operator Type supports.

    • provider string

      Operators with this Operator Type are executed using this provider. Possible values: twilio, amazon, openai.

      Values are twilio, amazon, or openai.

    • availability string

      Operator Type availability status. Possible values: internal, beta, general-availability, retired, deprecated.

      Values are internal, beta, general-availability, retired, or deprecated.

    • configurable boolean | null

      Operators can be created from configurable Operator Types.

    • config_schema

      JSON Schema for configuring an Operator with this Operator Type. Following https://json-schema.org/

    • date_created string(date-time) | null

      The date that this Operator Type was created, given in ISO 8601 format.

    • date_updated string(date-time) | null

      The date that this Operator Type was updated, given in ISO 8601 format.

    • url string(uri) | null

      The URL of this resource.

GET /v2/OperatorTypes/{Sid}
curl \
 --request GET 'https://intelligence.twilio.com/v2/OperatorTypes/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "name": "Summarization",
  "provider": "openai",
  "docs_link": "https://www.twilio.com/docs/conversational-intelligence/key-concepts#language-operators",
  "description": "Summarize Conversations",
  "output_type": "text-generation",
  "availability": "general-availability",
  "configurable": true,
  "date_created": "2010-08-31T20:36:28Z",
  "date_updated": "2010-08-31T20:36:28Z",
  "config_schema": {
    "field": "value"
  },
  "friendly_name": "Summarize Conversations",
  "supported_languages": [
    "en"
  ]
}