Append Chat Media Upload

Appends media data to an XChat upload session.

POST /2/chat/media/upload/{id}/append

Append Chat Media Upload

cURL

curl --request POST \
  --url https://api.x.com/2/chat/media/upload/{id}/append \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversation_id": "<string>",
  "media": "<string>",
  "media_hash_key": "<string>",
  "segment_index": 499
}
'

import requests

url = "https://api.x.com/2/chat/media/upload/{id}/append"

payload = {
    "conversation_id": "<string>",
    "media": "<string>",
    "media_hash_key": "<string>",
    "segment_index": 499
}
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({
    conversation_id: '<string>',
    media: '<string>',
    media_hash_key: '<string>',
    segment_index: 499
  })
};

fetch('https://api.x.com/2/chat/media/upload/{id}/append', 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/chat/media/upload/{id}/append",
  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([
    'conversation_id' => '<string>',
    'media' => '<string>',
    'media_hash_key' => '<string>',
    'segment_index' => 499
  ]),
  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/chat/media/upload/{id}/append"

	payload := strings.NewReader("{\n  \"conversation_id\": \"<string>\",\n  \"media\": \"<string>\",\n  \"media_hash_key\": \"<string>\",\n  \"segment_index\": 499\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/chat/media/upload/{id}/append")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversation_id\": \"<string>\",\n  \"media\": \"<string>\",\n  \"media_hash_key\": \"<string>\",\n  \"segment_index\": 499\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/chat/media/upload/{id}/append")

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  \"conversation_id\": \"<string>\",\n  \"media\": \"<string>\",\n  \"media_hash_key\": \"<string>\",\n  \"segment_index\": 499\n}"

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

200

{
  "data": {
    "expires_at": 123
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

{
  "code": 123,
  "message": "<string>"
}

Authorizations

OAuth2UserTokenUserToken

Authorization · string · header · required

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

Path Parameters

id · string · required

The session/resume id from initialize.

Body

application/jsonmultipart/form-data

Option 1

Option 2

conversation_id · string · required

XChat conversation identifier for the upload.

media · file · required

The file to upload.

media_hash_key · string · required

Media hash key returned from initialize.

segment_index · integer<int32> string<integer> · required

An integer value representing the media upload segment.

Required range: 0 <= x <= 999

Response

200

application/json

The request has succeeded.

A response from getting a media upload request status.

data · object

Show child attributes

errors · object[]

Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

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

Show child attributes