Twilio Assistants — Understand

naftiko: 1.0.0-alpha2
info:
  label: Twilio Assistants — Understand
  description: 'Twilio Assistants — Understand. 46 operations. Lead operation: Understand. Self-contained Naftiko capability
    covering one Twilio business surface.'
  tags:
  - Twilio
  - Understand
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TWILIO_API_KEY: TWILIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: assistant-understand
    baseUri: https://preview.twilio.com
    description: Twilio Assistants — Understand business capability. Self-contained, no shared references.
    resources:
    - name: understand-Assistants-AssistantSid-Dialogues-Sid
      path: /understand/Assistants/{AssistantSid}/Dialogues/{Sid}
      operations:
      - name: fetchunderstanddialogue
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
    - name: understand-Assistants-AssistantSid-FallbackActions
      path: /understand/Assistants/{AssistantSid}/FallbackActions
      operations:
      - name: fetchunderstandassistantfallbackactions
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
      - name: updateunderstandassistantfallbackactions
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-FieldTypes
      path: /understand/Assistants/{AssistantSid}/FieldTypes
      operations:
      - name: listunderstandfieldtype
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandfieldtype
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-FieldTypes-FieldTypeSid-FieldValues
      path: /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues
      operations:
      - name: listunderstandfieldvalue
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: FieldTypeSid
          in: path
          type: string
          required: true
        - name: Language
          in: query
          type: string
          description: 'An ISO language-country string of the value. For example: *en-US*'
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandfieldvalue
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: FieldTypeSid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-FieldTypes-FieldTypeSid-FieldValues-Sid
      path: /understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}
      operations:
      - name: fetchunderstandfieldvalue
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: FieldTypeSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
      - name: deleteunderstandfieldvalue
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: FieldTypeSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
    - name: understand-Assistants-AssistantSid-FieldTypes-Sid
      path: /understand/Assistants/{AssistantSid}/FieldTypes/{Sid}
      operations:
      - name: fetchunderstandfieldtype
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
      - name: updateunderstandfieldtype
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteunderstandfieldtype
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
    - name: understand-Assistants-AssistantSid-InitiationActions
      path: /understand/Assistants/{AssistantSid}/InitiationActions
      operations:
      - name: fetchunderstandassistantinitiationactions
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
      - name: updateunderstandassistantinitiationactions
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-ModelBuilds
      path: /understand/Assistants/{AssistantSid}/ModelBuilds
      operations:
      - name: listunderstandmodelbuild
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandmodelbuild
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-ModelBuilds-Sid
      path: /understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}
      operations:
      - name: fetchunderstandmodelbuild
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
      - name: updateunderstandmodelbuild
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteunderstandmodelbuild
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          required: true
        - name: Sid
          in: path
          type: string
          required: true
    - name: understand-Assistants-AssistantSid-Queries
      path: /understand/Assistants/{AssistantSid}/Queries
      operations:
      - name: listunderstandquery
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: Language
          in: query
          type: string
          description: An ISO language-country string of the sample.
        - name: ModelBuild
          in: query
          type: string
          description: The Model Build Sid or unique name of the Model Build to be queried.
        - name: Status
          in: query
          type: string
          description: 'A string that described the query status. The values can be: pending_review, reviewed, discarded'
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandquery
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-Queries-Sid
      path: /understand/Assistants/{AssistantSid}/Queries/{Sid}
      operations:
      - name: fetchunderstandquery
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
      - name: updateunderstandquery
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteunderstandquery
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
    - name: understand-Assistants-AssistantSid-StyleSheet
      path: /understand/Assistants/{AssistantSid}/StyleSheet
      operations:
      - name: fetchunderstandstylesheet
        method: GET
        description: Returns Style sheet JSON object for this Assistant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant
          required: true
      - name: updateunderstandstylesheet
        method: POST
        description: Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-Tasks
      path: /understand/Assistants/{AssistantSid}/Tasks
      operations:
      - name: listunderstandtask
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandtask
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-Tasks-Sid
      path: /understand/Assistants/{AssistantSid}/Tasks/{Sid}
      operations:
      - name: fetchunderstandtask
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
      - name: updateunderstandtask
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteunderstandtask
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
    - name: understand-Assistants-AssistantSid-Tasks-TaskSid-Actions
      path: /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions
      operations:
      - name: fetchunderstandtaskactions
        method: GET
        description: Returns JSON actions for this Task.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task.
          required: true
      - name: updateunderstandtaskactions
        method: POST
        description: Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-Tasks-TaskSid-Fields
      path: /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields
      operations:
      - name: listunderstandfield
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Field.
          required: true
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandfield
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Field.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-Tasks-TaskSid-Fields-Sid
      path: /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}
      operations:
      - name: fetchunderstandfield
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Field.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
      - name: deleteunderstandfield
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Field.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
    - name: understand-Assistants-AssistantSid-Tasks-TaskSid-Samples
      path: /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples
      operations:
      - name: listunderstandsample
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Sample.
          required: true
        - name: Language
          in: query
          type: string
          description: An ISO language-country string of the sample.
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createunderstandsample
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Sample.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: understand-Assistants-AssistantSid-Tasks-TaskSid-Samples-Sid
      path: /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}
      operations:
      - name: fetchunderstandsample
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Sample.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
      - name: updateunderstandsample
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Sample.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteunderstandsample
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Sample.
          required: true
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
    - name: understand-Assistants-AssistantSid-Tasks-TaskSid-Statistics
      path: /understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics
      operations:
      - name: fetchunderstandtaskstatistics
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: AssistantSid
          in: path
          type: string
          description: The unique ID of the parent Assistant.
          required: true
        - name: TaskSid
          in: path
          type: string
          description: The unique ID of the Task associated with this Field.
          required: true
    - name: understand-Assistants-Sid
      path: /understand/Assistants/{Sid}
      operations:
      - name: fetchunderstandassistant
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
      - name: updateunderstandassistant
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteunderstandassistant
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this resource.
          required: true
    authentication:
      type: basic
      username: '{{env.TWILIO_USER}}'
      password: '{{env.TWILIO_PASS}}'
  exposes:
  - type: rest
    namespace: assistant-understand-rest
    port: 8080
    description: REST adapter for Twilio Assistants — Understand. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/understand/assistants/{assistantsid}/dialogues/{sid}
      name: understand-assistants-assistantsid-dialogues-sid
      description: REST surface for understand-Assistants-AssistantSid-Dialogues-Sid.
      operations:
      - method: GET
        name: fetchunderstanddialogue
        description: fetchunderstanddialogue
        call: assistant-understand.fetchunderstanddialogue


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/capabilities/assistant-understand.yaml