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

X Bots API

The Bots surface of the X API v2. — 6 operation(s) in the X-published contract.

X Bots API is one of 24 APIs that X publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bots. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 62 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.

6 operations 3 paths 62 schemas 2 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.168
Base URL
https://api.x.com
Authentication
HTTP Bearer, OAuth 2.0, HTTP Oauth
Terms of Service
Resource Areas
1

Authentication & Security 3

X Bots 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 26 scopes. It uses HTTP oauth authentication (UserToken).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 2 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Bots 6
GET
/2/bots
Get Bots
getBots 3 params → 200default
POST
/2/bots
Create a bot
createBot body → 201default
DELETE
/2/bots/{id}
Delete Bot
deleteBot 1 param → 200default
PUT
/2/bots/{id}
Update Bot
updateBot 1 param body → 200default
DELETE
/2/bots/{id}/token
Revoke Bot Token
revokeBotToken 1 param → 200default
POST
/2/bots/{id}/token
Rotate Bot Token
rotateBotToken 1 param body → 200default

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Post (36 properties), User (28 properties), Media (13 properties), NotAuthorizedForFieldProblem (10 properties). Each schema is shown below with its type and property counts.

Media
object
13 properties
PostContextAnnotations
array
Annotations inferred about the Post (domain and entity context).
FieldHydrationFailureProblem
object
7 properties 4 required
PostEditControls
object
Indicates how much longer (if at all) this Post can be edited.
3 properties
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.
UpdateBotResponse
object
2 properties
MediaPromotedMetrics
object
Promoted nonpublic engagement metrics for the media at the time of the request.
6 properties
Place
object
8 properties
PostSuggestedSourceLinks
array
URLs suggested as sources for this Post.
InvalidRequestProblem
object
6 properties 3 required
CreateBotRequest
object
3 properties 1 required
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
RotateBotTokenRequest
object
1 property
PostMediaMetadata
array
Metadata for media attached to this Post.
MediaNonPublicMetrics
object
Nonpublic engagement metrics for the media at the time of the request.
5 properties
MediaPublicMetrics
object
Public engagement metrics for the media at the time of the request.
1 property 1 required
Error
object
2 properties 2 required
UserConnectionStatus
array
Returns detailed information about the relationship between two users.
FieldUnauthorizedProblem
object
7 properties 4 required
PostEntities
object
A list of metadata entities (hashtags, mentions, URLs) found in the Post text.
4 properties
UpdateBotResponseData
object
1 property 1 required
MediaVariants
array
Each media object may have multiple display or playback variants, with different resolutions or formats.
GetBotsResponse
object
4 properties
CreateBotResponse
object
2 properties
DeleteBotResponse
object
2 properties
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
Problem
Post
object
36 properties
Poll
object
5 properties
PostWithheld
object
Withholding details for withheld content.
3 properties 2 required
InternalErrorProblem
object
4 properties 3 required
PostNoteRequestSuggestions
array
Community-Notes request suggestions for this Post.
User
object
28 properties
RotateBotTokenResponseData
object
6 properties 2 required
PostScopes
object
The scopes for this Post.
1 property 1 required
RevokeBotTokenResponseData
object
1 property 1 required
PollOptions
array
The list of options (choices) available in this poll.
DisallowedResourceProblem
object
7 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.
CreateBotResponseData
object
6 properties 2 required
PostAttachments
object
Specifies the type of attachments (if any) present in this Post.
3 properties
Topic
object
3 properties
ResourceUnavailableProblem
object
6 properties 4 required
MediaOrganicMetrics
object
Organic nonpublic engagement metrics for the media at the time of the request.
6 properties
UserWithheld
object
Withholding details for withheld content.
2 properties
PostPublicMetrics
object
Engagement metrics for the Post at the time of the request.
6 properties 6 required
RevokeBotTokenResponse
object
2 properties
UserSubscription
object
The subscription relationship between this User and you.
1 property 1 required
PostDisplayTextRange
array
The inclusive start and exclusive end indices of the displayable content of the Post.
Expansions
object
6 properties
ResourceNotFoundProblem
object
8 properties 4 required
RotateBotTokenResponse
object
2 properties
PostMatchedMediaNotes
array
Community-Notes media matches for this Post.
UserEntities
object
A list of metadata found in the User's profile description.
2 properties
UserPublicMetrics
object
A list of metrics for this User.
6 properties 4 required
DeleteBotResponseData
object
1 property 1 required
NotAuthorizedForResourceProblem
object
9 properties 4 required
UpdateBotRequest
object
3 properties
NotAuthorizedForFieldProblem
object
10 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

x-bots-api-openapi.yml Raw ↑

Other APIs X publishes across the network.

X Account Activity API
X Account API
X Activity API
X Articles API
X Broadcasts API
X Chat API
X Communities API
X Community Notes API
X Compliance API
X Connections API
X Direct Messages API
X General API
Where this information came from

This is an independent, third-party profile of X Bots 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.