Import a public audio URL
Submit a public audio URL for asynchronous ingestion in the selected workspace.
POST
/
v1
/
ingest
/
audio-url
Import a public audio URL
curl --request POST \
--url https://{receiverHost}/v1/ingest/audio-url \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"workspace_id": "<string>",
"external_conversation_id": "<string>",
"revision": "<string>",
"pricing_tier": "standard",
"requested_definition_version_ids": []
}
'import requests
url = "https://{receiverHost}/v1/ingest/audio-url"
payload = {
"url": "<string>",
"workspace_id": "<string>",
"external_conversation_id": "<string>",
"revision": "<string>",
"pricing_tier": "standard",
"requested_definition_version_ids": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
workspace_id: '<string>',
external_conversation_id: '<string>',
revision: '<string>',
pricing_tier: 'standard',
requested_definition_version_ids: []
})
};
fetch('https://{receiverHost}/v1/ingest/audio-url', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{receiverHost}/v1/ingest/audio-url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'workspace_id' => '<string>',
'external_conversation_id' => '<string>',
'revision' => '<string>',
'pricing_tier' => 'standard',
'requested_definition_version_ids' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{receiverHost}/v1/ingest/audio-url"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"external_conversation_id\": \"<string>\",\n \"revision\": \"<string>\",\n \"pricing_tier\": \"standard\",\n \"requested_definition_version_ids\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{receiverHost}/v1/ingest/audio-url")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"external_conversation_id\": \"<string>\",\n \"revision\": \"<string>\",\n \"pricing_tier\": \"standard\",\n \"requested_definition_version_ids\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{receiverHost}/v1/ingest/audio-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"external_conversation_id\": \"<string>\",\n \"revision\": \"<string>\",\n \"pricing_tier\": \"standard\",\n \"requested_definition_version_ids\": []\n}"
response = http.request(request)
puts response.read_body{
"interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replayed": true,
"inputRevision": "<string>",
"transcriptRevision": "<string>",
"mediaAssetId": "<string>",
"transcriptionWorkflowId": "<string>"
}{
"interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replayed": true,
"inputRevision": "<string>",
"transcriptRevision": "<string>",
"mediaAssetId": "<string>",
"transcriptionWorkflowId": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Personal or organization scoped ingest key from Build
Headers
Stable key for uncertain retries
Maximum string length:
256Workspace selection before audio transfer
Body
application/json
Public HTTPS audio URL, no userinfo or fragment
Maximum string length:
512Chosen per submission. Reserved work starts weekends or 7 p.m.–7 a.m. America/New_York. Keep the same tier on idempotent retries.
Available options:
standard, reserved ⌘I
Import a public audio URL
curl --request POST \
--url https://{receiverHost}/v1/ingest/audio-url \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"workspace_id": "<string>",
"external_conversation_id": "<string>",
"revision": "<string>",
"pricing_tier": "standard",
"requested_definition_version_ids": []
}
'import requests
url = "https://{receiverHost}/v1/ingest/audio-url"
payload = {
"url": "<string>",
"workspace_id": "<string>",
"external_conversation_id": "<string>",
"revision": "<string>",
"pricing_tier": "standard",
"requested_definition_version_ids": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
workspace_id: '<string>',
external_conversation_id: '<string>',
revision: '<string>',
pricing_tier: 'standard',
requested_definition_version_ids: []
})
};
fetch('https://{receiverHost}/v1/ingest/audio-url', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{receiverHost}/v1/ingest/audio-url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'workspace_id' => '<string>',
'external_conversation_id' => '<string>',
'revision' => '<string>',
'pricing_tier' => 'standard',
'requested_definition_version_ids' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{receiverHost}/v1/ingest/audio-url"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"external_conversation_id\": \"<string>\",\n \"revision\": \"<string>\",\n \"pricing_tier\": \"standard\",\n \"requested_definition_version_ids\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{receiverHost}/v1/ingest/audio-url")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"external_conversation_id\": \"<string>\",\n \"revision\": \"<string>\",\n \"pricing_tier\": \"standard\",\n \"requested_definition_version_ids\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{receiverHost}/v1/ingest/audio-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"external_conversation_id\": \"<string>\",\n \"revision\": \"<string>\",\n \"pricing_tier\": \"standard\",\n \"requested_definition_version_ids\": []\n}"
response = http.request(request)
puts response.read_body{
"interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replayed": true,
"inputRevision": "<string>",
"transcriptRevision": "<string>",
"mediaAssetId": "<string>",
"transcriptionWorkflowId": "<string>"
}{
"interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"replayed": true,
"inputRevision": "<string>",
"transcriptRevision": "<string>",
"mediaAssetId": "<string>",
"transcriptionWorkflowId": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}