X Chat API is one of 23 APIs that X publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
16 operations
across 16 paths,
and defines 103 schemas.
It is described by OpenAPI 3.2.0, at version 2.168.
Requests are made against a single base URL, https://api.x.com.
The identity and technical contract details declared by the specification.
AddConversationKeysActionSignaturesMessageEventSignature
object
5 properties
3 required
FieldHydrationFailureProblem
object
7 properties
4 required
CreateChatConversationActionSignatures
object
4 properties
3 required
DeleteChatMessagesActionSignaturesMessageEventSignature
object
5 properties
3 required
UserWithheld
object
Withholding details for withheld content.
2 properties
Error
object
2 properties
2 required
ResourceUnavailableProblem
object
6 properties
4 required
MarkChatConversationReadResponseData
object
1 property
1 required
AddChatGroupMembersActionSignaturesMessageEventSignatureMessageSigningKeyInfoList
object
3 properties
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
PostMediaMetadata
array
Metadata for media attached to this Post.
CreateChatConversationConversationParticipantKeys
object
3 properties
InternalErrorProblem
object
4 properties
3 required
AddUserPublicKeyResponse
object
2 properties
PostEditControls
object
Indicates how much longer (if at all) this Post can be edited.
3 properties
AddConversationKeysResponseData
object
2 properties
UserAffiliation
object
Metadata about a user's affiliation.
4 properties
UserSubscription
object
The subscription relationship between this User and you.
1 property
1 required
DeleteChatMessagesActionSignatures
object
4 properties
3 required
CreateChatConversationActionSignaturesMessageEventSignatureMessageSigningKeyInfoList
object
3 properties
AddConversationKeysConversationParticipantKeys
object
3 properties
InitializeChatGroupResponse
object
2 properties
AddChatGroupMembersConversationParticipantKeys
object
3 properties
GetChatConversationEventsResponse
object
3 properties
DeleteChatMessagesRequest
object
4 properties
3 required
DeleteChatMessagesResponseData
object
1 property
1 required
PostReferencedPosts
array
A list of Posts this Post refers to. If the Post is a Retweet, Quote or Reply, it includes the referenced Post's type and ID.
CreateChatConversationResponseData
object
2 properties
1 required
PostNotePost
object
The full content of the Post, including text beyond 280 characters.
2 properties
1 required
UserId
string
Unique identifier of a User
SendChatTypingIndicatorResponse
object
2 properties
GetChatConversationsResponse
object
4 properties
PostScopes
object
The scopes for this Post.
1 property
1 required
DisallowedResourceProblem
object
7 properties
3 required
PostSuggestedSourceLinksWithCounts
array
Suggested source URLs for this Post, each with the number of times it was suggested.
AddConversationKeysActionSignatures
object
4 properties
3 required
Topic
object
3 properties
ChatMediaUploadFinalizeRequest
object
5 properties
3 required
SendChatMessageResponse
object
2 properties
InitializeChatGroupResponseData
object
1 property
1 required
MarkChatConversationReadRequest
object
1 property
1 required
CreateChatConversationRequest
object
11 properties
4 required
PlaceContainedWithin
array
A list of unique identifiers of the Places that contain this place.
MediaPublicMetrics
object
Public engagement metrics for the media at the time of the request.
1 property
1 required
PostDisplayTextRange
array
The inclusive start and exclusive end indices of the displayable content of the Post.
Expansions
object
6 properties
AddConversationKeysRequest
object
4 properties
2 required
PostGeo
object
The location tagged on the Post, if the user provided one.
2 properties
ChatMediaUploadFinalizeResponseData
object
1 property
1 required
ChatMediaUploadInitializeResponseData
object
3 properties
3 required
AddUserPublicKeyRequest
object
3 properties
2 required
PostEntities
object
A list of metadata entities (hashtags, mentions, URLs) found in the Post text.
4 properties
MediaVariants
array
Each media object may have multiple display or playback variants, with different resolutions or formats.
ChatConversation
object
13 properties
ChatMediaUploadInitializeRequest
object
2 properties
2 required
NotAuthorizedForFieldProblem
object
10 properties
4 required
PostNoteRequestSuggestions
array
Community-Notes request suggestions for this Post.
MediaPromotedMetrics
object
Promoted nonpublic engagement metrics for the media at the time of the request.
6 properties
GetChatConversationResponse
object
3 properties
ChatMediaUploadAppendRequest
object
4 properties
4 required
AddConversationKeysActionSignaturesMessageEventSignatureMessageSigningKeyInfoList
object
3 properties
User
object
28 properties
AddChatGroupMembersResponse
object
2 properties
ChatMediaUploadFinalizeResponse
object
2 properties
UserPublicMetrics
object
A list of metrics for this User.
6 properties
4 required
Place
object
8 properties
ChatMessageEvent
object
9 properties
CreateChatConversationActionSignaturesMessageEventSignature
object
5 properties
3 required
ChatMediaUploadAppendResponseData
object
1 property
AddUserPublicKeyResponseData
object
2 properties
PostPublicMetrics
object
Engagement metrics for the Post at the time of the request.
6 properties
6 required
DeleteChatMessagesResponse
object
2 properties
Media
object
13 properties
ChatMediaUploadInitializeResponse
object
2 properties
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
NotAuthorizedForResourceProblem
object
9 properties
4 required
SendChatMessageRequest
object
4 properties
2 required
AddConversationKeysResponse
object
2 properties
AddChatGroupMembersRequest
object
6 properties
1 required
SendChatMessageResponseData
object
1 property
1 required
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
UserConnectionStatus
array
Returns detailed information about the relationship between two users.
Post
object
36 properties
SendChatTypingIndicatorResponseData
object
1 property
1 required
InvalidRequestProblem
object
6 properties
3 required
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
PostContextAnnotations
array
Annotations inferred about the Post (domain and entity context).
AddUserPublicKeyPublicKey
object
6 properties
PollOptions
array
The list of options (choices) available in this poll.
DeleteChatMessagesActionSignaturesMessageEventSignatureMessageSigningKeyInfoList
object
3 properties
ChatMediaUploadAppendResponse
object
2 properties
PlaceGeo
object
The geographic location of this place, expressed as a GeoJSON Feature.
3 properties
3 required
MarkChatConversationReadResponse
object
2 properties
AddChatGroupMembersActionSignaturesMessageEventSignature
object
5 properties
3 required
PostWithheld
object
Withholding details for withheld content.
3 properties
2 required
MediaOrganicMetrics
object
Organic nonpublic engagement metrics for the media at the time of the request.
6 properties
CreateChatConversationResponse
object
2 properties
ResourceNotFoundProblem
object
8 properties
4 required
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
AddChatGroupMembersActionSignatures
object
4 properties
3 required
FieldUnauthorizedProblem
object
7 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs X publishes across the network.
