Skip to main content
POST
/
submit
Submit from public URL
curl --request POST \
  --url https://api.heify.com/submit \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "url": "https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3",
  "name": "Quarterly Sales Review",
  "evaluator_id": "2abb5563-1234-5678-abcd-ef1234567890"
}
'
import requests

url = "https://api.heify.com/submit"

payload = {
"configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"url": "https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3",
"name": "Quarterly Sales Review",
"evaluator_id": "2abb5563-1234-5678-abcd-ef1234567890"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
configuration_id: 'a1b2c3d4-e5f6-7890-1234-567890abcdef',
url: 'https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3',
name: 'Quarterly Sales Review',
evaluator_id: '2abb5563-1234-5678-abcd-ef1234567890'
})
};

fetch('https://api.heify.com/submit', 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.heify.com/submit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'configuration_id' => 'a1b2c3d4-e5f6-7890-1234-567890abcdef',
'url' => 'https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3',
'name' => 'Quarterly Sales Review',
'evaluator_id' => '2abb5563-1234-5678-abcd-ef1234567890'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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.heify.com/submit"

payload := strings.NewReader("{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"url\": \"https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3\",\n \"name\": \"Quarterly Sales Review\",\n \"evaluator_id\": \"2abb5563-1234-5678-abcd-ef1234567890\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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.heify.com/submit")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"url\": \"https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3\",\n \"name\": \"Quarterly Sales Review\",\n \"evaluator_id\": \"2abb5563-1234-5678-abcd-ef1234567890\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.heify.com/submit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configuration_id\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\",\n \"url\": \"https://s3.amazonaws.com/my-public-bucket/interviews/quarterly-review.mp3\",\n \"name\": \"Quarterly Sales Review\",\n \"evaluator_id\": \"2abb5563-1234-5678-abcd-ef1234567890\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "message": "Transcription created successfully",
    "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef"
  }
}
Use this endpoint when your media file is already hosted at a public URL. For local files, use Submit from local file instead.
Processing is asynchronous — the API returns a transcription_id immediately. Use Get Transcription Details or webhooks to track completion.
The url must be publicly accessible with no authentication required. The download has a 60-second timeout — use a fast, stable URL.
For supported formats, file size limits, and duration limits, see Rate Limits & Quotas.
participant_id and evaluator_id are optional. If provided, they must exist and belong to your account.

Authorizations

x-api-key
string
header
required

Body

application/json
configuration_id
string<uuid>
required

The unique identifier of the configuration to use for processing.

url
string<uri>
required

A publicly accessible URL to the audio or video file to transcribe. Must require no authentication. Subject to a 60-second download timeout.

name
string

Optional custom name for the transcription job.

participant_id
string<uuid>

Optional. Link this transcription to a participant. Must exist and belong to your account.

evaluator_id
string<uuid>

Optional. Link this transcription to an evaluator. Must exist and belong to your account.

Response

201 - application/json

Transcription job created successfully. Processing has started asynchronously.

data
object