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 '
{
  "source_url": "<string>",
  "configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>"
}
'
{
  "message": "Transcription created successfully",
  "transcription_id": "quarterly-review"
}
Submits a publicly accessible audio or video file URL for transcription.
Use this endpoint when your media file is already hosted on a public URL. For local files, use Submit from local file instead.

Authorizations

​
x-api-key
string
header
required

Body

The audio source and transcription parameters.

Schema for submitting a transcription job via a public URL.

​
source_url
string<uri>
required

A publicly accessible URL to the audio file.

​
configuration_id
string<uuid>
required

The unique identifier of the configuration to use for processing.

​
name
string

An optional, user-defined name for the transcription job.

Response

201 - application/json

Transcription job created successfully. The process has been initiated.

​
message
string

A confirmation message indicating success.

​
transcription_id
string

The unique identifier for the newly created transcription job. This is derived from the original file name.