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"
}
'
{
  "data": {
    "message": "Transcription created successfully",
    "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.heify.com/llms.txt

Use this file to discover all available pages before exploring further.

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