How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Twitter

X (Twitter) Chat API

The Chat API from X (Twitter) — 15 operation(s) for chat.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 16 operations across 15 paths, and defines 88 schemas. It is described by OpenAPI 3.2.0, at version 2.161.

Requests are made against a single base URL, https://api.x.com.

16 operations 15 paths 88 schemas 5 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.161
Base URL
https://api.x.com/2
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Contact
X Developers
License
X Developer Agreement and Policy
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

X (Twitter) Chat API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerToken). It supports OAuth 2.0 (OAuth2UserToken) using the authorizationCode flow, exposing 21 scopes. It uses HTTP oauth authentication (UserToken).

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 5 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Chat 16
GET
/2/chat/conversations
X Get Chat Conversations
getChatConversations 5 params → 200default
POST
/2/chat/conversations/group
X Create Chat Group Conversation
createChatConversation body → 201default
POST
/2/chat/conversations/group/initialize
X Initialize Chat Group
initializeChatGroup → 200default
GET
/2/chat/conversations/{id}
X Get Chat Conversation
getChatConversation 4 params → 200default
POST
/2/chat/conversations/{id}/keys
X Initialize Conversation Keys
initializeChatConversationKeys 1 param body → 200default
POST
/2/chat/conversations/{id}/members
X Add Members to a Chat Group Conversation
addChatGroupMembers 1 param body → 200default
POST
/2/chat/conversations/{id}/messages
X Send Chat Message
sendChatMessage 1 param body → 201default
POST
/2/chat/conversations/{id}/read
X Mark Conversation as Read
markChatConversationRead 1 param body → 200default
POST
/2/chat/conversations/{id}/typing
X Send Typing Indicator
sendChatTypingIndicator 1 param → 200default
POST
/2/chat/media/upload/initialize
X Initialize Chat Media Upload
chatMediaUploadInitialize body → 200default
POST
/2/chat/media/upload/{id}/append
X Append Chat Media Upload
chatMediaUploadAppend 1 param body → 200default
POST
/2/chat/media/upload/{id}/finalize
X Finalize Chat Media Upload
chatMediaUploadFinalize 1 param body → 200default
GET
/2/chat/media/{id}/{media_hash_key}
X Download Chat Media
chatMediaDownload 2 params → 200default
GET
/2/users/public_keys
X Get Public Keys for Multiple Users
getUsersPublicKeys 2 params → 200default
GET
/2/users/{id}/public_keys
X Get User Public Keys
getUsersPublicKey 2 params → 200default
POST
/2/users/{id}/public_keys
X Add Public Key
addUserPublicKey 1 param body → 200default

Schemas 88

The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are Tweet (29 properties), User (21 properties), ChatConversation (13 properties), ChatCreateConversationRequest (11 properties). Each schema is shown below with its type and property counts.

ChatJuiceboxConfig
object
Key recovery configuration for Juicebox-based key storage.
6 properties
Get2UsersIdPublicKeysResponse
object
2 properties
ChatConversationOrRecipientId
string
Identifies the conversation target. Accepts three formats: (1) a recipient user ID for 1:1 conversations (e.g., '1215441834412953600'), (2) a legacy 1:1 conver…
Get2UsersPublicKeysResponse
object
2 properties
ChatSendMessageResponse
object
2 properties
HashtagEntity
UserName
string
The X handle (screen name) of this user.
ChatConversation
object
A Chat conversation resource representing either a direct or group conversation.
13 properties 1 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
ChatSendMessageRequest
object
4 properties 2 required
MediaSegments
EntityIndicesInclusiveExclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties 2 required
User
object
The X User object.
21 properties 3 required
ChatInitializeConversationKeysRequest
object
4 properties 2 required
ChatSendTypingIndicatorResponse
object
2 properties
MediaUploadAppendResponse
object
A response from getting a media upload request status.
2 properties 1 required
MediaPayloadByte
string
The file to upload.
HttpStatusCode
integer
HTTP Status Code.
PollOption
object
Describes a choice in a Poll object.
3 properties 3 required
ChatInitializeGroupResponse
object
2 properties
CommunityId
string
The unique identifier of this Community.
PlaceId
string
The identifier for this place.
ChatMediaUploadFinalizeRequest
object
Request body for finalizing a Chat media upload.
5 properties
NoteTweetText
string
The note content of the Tweet.
ChatMessageSigningKeyInfo
object
Signing key information for message verification.
3 properties
ChatConversationParticipantKey
object
A participant's encrypted conversation key.
3 properties
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties 1 required
MentionEntity
PlaceType
string
DisplayTextRange
array
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start i…
ChatGetConversationResponse
object
3 properties
ChatMarkConversationReadRequest
object
1 property 1 required
PublicKey
object
Public key information for Chat encryption
4 properties
EntityIndicesInclusiveInclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties 2 required
Error
object
2 properties 2 required
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties 2 required
MediaHeight
integer
The height of the media in pixels.
ChatMessageEvent
object
An Chat message event with extracted envelope fields and the original encoded event.
10 properties 1 required
FullTextEntities
object
5 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
BinaryPayload
string
Raw binary data bytes.
ChatMediaUploadInitializeRequest
object
Request body for initializing a Chat media upload.
2 properties
ChatMediaUploadFinalizeResponse
object
Response from finalizing a Chat media upload.
1 property
ChatAddGroupMembersRequest
object
6 properties 1 required
ChatGetConversationsResponse
object
4 properties
MediaKey
string
The Media Key identifier for this attachment.
PollOptionLabel
string
The text of a poll choice.
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property 1 required
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties 1 required
ChatMessageEventSignature
object
Message event signature for verification.
5 properties
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties 1 required
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property 1 required
ChatMediaUploadInitializeResponse
object
Response from initializing a Chat media upload.
1 property
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
MediaPayloadBinary
string
The file to upload.
Expansions
object
6 properties
TopicId
string
Unique identifier of this Topic.
ChatActionSignature
object
Cryptographic signature for a chat action.
4 properties
MediaWidth
integer
The width of the media in pixels.
Place
object
8 properties 2 required
ChatPublicKey
object
A user's public key with associated key recovery configuration.
4 properties
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties 1 required
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties 1 required
Topic
object
The topic of a Space, as selected by its creator.
3 properties 2 required
MediaHashKey
string
The media hash key returned from the upload initialize step. Alphanumeric characters only.
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
ChatCreateConversationResponse
object
2 properties
Media
object
4 properties 1 required
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties 2 required
CashtagEntity
ChatMediaUploadAppendRequest
TweetId
string
Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
ChatMarkConversationReadResponse
object
2 properties
Url
string
A validly formatted URL.
ChatAddPublicKeyResponse
object
2 properties
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties 2 required
UrlImage
object
Represent the information for the URL image.
3 properties
Poll
object
Represent a Poll attached to a Tweet.
5 properties 2 required
Geo
object
4 properties 3 required
ChatAddGroupMembersResponse
object
2 properties
ChatCreateConversationRequest
object
11 properties 4 required
ChatInitializeConversationKeysResponse
object
2 properties
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties 2 required
ChatAddPublicKeyRequest
object
3 properties 2 required
TweetText
string
The content of the Tweet.
PollId
string
Unique identifier of this poll.
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
Tweet
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twitter-chat-api-openapi.yml Raw ↑
#Chat
← Back to X APIs
API Details
ID
twitter:twitter-chat-api
Base URL
https://api.x.com/2
Docs
https://docs.x.com/x-api
Provider
Twitter
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=twitter-chat-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/twitter-chat-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of X (Twitter) Chat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.