Skip to content
/Transcription

Transcription

Workspace-scoped transcription for the supported template callback integration.

Operations

Queue standalone transcription

Request

Queue transcription without creating a project. This is a restricted template integration: callbackUrl must use the supported Supabase callback path. It is not a general-purpose arbitrary webhook endpoint. Results are delivered asynchronously; this operation provides no status polling route.

Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example:693fb82afd8d1c43077ba0fb
workspaceIdstringrequired

Unique identifier for the workspace

Example:693fb82afd8d1c43077ba0fe
Bodyapplication/jsonrequired
Any of:
audioBase64string

Base64 audio, at most 25 MiB decoded. Required when mediaUrl is omitted.

mimeTypestring

Required for base64 uploads.

Enum:"audio/wav""audio/wave""audio/mpeg""audio/mp4""audio/ogg""audio/webm""audio/flac"
filenamestring

Plain filename without path separators; required for base64 uploads.

mediaUrlstring, (uri)required

Existing HTTPS audio on the configured Shuffll CDN. If supplied, it takes precedence over base64.

languagestringrequired
Enum:"en""en_au""en_us""es""fr""iw"
staticTextArray of stringsrequired
callbackUrlstring, (uri)required

Restricted integration: HTTPS https://PROJECT_ID.supabase.co/functions/v1/template-transcription-callback only; no query, fragment, credentials or port.

callbackTokenstringrequired

Sent to the callback as x-shuffll-callback-secret.

externalReferenceobjectrequired
curl -i -X POST \
  https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb/workspace/693fb82afd8d1c43077ba0fe/standalone-transcriptions \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "mediaUrl": "http://example.com",
    "audioBase64": "string",
    "mimeType": "audio/wav",
    "filename": "string",
    "language": "en",
    "staticText": [
      "string"
    ],
    "callbackUrl": "http://example.com",
    "callbackToken": "string",
    "externalReference": {
      "templateId": "string",
      "placementId": "string",
      "inputHash": "string"
    }
  }'

Responses

Queued

Bodyapplication/json
jobIdstringrequired
mediaUrlstring, (uri)required
statusstringrequired
Value:"queued"
Response
{
  "jobId": "string",
  "mediaUrl": "http://example.com",
  "status": "queued"
}