Skip to main content
POST
/
open
/
partner
/
ai
/
transcriptions
/
Submit Audio for Transcription
curl --request POST \
  --url https://platform-us.plaud.ai/developer/api/open/partner/ai/transcriptions/ \
  --header 'Content-Type: <content-type>' \
  --header 'X-Client-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '
{
  "file_url": "<DownloadUrl from file upload>",
  "params": {
    "transcribe": {
      "language": "auto",
      "model": "plaud-fast-whisper"
    },
    "vad": {
      "decode_silence": false
    },
    "diarization": {
      "enabled": false,
      "return_embedding": false
    }
  }
}
'
{
  "transcription_id": "task_exec_xxx",
  "status": "PENDING",
  "data": {}
}

Authorizations

X-Client-Id
string
header
required

Your client_id, issued in the Portal.

X-Client-Api-Key
string
header
required

Your api_key, issued alongside client_id / secret_key in the Portal.

Headers

Content-Type
string
default:application/json
required

Body

application/json
file_url
string
required

Pre-signed download URL returned by complete-upload (M4A, MP3, WAV).

params
object

Optional transcription parameters.

Response

200 - application/json

Transcription task accepted

transcription_id
string

Identifier used to poll for results.

Example:

"task_exec_xxx"

status
enum<string>

PENDING, RECEIVED, STARTED, PROGRESS indicate the task is in progress — keep polling. SUCCESS means the data is ready. FAILURE and REVOKED are terminal failures.

Available options:
PENDING,
RECEIVED,
STARTED,
PROGRESS,
SUCCESS,
FAILURE,
REVOKED
Example:

"PENDING"

data
object

Empty until the transcription completes.