Speakers
Create speaker
Creates a speaker in your organization
POST
/
speakers
Create speaker
curl --request POST \
--url https://api.beyondwords.io/v1/speakers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg"
}
'import requests
url = "https://api.beyondwords.io/v1/speakers"
payload = {
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg"
}
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({
first_name: 'Jane',
last_name: 'Doe',
avatar_url: 'https://example.com/avatar.jpg'
})
};
fetch('https://api.beyondwords.io/v1/speakers', 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/speakers",
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([
'first_name' => 'Jane',
'last_name' => 'Doe',
'avatar_url' => 'https://example.com/avatar.jpg'
]),
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/speakers"
payload := strings.NewReader("{\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"avatar_url\": \"https://example.com/avatar.jpg\"\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/speakers")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"avatar_url\": \"https://example.com/avatar.jpg\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/speakers")
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 \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"avatar_url\": \"https://example.com/avatar.jpg\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg",
"created": "2023-12-31T00:00:00.000Z",
"updated": "2023-12-31T00:00:00.000Z",
"custom_voices": [
{
"id": 1
},
{
"name": "Jane"
},
{
"script_ids": [
123,
456
]
},
{
"cloning_status": "script-preparation"
},
{
"created": "2023-12-31T00:00:00.000Z"
},
{
"updated": "2023-12-31T00:00:00.000Z"
}
],
"voices": [
{
"id": 1
},
{
"name": "Jane"
}
]
}Authorizations
Query Parameters
The level of detail to show for custom_voices in the response: 'none' or 'partial'
Available options:
partial Body
application/json
Response
201 - application/json
successful
Unique identifier for the object
The first name of the speaker
The last name of the speaker
The image URL of the speaker
Time at which the object was created (ISO 8601)
Time at which the object was updated (ISO 8601)
The custom voices for the speaker
Show child attributes
Show child attributes
The voices for the speaker
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Create speaker
curl --request POST \
--url https://api.beyondwords.io/v1/speakers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg"
}
'import requests
url = "https://api.beyondwords.io/v1/speakers"
payload = {
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg"
}
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({
first_name: 'Jane',
last_name: 'Doe',
avatar_url: 'https://example.com/avatar.jpg'
})
};
fetch('https://api.beyondwords.io/v1/speakers', 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/speakers",
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([
'first_name' => 'Jane',
'last_name' => 'Doe',
'avatar_url' => 'https://example.com/avatar.jpg'
]),
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/speakers"
payload := strings.NewReader("{\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"avatar_url\": \"https://example.com/avatar.jpg\"\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/speakers")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"avatar_url\": \"https://example.com/avatar.jpg\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/speakers")
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 \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"avatar_url\": \"https://example.com/avatar.jpg\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg",
"created": "2023-12-31T00:00:00.000Z",
"updated": "2023-12-31T00:00:00.000Z",
"custom_voices": [
{
"id": 1
},
{
"name": "Jane"
},
{
"script_ids": [
123,
456
]
},
{
"cloning_status": "script-preparation"
},
{
"created": "2023-12-31T00:00:00.000Z"
},
{
"updated": "2023-12-31T00:00:00.000Z"
}
],
"voices": [
{
"id": 1
},
{
"name": "Jane"
}
]
}