Speech to text | Respan Docs

Transcribe audio to text through the Respan gateway with automatic logging.

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Audio file. Supported: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.

modelenumRequired

Model ID.

Allowed values:

languagestringOptional

Input audio language (ISO-639-1).

promptstringOptional

Optional text to guide the model's style.

response_formatenumOptionalDefaults to json

Output format.

Allowed values:

temperaturedoubleOptional

Sampling temperature (0-1).

timestamp_granularitiesenumOptional

Timestamp granularities. Requires verbose_json response format.

Allowed values:

customer_credentialsobjectOptional

Per-customer LLM provider credentials.

disable_logbooleanOptionalDefaults to false

When true, omits input/output from the log. Metrics still recorded.

metadataobjectOptional

Custom key-value metadata.

customer_identifierstringOptional

End user identifier.

customer_emailstringOptional

Customer email address.

thread_identifierstringOptional

Conversation thread ID.

request_breakdownbooleanOptional

Return response metrics summary in the response body.

Response

Transcription result.

textstring

Transcribed text.

languagestring

Detected language.

durationdouble

Audio duration in seconds.

wordslist of objects

Word-level timestamps (if requested).

segmentslist of objects

Segment-level timestamps (if requested).

Errors

401

Unauthorized Error

1	curl -X POST https://api.respan.ai/api/audio/transcription \
2	-H "Authorization: Bearer sk_live_xxxxx" \
3	-H "Content-Type: multipart/form-data" \
4	-F file=@meeting_recording_2024_04_27.wav \
5	-F model="whisper-1"

1	{
2	"text": "Good morning everyone, let's start the project update meeting.",
3	"language": "en",
4	"duration": 45.3,
5	"words": [
6	{
7	"word": "Good",
8	"start": 0,
9	"end": 0.3
10	},
11	{
12	"word": "morning",
13	"start": 0.3,
14	"end": 0.7
15	},
16	{
17	"word": "everyone,",
18	"start": 0.7,
19	"end": 1.2
20	},
21	{
22	"word": "let's",
23	"start": 1.2,
24	"end": 1.5
25	},
26	{
27	"word": "start",
28	"start": 1.5,
29	"end": 1.8
30	},
31	{
32	"word": "the",
33	"start": 1.8,
34	"end": 2
35	},
36	{
37	"word": "project",
38	"start": 2,
39	"end": 2.4
40	},
41	{
42	"word": "update",
43	"start": 2.4,
44	"end": 2.8
45	},
46	{
47	"word": "meeting.",
48	"start": 2.8,
49	"end": 3.2
50	}
51	],
52	"segments": [
53	{}
54	]
55	}