openapi: 3.2.0
info:
  title: Sonetel Transcription API
  version: 1.1.0
  contact:
    email: api-support@sonetel.com
    url: https://www.sonetel.com
    name: Sonetel API Support
  termsOfService: https://sonetel.com/en/help/help-topics/terms-conditions/terms-conditions/
  description: 'Operations tagged Transcription across 2 of this provider''s published API definitions: sonetel-transcription-v1-openapi.yml, sonetel-transcription-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://public-api.sonetel.com
  description: Production
security:
- Sonetel Admin: []
tags:
- name: Transcription
paths:
  /transcription/transcribe_async:
    post:
      summary: Request transcription of a file
      description: 'Transcribe a file asynchronously and send the output to a URL or a text_id.

        A `req_id` is returned to view status of this request.'
      operationId: transcribeFile
      requestBody:
        description: Transcription async request
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                file:
                  $ref: '#/components/schemas/file'
                write_to:
                  $ref: '#/components/schemas/write_to'
                requested_by:
                  $ref: '#/components/schemas/requested_by'
                transcription_profile:
                  type: string
                  enum:
                  - meeting-minutes
                  - sonetel-voicemail
                  - call-recording
                  description: The type of transcription profile that must be used for this transcription. A profile is a set of pre-defined instructions including the transcription provider, provider settings that the transcription service would use for while transcribing the file
                  example: meeting-minutes
      responses:
        '200':
          $ref: '#/components/responses/transcribe_async_response'
      security:
      - Sonetel Admin: []
      servers:
      - url: https://public-api.sonetel.com
        description: Production
      tags:
      - Transcription
    servers:
    - url: https://public-api.sonetel.com
      description: Production
  /transcription/transcribe_async/{req_id}:
    get:
      summary: Fetch transcription status
      description: Get status of transcription request
      operationId: get-transcription-transcribe_async-req_id
      parameters:
      - name: req_id
        in: path
        description: The unique request Id of the transcription request
        required: true
        schema:
          type: string
          example: rYh4653
      responses:
        '200':
          $ref: '#/components/responses/transcribe_async_response'
      security:
      - Sonetel Admin: []
      servers:
      - url: https://public-api.sonetel.com
        description: Production
      tags:
      - Transcription
    servers:
    - url: https://public-api.sonetel.com
      description: Production
components:
  schemas:
    requested_by:
      type: object
      title: requested_by
      description: Details of the service requesting transcription
      properties:
        service:
          type: string
          enum:
          - ai-service
          - call-recording
          - voicemail
          description: Details of the service requesting transcription
          example: ai-service
        ref_id:
          type: string
          description: A reference Id that a service may optionally provide for tracking the transcription request. The ref_id is provided along with the transcription.
          example: Th5643
        account_id:
          type: string
          description: The Sonetel account Id for which the transcription is requested
          example: a1b2c3d4e5
        user_id:
          type: string
          description: The Sonetel user Id for which transcription id reqyested
          example: u1v2w3x4y5
        business_id:
          type: string
          description: The business Id to which this request is associated
          example: b1c2d3e4f5
    write_to:
      type: object
      title: write_to
      description: The destination where the transcript must be deposited. One of more destinations may be specified
      anyOf:
      - type: object
        properties:
          text_id:
            type: string
            description: Text_Id where the transcription should be written
            example: t3x4y5z
      - type: object
        properties:
          callback_url:
            type: string
            description: URL to which the transcript will be posted via HTTP POST request.
            format: uri
            example: https://example.com/callback
    file:
      type: object
      title: file
      description: File to be transcribed must be specified either via a `file_id`, a URL or by providing the file data
      oneOf:
      - type: object
        properties:
          file_id:
            type: string
            description: ID of the file to be transcribed.
            example: a1b2c3d
      - type: object
        properties:
          file_url:
            type: string
            description: URL of the file to be transcribed
            format: uri
      - type: object
        properties:
          data:
            type: string
            description: File data of the file to be transcribed
            format: binary
  responses:
    transcribe_async_response:
      description: Transcription request details
      content:
        application/json:
          schema:
            type: object
            properties:
              request_id:
                type: string
                description: Unique request Id of the transcription request
              status:
                type: string
                enum:
                - not_started
                - in_progress
                - ready
                description: Status of the transcription request
              file:
                $ref: '#/components/schemas/file'
              write_to:
                $ref: '#/components/schemas/write_to'
              requested_by:
                $ref: '#/components/schemas/requested_by'
              transcription_profile:
                type: string
                enum:
                - meeting-minutes
                - sonetel-voicemail
                - call-recording
                description: The type of transcription profile that must be used for this transcription. A profile is a set of pre-defined instructions including the transcription provider, provider settings that the transcription service would use for while transcribing the file
                example: meeting-minutes
  securitySchemes:
    Sonetel_Admin:
      type: oauth2
      flows:
        password:
          refreshUrl: https://api.sonetel.com/SonetelAuth/beta
          tokenUrl: https://api.sonetel.com/SonetelAuth/beta
          scopes: {}
x-refined-from:
- sonetel-transcription-v1-openapi.yml
- sonetel-transcription-openapi.yml