POST
/
transcribe
curl --request POST \
  --url https://api.spectropic.ai/v1/transcribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "webhook": "<string>",
  "vocabulary": "<string>",
  "language": "af",
  "model": "standard",
  "numSpeakers": 13
}'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "message": "<string>"
}

Creates a new transcribe job. Sends the finished transcript to the provided webhook URL.

If you use the enhanced model the max audio input duration is currently 60 minutes (this will be increased in the near future).

​
Transcribe a file from direct URL

If you have a media file accessible via a URL, you can provide the URL to the file in the request body with the header Content-Type set to application/json.

Typically you would use this method if you have a file stored in a cloud storage service such as Amazon S3.

Use the url field in the body of the request to provide the URL to the file.

Make sure the URL to the file is publicly accessible, otherwise our endpoint cannot read the file. It must be a direct link to the file, not e.g. a Google Drive share link.

​
Transcribe an uploaded file

Instead of providing a direct URL, you can use the file key you get from the Upload media file endpoint. It starts with file://.

​
Receiving the transcript (Webhook)

The webhook URL is where the finished transcript will be sent. The transcript will be sent as a JSON object in the request body.

Make sure the webhook URL is publicly accessible, otherwise our endpoint cannot send the transcript

The request body of the webhook will be equal to the Transcript schema as specified on page Transcript Schema.

​
Job status and transcript output

You can view the status of the job by using the Retrieve Job endpoint.

The output of the job will be saved in the output field of the job object, and is deleted after 24 hours.

Authorizations

​
Authorization
string
header
required

API key authentication. Add your API key with format: Bearer <API_KEY>

Body

application/json

Transcribe a media file. Either provide a URL to a media file exposed to the public or a file:// key from a file uploaded to the Spectropic Upload API.

Response

200
application/json

OK

The response is of type object.