Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 4.06 KB

AudioApi.md

File metadata and controls

87 lines (63 loc) · 4.06 KB
Raw

AudioApi

All URIs are relative to https://api.telnyx.com/v2

Method HTTP request Description
audioPublicAudioTranscriptionsPost POST /ai/audio/transcriptions Transcribe speech to text (BETA)

audioPublicAudioTranscriptionsPost

AudioTranscriptionResponse audioPublicAudioTranscriptionsPost(_file, model, responseFormat, timestampGranularities)

Transcribe speech to text (BETA)

Transcribe speech to text. This endpoint is consistent with the OpenAI Transcription API and may be used with the OpenAI JS or Python SDK.

Example

import java.io.File;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.AudioApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AudioApi apiInstance = new AudioApi(defaultClient);
        File _file = new File("/path/to/file"); // File | The audio file object to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB.
        String model = "distil-whisper/distil-large-v2"; // String | ID of the model to use. Only `distil-whisper/distil-large-v2` is currently available.
        String responseFormat = "json"; // String | The format of the transcript output. Use `verbose_json` to take advantage of timestamps.
        String timestampGranularities = "segment"; // String | The timestamp granularities to populate for this transcription. `response_format` must be set verbose_json to use timestamp granularities. Currently `segment` is supported.
        try {
            AudioTranscriptionResponse result = apiInstance.audioPublicAudioTranscriptionsPost(_file, model, responseFormat, timestampGranularities);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AudioApi#audioPublicAudioTranscriptionsPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
_file File The audio file object to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB.
model String ID of the model to use. Only `distil-whisper/distil-large-v2` is currently available. [enum: distil-whisper/distil-large-v2]
responseFormat String The format of the transcript output. Use `verbose_json` to take advantage of timestamps. [optional] [default to json] [enum: json, verbose_json]
timestampGranularities String The timestamp granularities to populate for this transcription. `response_format` must be set verbose_json to use timestamp granularities. Currently `segment` is supported. [optional] [enum: segment]

Return type

AudioTranscriptionResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -