Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Intelligence Transcripts API

9 actions 9 updates phrasing extends openapi/twilio-transcripts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v2/Transcripts/{Sid}/Media'].get
$.paths['/v2/Transcripts/{TranscriptSid}/OperatorResults'].get
$.paths['/v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}'].get
$.paths['/v2/Transcripts/{TranscriptSid}/Sentences'].get
$.paths['/v2/Transcripts'].get
$.paths['/v2/Transcripts'].post
$.paths['/v2/Transcripts/{Sid}'].get
$.paths['/v2/Transcripts/{Sid}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio - Intelligence Transcripts API
  version: 1.0.0
extends: openapi/twilio-transcripts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v2/Transcripts/{Sid}/Media'].get
  update:
    x-apievangelist-phrasing:
      intent: Get download links for a transcript's recording
      effect: read
      questions:
      - Where can I download the audio behind a Voice Intelligence transcript?
      - Can I get the PII-redacted version of a transcript's media?
      instructions:
      - text: Get the media download URL for transcript {transcript}.
        slots:
          transcript: path.Sid
      - text: Fetch the media of transcript {transcript} with redaction set to {redacted}.
        slots:
          transcript: path.Sid
          redacted: query.Redacted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts/{TranscriptSid}/OperatorResults'].get
  update:
    x-apievangelist-phrasing:
      intent: List all language-operator results for a transcript
      effect: read
      questions:
      - What did all the language understanding operators find in one transcript?
      - Can I see sentiment, summaries and extractions for a call transcript together?
      instructions:
      - text: List every operator result for transcript {transcript}.
        slots:
          transcript: path.TranscriptSid
      - text: Show the unredacted operator results for transcript {transcript}, redacted={redacted}.
        slots:
          transcript: path.TranscriptSid
          redacted: query.Redacted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one operator's result for a transcript
      effect: read
      questions:
      - What did one specific operator, like my custom classifier, return for a transcript?
      - Can I pull just a single operator's output rather than all of them?
      instructions:
      - text: Get the result of operator {operator} on transcript {transcript}.
        slots:
          operator: path.OperatorSid
          transcript: path.TranscriptSid
      - text: Show operator {operator}'s output for transcript {transcript} with redaction {redacted}.
        slots:
          operator: path.OperatorSid
          transcript: path.TranscriptSid
          redacted: query.Redacted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts/{TranscriptSid}/Sentences'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the sentences of a transcript
      effect: read
      questions:
      - How do I get the actual text of a call, sentence by sentence?
      - Can I read the transcript with personal information redacted?
      instructions:
      - text: List the sentences in transcript {transcript}.
        slots:
          transcript: path.TranscriptSid
      - text: Show transcript {transcript}'s sentences with redaction set to {redacted}.
        slots:
          transcript: path.TranscriptSid
          redacted: query.Redacted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search transcripts in a Voice Intelligence service
      effect: read
      questions:
      - Which transcripts has my Voice Intelligence service produced this week?
      - Can I filter transcripts by status or language?
      - Is there a way to find the transcript for a particular call recording?
      instructions:
      - text: List transcripts for service {service}.
        slots:
          service: query.ServiceSid
      - text: Show transcripts with status {status} created after {after}.
        slots:
          status: query.Status
          after: query.AfterDateCreated
      - text: Find the transcript made from source {source}.
        slots:
          source: query.SourceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts'].post
  update:
    x-apievangelist-phrasing:
      intent: Transcribe a recording into a new transcript
      effect: write
      questions:
      - How do I send a call recording to Twilio Voice Intelligence for transcription?
      - Can I attach my own reference ID to a transcript when I create it?
      instructions:
      - text: Create a transcript in service {service} for media channel {channel}.
        slots:
          service: requestBody.ServiceSid
          channel: requestBody.Channel
      - text: Transcribe channel {channel} in service {service} tagged with customer key {key}.
        slots:
          channel: requestBody.Channel
          service: requestBody.ServiceSid
          key: requestBody.CustomerKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one transcript
      effect: read
      questions:
      - What is the processing status of a single transcript?
      - Can I see the language and duration recorded for one transcript?
      instructions:
      - text: Show me transcript {transcript}.
        slots:
          transcript: path.Sid
      - text: Check whether transcript {transcript} has finished processing.
        slots:
          transcript: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Transcripts/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transcript
      effect: destructive
      questions:
      - How do I permanently delete a call transcript for privacy reasons?
      - Can I remove a transcript once I no longer need it?
      instructions:
      - text: Delete transcript {transcript}.
        slots:
          transcript: path.Sid
      - text: Permanently remove the transcript {transcript} and its data.
        slots:
          transcript: path.Sid
      method: generated
      generated: '2026-09-26'