Go Live on a Source
Takes one of the authenticated user’s sources live and returns 201 with the new broadcast. The broadcast goes live immediately (state RUNNING), even before the encoder sends video, and is ended (TIMED_OUT) if no video arrives within 5 minutes. It is announced in a Post unless should_not_tweet is true. When the source already has a live broadcast, returns 200 with that broadcast unchanged and ignores the request’s title, locale, chat_option and should_not_tweet. A missing tweet_id means the Post hasn’t been created yet, was suppressed with should_not_tweet, or could not be created; read it later with GET /2/broadcasts/:id. A 409 conflict means the source can’t go live right now: either it can’t take video before the encoder connects (external HLS sources, or regions where this isn’t available), so retry once video is flowing, or another broadcast is live on it, so END that broadcast first. The detail says which, and names the live broadcast when known.
POST
/
2
/
broadcasts
Go Live on a Source
curl --request POST \
--url https://api.x.com/2/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_id": "<string>",
"chat_option": 3,
"locale": "<string>",
"should_not_tweet": true,
"title": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts"
payload = {
"source_id": "<string>",
"chat_option": 3,
"locale": "<string>",
"should_not_tweet": True,
"title": "<string>"
}
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({
source_id: '<string>',
chat_option: 3,
locale: '<string>',
should_not_tweet: true,
title: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts', 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.x.com/2/broadcasts",
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([
'source_id' => '<string>',
'chat_option' => 3,
'locale' => '<string>',
'should_not_tweet' => true,
'title' => '<string>'
]),
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://api.x.com/2/broadcasts"
payload := strings.NewReader("{\n \"source_id\": \"<string>\",\n \"chat_option\": 3,\n \"locale\": \"<string>\",\n \"should_not_tweet\": true,\n \"title\": \"<string>\"\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://api.x.com/2/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_id\": \"<string>\",\n \"chat_option\": 3,\n \"locale\": \"<string>\",\n \"should_not_tweet\": true,\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/broadcasts")
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 \"source_id\": \"<string>\",\n \"chat_option\": 3,\n \"locale\": \"<string>\",\n \"should_not_tweet\": true,\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"broadcast_id": "<string>",
"id": "<string>",
"share_url": "<string>",
"state": "<string>",
"chat_option": 123,
"language": "<string>",
"media_key": "<string>",
"start_ms": "<string>",
"title": "<string>",
"tweet_id": "<string>"
},
"errors": [
{
"detail": "<string>",
"resource_type": "<string>",
"title": "<string>",
"type": "https://api.x.com/2/problems/resource-not-found",
"parameter": "<string>",
"resource_id": "<string>",
"status": 123,
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}Authorizations
OAuth2UserTokenUserToken
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Id of the source to go live on: a source's id (19 digits) from GET /2/sources.
Who can chat: 0 default, 1 chat off, 2 everyone, 3 verified accounts, 4 accounts the host follows, 5 the host's subscribers, 6 accounts followed by an account the host follows.
Required range:
0 <= x <= 6Broadcast language, e.g. en.
Skip the Post announcing the broadcast. Defaults to false.
Broadcast title. Defaults to the user's display name.
Response
The request has succeeded.
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
- Option 44
- Option 45
- Option 46
- Option 47
- Option 48
- Option 49
- Option 50
- Option 51
- Option 52
- Option 53
- Option 54
- Option 55
- Option 56
- Option 57
- Option 58
- Option 59
- Option 60
- Option 61
Show child attributes
Show child attributes
⌘I
Go Live on a Source
curl --request POST \
--url https://api.x.com/2/broadcasts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_id": "<string>",
"chat_option": 3,
"locale": "<string>",
"should_not_tweet": true,
"title": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts"
payload = {
"source_id": "<string>",
"chat_option": 3,
"locale": "<string>",
"should_not_tweet": True,
"title": "<string>"
}
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({
source_id: '<string>',
chat_option: 3,
locale: '<string>',
should_not_tweet: true,
title: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts', 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.x.com/2/broadcasts",
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([
'source_id' => '<string>',
'chat_option' => 3,
'locale' => '<string>',
'should_not_tweet' => true,
'title' => '<string>'
]),
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://api.x.com/2/broadcasts"
payload := strings.NewReader("{\n \"source_id\": \"<string>\",\n \"chat_option\": 3,\n \"locale\": \"<string>\",\n \"should_not_tweet\": true,\n \"title\": \"<string>\"\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://api.x.com/2/broadcasts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_id\": \"<string>\",\n \"chat_option\": 3,\n \"locale\": \"<string>\",\n \"should_not_tweet\": true,\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/broadcasts")
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 \"source_id\": \"<string>\",\n \"chat_option\": 3,\n \"locale\": \"<string>\",\n \"should_not_tweet\": true,\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"broadcast_id": "<string>",
"id": "<string>",
"share_url": "<string>",
"state": "<string>",
"chat_option": 123,
"language": "<string>",
"media_key": "<string>",
"start_ms": "<string>",
"title": "<string>",
"tweet_id": "<string>"
},
"errors": [
{
"detail": "<string>",
"resource_type": "<string>",
"title": "<string>",
"type": "https://api.x.com/2/problems/resource-not-found",
"parameter": "<string>",
"resource_id": "<string>",
"status": 123,
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}