Speech to text

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

ID of the model to use. Only whisper-1 is currently available.

The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.

An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.

The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.

The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.

The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.

You can pass in your customer’s credentials for supported providers and use their credits when our proxy is calling models from those providers.
See details here

"customer_credentials": {

  "openai": {
    "api_key": "YOUR_OPENAI_API_KEY",
  }
}

When set to true, only the request and performance metrics will be recorded, input and output messages will be omitted from the log.

You can add any key-value pair to this metadata field for your reference. Check the details of metadata here.

Contact team@keywordsai.co if you need extra parameter support for your use case.

{
  "my_value_key": "my_value"
}

Use this as a tag to identify the user associated with the API call. See the details of customer identifier here.

{
    //...other_params,
    "customer_identifier": "user_123"
}

This is the email address of the user associated with the API call. You can add your corresponding user’s email address to the request.

You could also edit customer’s emails on the platform. Check the details of user editing here.

{
    //...other_params,
    "customer_email": "hendrix@keywordsai.co"
}

See logs as a conversation log thread. Pass all logs with the same thread_identifier to see them in the same thread.

{
    //...other_params,
    "thread_identifier": "test_thread"
}

Adding this returns the summarization of the response in the response body. If streaming is on, the metrics will be streamed as the last chunk.