curl --request POST \
--url https://api.sky-scribe.com/v1/transcribe-file \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'language=<string>' \
--form format=json \
--form 'callback=<string>' \
--form diarize=true \
--form 'team_id=<string>' \
--form 'folder_id=<string>' \
--form 'output_config={
"include_timestamps": true,
"include_speakers": true
}'import requests
url = "https://api.sky-scribe.com/v1/transcribe-file"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"language": "<string>",
"format": "json",
"callback": "<string>",
"diarize": "true",
"team_id": "<string>",
"folder_id": "<string>",
"output_config": "{
\"include_timestamps\": true,
\"include_speakers\": true
}"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('language', '<string>');
form.append('format', 'json');
form.append('callback', '<string>');
form.append('diarize', 'true');
form.append('team_id', '<string>');
form.append('folder_id', '<string>');
form.append('output_config', '{
"include_timestamps": true,
"include_speakers": true
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.sky-scribe.com/v1/transcribe-file', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sky-scribe.com/v1/transcribe-file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sky-scribe.com/v1/transcribe-file"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sky-scribe.com/v1/transcribe-file")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sky-scribe.com/v1/transcribe-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "completed",
"id": "<string>",
"data": {
"json": {
"language": "<string>",
"text": "<string>",
"segments": [
{
"id": "<string>",
"start": 123,
"end": 123,
"text": "<string>",
"speaker": "<string>"
}
]
},
"doc": {
"url": "<string>"
},
"pdf": {
"url": "<string>"
},
"txt": {
"url": "<string>"
},
"markdown": "<string>",
"srt": {
"url": "<string>"
},
"vtt": {
"url": "<string>"
},
"csv": {
"url": "<string>"
}
}
}{
"error": {
"type": "<string>",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "<string>",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}Transcribe from File
Upload an audio or video file for transcription. Synchronously-oriented endpoint that may return a completed result or pending status for longer jobs.
curl --request POST \
--url https://api.sky-scribe.com/v1/transcribe-file \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form 'language=<string>' \
--form format=json \
--form 'callback=<string>' \
--form diarize=true \
--form 'team_id=<string>' \
--form 'folder_id=<string>' \
--form 'output_config={
"include_timestamps": true,
"include_speakers": true
}'import requests
url = "https://api.sky-scribe.com/v1/transcribe-file"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"language": "<string>",
"format": "json",
"callback": "<string>",
"diarize": "true",
"team_id": "<string>",
"folder_id": "<string>",
"output_config": "{
\"include_timestamps\": true,
\"include_speakers\": true
}"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('language', '<string>');
form.append('format', 'json');
form.append('callback', '<string>');
form.append('diarize', 'true');
form.append('team_id', '<string>');
form.append('folder_id', '<string>');
form.append('output_config', '{
"include_timestamps": true,
"include_speakers": true
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.sky-scribe.com/v1/transcribe-file', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sky-scribe.com/v1/transcribe-file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sky-scribe.com/v1/transcribe-file"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sky-scribe.com/v1/transcribe-file")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sky-scribe.com/v1/transcribe-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"format\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"diarize\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"folder_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_config\"\r\n\r\n{\r\n \"include_timestamps\": true,\r\n \"include_speakers\": true\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "completed",
"id": "<string>",
"data": {
"json": {
"language": "<string>",
"text": "<string>",
"segments": [
{
"id": "<string>",
"start": 123,
"end": 123,
"text": "<string>",
"speaker": "<string>"
}
]
},
"doc": {
"url": "<string>"
},
"pdf": {
"url": "<string>"
},
"txt": {
"url": "<string>"
},
"markdown": "<string>",
"srt": {
"url": "<string>"
},
"vtt": {
"url": "<string>"
},
"csv": {
"url": "<string>"
}
}
}{
"error": {
"type": "<string>",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "<string>",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}Supported Formats
- Audio: MP3, WAV, M4A, FLAC, OGG
- Video: MP4, MOV, AVI, MKV, WebM
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Audio or video file to transcribe.
(Optional) Language hint (BCP-47 code). Defaults to 'auto'.
(Optional) Output formats to generate. Available: doc, pdf, txt, markdown, srt, vtt, csv, json. Defaults to ["json"] if not provided.
doc, pdf, txt, markdown, srt, vtt, csv, json (Optional) Webhook URL for async processing. If provided, the job runs asynchronously and results are sent to this URL when complete. Without callback, the endpoint processes synchronously.
(Optional) Enable speaker diarization.
(Optional) Team identifier. If not provided, uses your default workspace.
(Optional) Folder identifier. If not provided, file will be added to the root of the workspace.
(Optional) Output configuration settings.
Show child attributes
Show child attributes
Response
Transcription response. Returns one of two response types:
Option 1 - Completed (status: "completed"): Returned when no callback URL is provided (synchronous processing). Response includes status, id, and data with all requested formats (defaults to json if not specified).
Option 2 - Pending (status: "pending"): Only returned when callback URL is provided (asynchronous processing). Response includes status, id, and poll_url to check progress. Results will be sent to the callback URL when complete.

