Skip to main content
POST
Transcribes audio into the input language.
Choose an exact compatible ID from the model list. Supported parameters and output formats vary by model and connection; this schema does not guarantee every upstream feature. See endpoint availability.

Authorizations

api-key
string
header
required

Your Hicap API key.

Headers

x-hicap-tags
string

One JSON object mapping dimension keys to short string values. Never include secrets or direct personal identifiers. Opaque identity references require approved policy and verified destination handling; see the identity attribution guide.

Body

multipart/form-data

Transcription request.

file
file
required

The audio file object to transcribe.

model
string
required

Exact compatible Hicap model ID from GET /v1/models.

Minimum string length: 1
prompt
string

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

response_format
enum<string>

Defines the format of the output.

Available options:
json,
text,
srt,
verbose_json,
vtt
temperature
number
default:0

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

language
string

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

timestamp_granularities[]
enum<string>[]

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.

Available options:
word,
segment

Response

OK

Translation or transcription response when response_format was json

text
string
required

Translated or transcribed text.