Initialize media upload

POST

media

upload

initialize

curl --request POST \
  --url https://api.x.com/2/media/upload/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_owners": [
    "<string>"
  ],
  "shared": true,
  "total_bytes": 8589934592
}
'

import requests

url = "https://api.x.com/2/media/upload/initialize"

payload = {
    "additional_owners": ["<string>"],
    "shared": True,
    "total_bytes": 8589934592
}
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({additional_owners: ['<string>'], shared: true, total_bytes: 8589934592})
};

fetch('https://api.x.com/2/media/upload/initialize', 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/media/upload/initialize",
  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([
    'additional_owners' => [
        '<string>'
    ],
    'shared' => true,
    'total_bytes' => 8589934592
  ]),
  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/media/upload/initialize"

	payload := strings.NewReader("{\n  \"additional_owners\": [\n    \"<string>\"\n  ],\n  \"shared\": true,\n  \"total_bytes\": 8589934592\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/media/upload/initialize")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additional_owners\": [\n    \"<string>\"\n  ],\n  \"shared\": true,\n  \"total_bytes\": 8589934592\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/media/upload/initialize")

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  \"additional_owners\": [\n    \"<string>\"\n  ],\n  \"shared\": true,\n  \"total_bytes\": 8589934592\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "expires_after_secs": 123,
    "media_key": "<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

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

additional_owners

string[]

User ids granted access to the uploaded media.

Pattern: ^[0-9]{1,19}$

media_category

enum<string>

The media category of the upload.

Available options:

amplify_video,

tweet_gif,

tweet_image,

tweet_video,

dm_gif,

dm_image,

dm_video,

subtitles

media_type

enum<string>

The type of media.

Available options:

video/mp4,

video/webm,

video/mp2t,

video/quicktime,

text/srt,

text/vtt,

image/jpeg,

image/gif,

image/bmp,

image/png,

image/webp,

image/pjpeg,

image/tiff,

model/gltf-binary,

model/vnd.usdz+zip

shared

boolean

Whether this media is shared or not.

total_bytes

integer

The total size of the media upload in bytes.

Required range: 0 <= x <= 17179869184

Response

The request has succeeded.

data

object

Show child attributes

errors

object[]

Show child attributes

Initialize media upload

curl --request POST \
  --url https://api.x.com/2/media/upload/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_owners": [
    "<string>"
  ],
  "shared": true,
  "total_bytes": 8589934592
}
'

import requests

url = "https://api.x.com/2/media/upload/initialize"

payload = {
    "additional_owners": ["<string>"],
    "shared": True,
    "total_bytes": 8589934592
}
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({additional_owners: ['<string>'], shared: true, total_bytes: 8589934592})
};

fetch('https://api.x.com/2/media/upload/initialize', 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/media/upload/initialize",
  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([
    'additional_owners' => [
        '<string>'
    ],
    'shared' => true,
    'total_bytes' => 8589934592
  ]),
  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/media/upload/initialize"

	payload := strings.NewReader("{\n  \"additional_owners\": [\n    \"<string>\"\n  ],\n  \"shared\": true,\n  \"total_bytes\": 8589934592\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/media/upload/initialize")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additional_owners\": [\n    \"<string>\"\n  ],\n  \"shared\": true,\n  \"total_bytes\": 8589934592\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/media/upload/initialize")

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  \"additional_owners\": [\n    \"<string>\"\n  ],\n  \"shared\": true,\n  \"total_bytes\": 8589934592\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "expires_after_secs": 123,
    "media_key": "<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>"
}

Overview

Posts

Articles

Users

Direct Messages

Likes

Lists

Spaces

Communities

Community Notes

Trends

News

Media

X Activity

Usage

Stream Connections

Compliance

Webhooks

Initialize media upload

Authorizations

Body

Response