About this endpoint
What it does
Transcribes speech from a media file available at a URL. You choose the transcription service with requested_service, and the response returns a JSON object containing a data object with the corresponding service-specific result.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The media file URL to transcribe. Must be a URI. |
| requested_service | ENUM | Yes | Which transcription service to use. Allowed values: azure, google. |
| azure | Object | No | Azure-specific configuration. Include when requested_service is azure. |
| azure.region | String | No | Azure region. |
| azure.account_id | String | No | Azure account ID. |
| azure.access_token | String | No | Azure access token. |
| Object | No | Google-specific configuration. Include when requested_service is google. | |
| google.google_language | String | No | Google speech language code. |
| google.google_credential_json | Object | No | Google Cloud service account JSON. The schema defines the inner credential fields one level deep; see schema for nested fields. |
Response
Returns a JSON object with a data object field. The data object may include an azure object when requested_service is azure, or a google object when requested_service is google.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Container for the service-specific transcription result. May include azure or google depending on requested_service. |
| data.azure | Object | No | Present when requested_service is azure. The schema allows additional properties. |
| data.google | Object | No | Present when requested_service is google. The schema allows additional properties. |