Conversations and messages
Add Conversation Keys
Adds (initializes or rotates) the encryption keys for a Chat conversation. Call this before sending messages in a new 1:1 conversation, and again with a newer key version to rotate the conversation key. For 1:1 conversations, provide the recipient’s user ID as the conversation id; the server constructs the canonical conversation ID from the authenticated user and recipient. The request body must contain the conversation key version and participant keys (the conversation key encrypted for each participant using their public key).
POST
/
2
/
chat
/
conversations
/
{id}
/
keys
Add Conversation Keys
curl --request POST \
--url https://api.x.com/2/chat/conversations/{id}/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_key_version": "<string>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"base64_encoded_key_rotation": "<string>"
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}/keys"
payload = {
"conversation_key_version": "<string>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"base64_encoded_key_rotation": "<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({
conversation_key_version: '<string>',
conversation_participant_keys: [
{
encrypted_conversation_key: '<string>',
public_key_version: '<string>',
user_id: '<string>'
}
],
action_signatures: [
{
encoded_message_event_detail: '<string>',
message_event_signature: {
public_key_version: '<string>',
signature: '<string>',
signature_version: '<string>',
message_signing_key_info_list: [
{
member_id: '<string>',
public_key_version: '<string>',
signing_public_key: '<string>'
}
],
signing_public_key: '<string>'
},
message_id: '<string>',
signature_payload: '<string>'
}
],
base64_encoded_key_rotation: '<string>'
})
};
fetch('https://api.x.com/2/chat/conversations/{id}/keys', 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/conversations/{id}/keys",
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_key_version' => '<string>',
'conversation_participant_keys' => [
[
'encrypted_conversation_key' => '<string>',
'public_key_version' => '<string>',
'user_id' => '<string>'
]
],
'action_signatures' => [
[
'encoded_message_event_detail' => '<string>',
'message_event_signature' => [
'public_key_version' => '<string>',
'signature' => '<string>',
'signature_version' => '<string>',
'message_signing_key_info_list' => [
[
'member_id' => '<string>',
'public_key_version' => '<string>',
'signing_public_key' => '<string>'
]
],
'signing_public_key' => '<string>'
],
'message_id' => '<string>',
'signature_payload' => '<string>'
]
],
'base64_encoded_key_rotation' => '<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/chat/conversations/{id}/keys"
payload := strings.NewReader("{\n \"conversation_key_version\": \"<string>\",\n \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"base64_encoded_key_rotation\": \"<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/chat/conversations/{id}/keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_key_version\": \"<string>\",\n \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"base64_encoded_key_rotation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}/keys")
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_key_version\": \"<string>\",\n \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"base64_encoded_key_rotation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"conversation_id": "<string>",
"sequence_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.
FlowAuthorization Code
- Authorization URL
- https://api.x.com/2/oauth2/authorize
- Token URL
- https://api.x.com/2/oauth2/token
Scopes3
tweet.read
View all posts you can see, including those from protected accounts.
dm.write
Send and manage your Direct Messages.
users.read
View any account you can see, including protected accounts.
Path Parameters
Pattern:
^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$Body
application/json
Version of the conversation encryption key (typically a timestamp in milliseconds).
Encrypted conversation keys for each participant.
Show child attributes
Show child attributes
Cryptographic signatures for the action.
Show child attributes
Show child attributes
Base64-encoded key rotation payload for ratchet tree key management.
⌘I
Add Conversation Keys
curl --request POST \
--url https://api.x.com/2/chat/conversations/{id}/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_key_version": "<string>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"base64_encoded_key_rotation": "<string>"
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}/keys"
payload = {
"conversation_key_version": "<string>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"action_signatures": [
{
"encoded_message_event_detail": "<string>",
"message_event_signature": {
"public_key_version": "<string>",
"signature": "<string>",
"signature_version": "<string>",
"message_signing_key_info_list": [
{
"member_id": "<string>",
"public_key_version": "<string>",
"signing_public_key": "<string>"
}
],
"signing_public_key": "<string>"
},
"message_id": "<string>",
"signature_payload": "<string>"
}
],
"base64_encoded_key_rotation": "<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({
conversation_key_version: '<string>',
conversation_participant_keys: [
{
encrypted_conversation_key: '<string>',
public_key_version: '<string>',
user_id: '<string>'
}
],
action_signatures: [
{
encoded_message_event_detail: '<string>',
message_event_signature: {
public_key_version: '<string>',
signature: '<string>',
signature_version: '<string>',
message_signing_key_info_list: [
{
member_id: '<string>',
public_key_version: '<string>',
signing_public_key: '<string>'
}
],
signing_public_key: '<string>'
},
message_id: '<string>',
signature_payload: '<string>'
}
],
base64_encoded_key_rotation: '<string>'
})
};
fetch('https://api.x.com/2/chat/conversations/{id}/keys', 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/conversations/{id}/keys",
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_key_version' => '<string>',
'conversation_participant_keys' => [
[
'encrypted_conversation_key' => '<string>',
'public_key_version' => '<string>',
'user_id' => '<string>'
]
],
'action_signatures' => [
[
'encoded_message_event_detail' => '<string>',
'message_event_signature' => [
'public_key_version' => '<string>',
'signature' => '<string>',
'signature_version' => '<string>',
'message_signing_key_info_list' => [
[
'member_id' => '<string>',
'public_key_version' => '<string>',
'signing_public_key' => '<string>'
]
],
'signing_public_key' => '<string>'
],
'message_id' => '<string>',
'signature_payload' => '<string>'
]
],
'base64_encoded_key_rotation' => '<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/chat/conversations/{id}/keys"
payload := strings.NewReader("{\n \"conversation_key_version\": \"<string>\",\n \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"base64_encoded_key_rotation\": \"<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/chat/conversations/{id}/keys")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_key_version\": \"<string>\",\n \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"base64_encoded_key_rotation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}/keys")
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_key_version\": \"<string>\",\n \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"action_signatures\": [\n {\n \"encoded_message_event_detail\": \"<string>\",\n \"message_event_signature\": {\n \"public_key_version\": \"<string>\",\n \"signature\": \"<string>\",\n \"signature_version\": \"<string>\",\n \"message_signing_key_info_list\": [\n {\n \"member_id\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"signing_public_key\": \"<string>\"\n }\n ],\n \"signing_public_key\": \"<string>\"\n },\n \"message_id\": \"<string>\",\n \"signature_payload\": \"<string>\"\n }\n ],\n \"base64_encoded_key_rotation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"conversation_id": "<string>",
"sequence_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>"
}