Background music settings
Create background tracks
Creates a background track in your organization.
POST
/
background_tracks
Create background track
curl --request POST \
--url https://api.beyondwords.io/v1/background_tracks \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"project": {
"id": 1
},
"name": "Test track 1",
"media": {
"url": "https://example.com/transcoded.mp3"
}
}
'import requests
url = "https://api.beyondwords.io/v1/background_tracks"
payload = {
"project": { "id": 1 },
"name": "Test track 1",
"media": { "url": "https://example.com/transcoded.mp3" }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project: {id: 1},
name: 'Test track 1',
media: {url: 'https://example.com/transcoded.mp3'}
})
};
fetch('https://api.beyondwords.io/v1/background_tracks', 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://api.beyondwords.io/v1/background_tracks",
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([
'project' => [
'id' => 1
],
'name' => 'Test track 1',
'media' => [
'url' => 'https://example.com/transcoded.mp3'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://api.beyondwords.io/v1/background_tracks"
payload := strings.NewReader("{\n \"project\": {\n \"id\": 1\n },\n \"name\": \"Test track 1\",\n \"media\": {\n \"url\": \"https://example.com/transcoded.mp3\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://api.beyondwords.io/v1/background_tracks")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project\": {\n \"id\": 1\n },\n \"name\": \"Test track 1\",\n \"media\": {\n \"url\": \"https://example.com/transcoded.mp3\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/background_tracks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project\": {\n \"id\": 1\n },\n \"name\": \"Test track 1\",\n \"media\": {\n \"url\": \"https://example.com/transcoded.mp3\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Test track 1",
"volume": 100,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}Authorizations
Body
application/json
Response
201 - application/json
successful
Unique identifier for the object
The background track name
Percent volume of the track
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Time at which the object was created (ISO 8601)
Time at which the object was updated (ISO 8601)
Was this page helpful?
⌘I
Create background track
curl --request POST \
--url https://api.beyondwords.io/v1/background_tracks \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"project": {
"id": 1
},
"name": "Test track 1",
"media": {
"url": "https://example.com/transcoded.mp3"
}
}
'import requests
url = "https://api.beyondwords.io/v1/background_tracks"
payload = {
"project": { "id": 1 },
"name": "Test track 1",
"media": { "url": "https://example.com/transcoded.mp3" }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project: {id: 1},
name: 'Test track 1',
media: {url: 'https://example.com/transcoded.mp3'}
})
};
fetch('https://api.beyondwords.io/v1/background_tracks', 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://api.beyondwords.io/v1/background_tracks",
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([
'project' => [
'id' => 1
],
'name' => 'Test track 1',
'media' => [
'url' => 'https://example.com/transcoded.mp3'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://api.beyondwords.io/v1/background_tracks"
payload := strings.NewReader("{\n \"project\": {\n \"id\": 1\n },\n \"name\": \"Test track 1\",\n \"media\": {\n \"url\": \"https://example.com/transcoded.mp3\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://api.beyondwords.io/v1/background_tracks")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project\": {\n \"id\": 1\n },\n \"name\": \"Test track 1\",\n \"media\": {\n \"url\": \"https://example.com/transcoded.mp3\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/background_tracks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project\": {\n \"id\": 1\n },\n \"name\": \"Test track 1\",\n \"media\": {\n \"url\": \"https://example.com/transcoded.mp3\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Test track 1",
"volume": 100,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}