API v1.0 • Beta

Transgate API

A powerful RESTful API for transcription jobs. Submit audio files and retrieve high-quality transcription results with speaker identification.

📖 This Page (Static)

  • Read endpoint descriptions
  • Copy code examples
  • Understand request/response formats
  • Best for: Learning & reference
Recommended

⚡ Interactive Docs

  • Test endpoints directly
  • See real API responses
  • No Postman/curl needed
  • Best for: Testing & integration
Open Interactive Docs

Authentication

All API requests require an API key to be included in the request header:

1

Submit Transcription Job (URL)

Submit an audio file for transcription by providing its URL.

Endpoint

Request Body

Example

Response (201 Created)

Possible Error Responses

400

Bad Request: Invalid request body

401

Unauthorized: Invalid or missing API key

402

Payment Required: Insufficient balance

500

Internal Server Error: Server-side error

2

Get Transcription Status and Results

Retrieve the status and results of a transcription job.

Endpoint

Example

Response (200 OK)

Note: The result array and summary are only included when the job status is completed. For jobs that are still processing, only job metadata is returned.

Possible Error Responses

400

Bad Request: Invalid job ID

401

Unauthorized: Invalid or missing API key

404

Not Found: Job not found

500

Internal Server Error: Server-side error

Job Statuses

draft

Transcription job has been created but not yet submitted

not_started

Transcription job has been submited but not yet started

pending

Transcription will start soon

running

Transcription is in progress

speaker_labeling

Speaker labeling is in progress

completed

Transcription is finished and available

failed

Transcription failed due to an error partially or fully

canceled

Transcription was canceled by the user

deleted

Transcription was deleted by the user

3

Callback Webhooks

When you provide a callback URL, the system will automatically send the completed transcription to your endpoint.

Callback Payload

The callback will receive a POST request with the transcription result when the job completes:

Callback Requirements

Method: POST

Content-Type: application/json

Timeout: 10 seconds

Expected Response: 2xx status code for success

Retries: None (single delivery attempt)

Important Notes

The callback is delivered once when the transcription completes successfully. There are no automatic retries.

Your endpoint must respond within 10 seconds or the request will timeout.

If the callback fails, you can still retrieve the transcription using the GET endpoint.

The AI summary is included in the callback when available. If summary generation is not yet complete, it will be omitted.

Important Notes

1

The language parameter is optional. If not provided, the system will attempt to auto-detect the language.

2

The callbackUrl is optional. If provided per-job in audioUrls[], or globally via options.webhookUrl, you will receive a webhook notification when the transcription completes.

3

Make sure you have sufficient balance in your account before submitting transcription jobs.

4

Audio URLs must be publicly accessible. You can generate a pre-signed url if hosted on S3 or GCS for example.

5

The API supports various audio formats (MP3, WAV, etc.). Check the system documentation for supported formats.