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