{ "openapi": "3.0.0", "info": { "description": "X API v2 core endpoints", "version": "2.167", "title": "X API v2", "termsOfService": "https://developer.x.com/en/developer-terms/agreement-and-policy.html", "contact": { "name": "X Developers", "url": "https://developer.x.com/" }, "license": { "name": "X Developer Agreement and Policy", "url": "https://developer.x.com/en/developer-terms/agreement-and-policy.html" } }, "paths": { "/2/account_activity/subscriptions/count": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Account Activity" ], "summary": "Get Account Activity Subscription Count", "operationId": "getAccountActivitySubscriptionCount", "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountActivitySubscriptionCountResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/account_activity/webhooks/{webhook_id}/subscriptions/all": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "dm.read", "dm.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Account Activity" ], "summary": "Validate Account Activity Subscription", "operationId": "validateAccountActivitySubscription", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookConfigId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAccountActivitySubscriptionResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "dm.read", "users.read", "dm.write" ] }, { "UserToken": [] } ], "tags": [ "Account Activity" ], "summary": "Create subscription", "description": "Creates an Account Activity subscription for the user and the given webhook.", "externalDocs": { "url": "https://docs.x.com/x-api/account-activity/introduction" }, "operationId": "createAccountActivitySubscription", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookConfigId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountActivitySubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountActivitySubscriptionResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/account_activity/webhooks/{webhook_id}/subscriptions/all/list": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Account Activity" ], "summary": "Get Account Activity Subscriptions", "operationId": "getAccountActivitySubscriptions", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookConfigId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountActivitySubscriptionsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/account_activity/webhooks/{webhook_id}/subscriptions/{user_id}/all": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Account Activity" ], "summary": "Delete subscription", "description": "Deletes an Account Activity subscription for the given webhook and user ID.", "externalDocs": { "url": "https://docs.x.com/x-api/account-activity/introduction" }, "operationId": "deleteAccountActivitySubscription", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/WebhookConfigId" }, "style": "simple" }, { "name": "user_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAccountActivitySubscriptionResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/activity/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Activity Stream", "description": "Stream of X Activities", "externalDocs": { "url": "https://docs.x.com/x-api/activity/activity-stream" }, "operationId": "activityStream", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the activities will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the activities will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStreamResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/activity/subscriptions": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Activity" ], "summary": "Delete X activity subscriptions by IDs", "description": "Deletes multiple subscriptions for X activity events by their IDs", "externalDocs": { "url": "https://docs.x.com/x-api/activity/delete-x-activity-subscriptions-by-ids" }, "operationId": "deleteActivitySubscriptionsByIds", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "explode": false, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteActivitySubscriptionsByIdsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "security": [ { "OAuth2UserToken": [ "like.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Activity" ], "summary": "Get X activity subscriptions", "description": "Get a list of active subscriptions for XAA", "externalDocs": { "url": "https://docs.x.com/x-api/activity/get-x-activity-subscriptions" }, "operationId": "getActivitySubscriptions", "parameters": [ { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActivitySubscriptionsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Activity" ], "summary": "Create X activity subscription", "description": "Creates a subscription for an X activity event. OAuth2 user-context tokens must hold the scope matching the requested event_type: dm.read for chat.* and dm.* events, like.read for like.* events, mute.read for mute.* events, block.read for block.* events, and tweet.read for all other event types. Mute and block subscriptions are actor-only: filter.user_id must identify the authenticated user and direction is not supported.", "externalDocs": { "url": "https://docs.x.com/x-api/activity/create-x-activity-subscription" }, "operationId": "createActivitySubscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActivitySubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActivitySubscriptionResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/activity/subscriptions/{subscription_id}": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Activity" ], "summary": "Deletes X activity subscription", "description": "Deletes a subscription for an X activity event", "externalDocs": { "url": "https://docs.x.com/x-api/activity/deletes-x-activity-subscription" }, "operationId": "deleteActivitySubscription", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteActivitySubscriptionResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "security": [ { "BearerToken": [] } ], "tags": [ "Activity" ], "summary": "Update X activity subscription", "description": "Updates a subscription for an X activity event", "externalDocs": { "url": "https://docs.x.com/x-api/activity/update-x-activity-subscription" }, "operationId": "updateActivitySubscription", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateActivitySubscriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateActivitySubscriptionResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/articles/draft": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Articles" ], "summary": "Create draft Article", "description": "Creates a new Article draft that can later be published.", "operationId": "articleCreateDraft", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleCreateDraftRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticleCreateDraftResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/articles/{article_id}/publish": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Articles" ], "summary": "Publish Article", "description": "Publishes a draft Article, making it publicly visible.", "operationId": "articlePublish", "parameters": [ { "name": "article_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticlePublishResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/broadcasts/scheduled": { "get": { "security": [ { "OAuth2UserToken": [ "broadcast.read" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "List scheduled broadcasts", "description": "Returns scheduled broadcasts owned by the authenticated user.", "operationId": "listScheduledBroadcasts", "parameters": [ { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "oldest_start_time", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "name": "newest_start_time", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListScheduledBroadcastsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "broadcast.write", "broadcast.read" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Create a scheduled broadcast", "description": "Schedules a one-off or recurring broadcast for the authenticated user. A `source_id` (ingest) is required at create time.", "operationId": "createScheduledBroadcast", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScheduledBroadcastRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScheduledBroadcastResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/broadcasts/scheduled/{id}": { "delete": { "security": [ { "OAuth2UserToken": [ "broadcast.write", "broadcast.read" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Delete a scheduled broadcast", "description": "Deletes a scheduled broadcast by its alphanumeric UBS broadcast id.", "operationId": "deleteScheduledBroadcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" }, { "name": "roll_forward", "in": "query", "required": false, "schema": { "type": "boolean" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteScheduledBroadcastResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "security": [ { "OAuth2UserToken": [ "broadcast.read" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Get a scheduled broadcast", "description": "Returns a single scheduled broadcast by its alphanumeric UBS broadcast id.", "operationId": "getScheduledBroadcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScheduledBroadcastResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "security": [ { "OAuth2UserToken": [ "broadcast.write", "broadcast.read" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Update a scheduled broadcast", "description": "Fully replaces schedule fields for a broadcast. Path `:id` is the UBS broadcast id; the body must include `scheduled_broadcast_id` and re-send any fields that should be kept.", "operationId": "updateScheduledBroadcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduledBroadcastRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduledBroadcastResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/broadcasts/scheduled/{id}/live": { "post": { "security": [ { "OAuth2UserToken": [ "broadcast.read", "broadcast.write" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Go live on a scheduled broadcast", "description": "Publishes a schedule that was created or updated with `manual_publish: true`. Without that flag the coordinator auto-publishes at start and this call is rejected.", "operationId": "goLiveScheduledBroadcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoLiveScheduledBroadcastResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/broadcasts/{id}": { "get": { "security": [ { "OAuth2UserToken": [ "broadcast.read" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Get a broadcast", "description": "Returns a broadcast owned by the authenticated user.", "operationId": "getBroadcast", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" }, { "$ref": "#/components/parameters/BroadcastFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBroadcastResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/broadcasts/{id}/chat": { "post": { "security": [ { "OAuth2UserToken": [ "broadcast.read", "broadcast.write" ] }, { "UserToken": [] } ], "tags": [ "Broadcasts" ], "summary": "Send a chat message to a live broadcast", "description": "Posts a chat message to a running broadcast, attributed to the authenticated user.", "operationId": "sendBroadcastChat", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBroadcastChatRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBroadcastChatResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations": { "get": { "security": [ { "OAuth2UserToken": [ "dm.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Get Chat Conversations", "description": "Retrieves a list of Chat conversations for the authenticated user's inbox.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "getChatConversations", "parameters": [ { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/ChatConversationFieldsParameter" }, { "$ref": "#/components/parameters/ChatConversationExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatConversationsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/group": { "post": { "security": [ { "OAuth2UserToken": [ "users.read", "dm.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Create Chat Group Conversation", "description": "Creates a new encrypted Chat group conversation on behalf of the authenticated user.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "createChatConversation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatConversationRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatConversationResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/group/initialize": { "post": { "security": [ { "OAuth2UserToken": [ "dm.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Initialize Chat Group", "description": "Initializes a new Chat group conversation and returns a unique conversation ID. Use the returned conversation_id in a subsequent POST /chat/conversations/group call to fully create and configure the group.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "initializeChatGroup", "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitializeChatGroupResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}": { "get": { "security": [ { "OAuth2UserToken": [ "dm.read", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Get Chat Conversation", "description": "Returns metadata for a Chat conversation including type, muted status, and group details. Use chat_conversation.fields to select which fields are returned. Use expansions to hydrate member, admin, or participant user objects. Use user.fields to control which profile fields are returned for expanded users.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "getChatConversation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "$ref": "#/components/parameters/ChatConversationFieldsParameter" }, { "$ref": "#/components/parameters/ChatConversationExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatConversationResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/events": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "dm.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Get Chat Conversation Events", "description": "Retrieves messages and key change events for a specific Chat conversation with pagination support. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "getChatConversationEvents", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/ChatMessageEventFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatConversationEventsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/keys": { "post": { "security": [ { "OAuth2UserToken": [ "users.read", "dm.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Add Conversation Keys", "description": "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).", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "addConversationKeys", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddConversationKeysRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddConversationKeysResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/members": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "dm.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Add members to a Chat group conversation", "description": "Adds one or more members to an existing encrypted Chat group conversation, rotating the conversation key.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "addChatGroupMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChatGroupMembersRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddChatGroupMembersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/messages": { "post": { "security": [ { "OAuth2UserToken": [ "dm.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Send Chat Message", "description": "Sends an encrypted message to a specific Chat conversation. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "sendChatMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendChatMessageRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendChatMessageResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/messages/delete": { "post": { "security": [ { "OAuth2UserToken": [ "dm.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Delete Chat messages", "description": "Deletes one or more messages from a Chat conversation. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient. Delete for all removes a message you sent (or, in groups you administer, any message) for every participant; delete for self removes any message only from your own view.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "deleteChatMessages", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteChatMessagesRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteChatMessagesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/read": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "dm.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Mark Conversation as Read", "description": "Marks a specific Chat conversation as read on behalf of the authenticated user. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "markChatConversationRead", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkChatConversationReadRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkChatConversationReadResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/conversations/{id}/typing": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "dm.write", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Send Typing Indicator", "description": "Sends a typing indicator to a specific Chat conversation on behalf of the authenticated user. For 1:1 conversations, provide the recipient's user ID; the server constructs the canonical conversation ID from the authenticated user and recipient.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "sendChatTypingIndicator", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendChatTypingIndicatorResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/media/upload/initialize": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Initialize Chat Media Upload", "description": "Initializes an XChat media upload session.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload" }, "operationId": "chatMediaUploadInitialize", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadInitializeRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadInitializeResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/media/upload/{id}/append": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Append Chat Media Upload", "description": "Appends media data to an XChat upload session.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload" }, "operationId": "chatMediaUploadAppend", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadAppendRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadAppendRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadAppendResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/media/upload/{id}/finalize": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Finalize Chat Media Upload", "description": "Finalizes an XChat media upload session.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload" }, "operationId": "chatMediaUploadFinalize", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadFinalizeRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMediaUploadFinalizeResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/chat/media/{id}/{media_hash_key}": { "get": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Download Chat Media", "description": "Downloads encrypted media bytes from an XChat conversation. The response body contains raw binary bytes.", "operationId": "chatMediaDownload", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}|[0-9]{1,19}-[0-9]{1,19}|g[0-9]{1,19})$" }, "style": "simple" }, { "name": "media_hash_key", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,50}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/communities/search": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Communities" ], "summary": "Search Communities", "operationId": "searchCommunities", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "next_token", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/CommunityFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCommunitiesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/communities/{id}": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "list.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Communities" ], "summary": "Get Communities by ID", "operationId": "getCommunitiesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CommunityId" }, "style": "simple" }, { "$ref": "#/components/parameters/CommunityFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommunitiesByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/compliance/jobs": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Compliance" ], "summary": "Get Compliance Jobs", "description": "Retrieves a list of Compliance Jobs filtered by job type and optional status.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs" }, "operationId": "getComplianceJobs", "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "tweets", "users" ] }, "style": "form" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", "in_progress", "failed", "complete" ] }, "style": "form" }, { "$ref": "#/components/parameters/ComplianceJobFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetComplianceJobsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "BearerToken": [] } ], "tags": [ "Compliance" ], "summary": "Create Compliance Job", "description": "Creates a new Compliance Job for the specified job type.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/post-compliance-jobs" }, "operationId": "createComplianceJobs", "parameters": [ { "$ref": "#/components/parameters/ComplianceJobFieldsParameter" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateComplianceJobsRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateComplianceJobsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/compliance/jobs/{id}": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Compliance" ], "summary": "Get Compliance Job by ID", "description": "Retrieves details of a specific Compliance Job by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/compliance/batch-compliance/api-reference/get-compliance-jobs-id" }, "operationId": "getComplianceJobsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" }, { "$ref": "#/components/parameters/ComplianceJobFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetComplianceJobsByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/connections": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Connections" ], "summary": "Terminate multiple connections", "description": "Terminates multiple streaming connections by their UUIDs for the authenticated application.", "operationId": "deleteConnectionsByUuids", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectionsByUuidsRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectionsByUuidsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Connections" ], "summary": "Get Connection History", "description": "Returns active and historical streaming connections with disconnect reasons for the authenticated application.", "operationId": "getConnectionHistory", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "inactive", "all" ], "default": "active" }, "style": "form" }, { "name": "endpoints", "in": "query", "required": false, "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "filtered_stream", "sample_stream", "sample10_stream", "firehose_stream", "tweets_compliance_stream", "users_compliance_stream", "tweet_label_stream", "firehose_stream_lang_en", "firehose_stream_lang_ja", "firehose_stream_lang_ko", "firehose_stream_lang_pt", "likes_firehose_stream", "likes_sample10_stream", "likes_compliance_stream" ] } }, "explode": false, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/ConnectionFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectionHistoryResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/connections/all": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Connections" ], "summary": "Terminate all connections", "description": "Terminates all active streaming connections for the authenticated application.", "externalDocs": { "url": "https://docs.x.com/x-api/connections/terminate-all-connections" }, "operationId": "deleteAllConnections", "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAllConnectionsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/connections/{endpoint_id}": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Connections" ], "summary": "Terminate connections by endpoint", "description": "Terminates all streaming connections for a specific endpoint ID for the authenticated application.", "operationId": "deleteConnectionsByEndpoint", "parameters": [ { "name": "endpoint_id", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "filtered_stream", "sample_stream", "sample10_stream", "firehose_stream", "tweets_compliance_stream", "users_compliance_stream", "tweet_label_stream", "firehose_stream_lang_en", "firehose_stream_lang_ja", "firehose_stream_lang_ko", "firehose_stream_lang_pt", "likes_firehose_stream", "likes_sample10_stream", "likes_compliance_stream" ] }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectionsByEndpointResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_conversations": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "dm.write" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Create DM conversation", "description": "Initiates a new direct message conversation with specified participants.", "operationId": "createDirectMessagesConversation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectMessagesConversationRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectMessagesConversationResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_conversations/media/{dm_id}/{media_id}/{resource_id}": { "get": { "security": [ { "OAuth2UserToken": [ "dm.read" ] } ], "tags": [ "Direct Messages" ], "summary": "Download DM Media", "description": "Downloads media attached to a legacy Direct Message. The requesting user must be a participant in the conversation containing the specified DM event. The response body contains raw binary bytes.", "operationId": "dmConversationsMediaDownload", "parameters": [ { "name": "dm_id", "in": "path", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "name": "media_id", "in": "path", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_conversations/with/{participant_id}/dm_events": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "dm.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Get Direct Messages Events by Participant ID", "operationId": "getDirectMessagesEventsByParticipantId", "parameters": [ { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "name": "event_types", "in": "query", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "MessageCreate", "ParticipantsJoin", "ParticipantsLeave" ] }, "default": [ "MessageCreate", "ParticipantsLeave", "ParticipantsJoin" ] }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/DmEventFieldsParameter" }, { "$ref": "#/components/parameters/DmEventExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDirectMessagesEventsByParticipantIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_conversations/with/{participant_id}/messages": { "post": { "security": [ { "OAuth2UserToken": [ "dm.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Create DM message by participant ID", "description": "Sends a new direct message to a specific participant by their ID.", "operationId": "createDirectMessagesByParticipantId", "parameters": [ { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectMessagesByParticipantIdRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectMessagesByParticipantIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_conversations/{dm_conversation_id}/messages": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "dm.write", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Create Direct Messages by Conversation ID", "operationId": "createDirectMessagesByConversationId", "parameters": [ { "name": "dm_conversation_id", "in": "path", "required": true, "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectMessagesByConversationIdRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectMessagesByConversationIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_conversations/{id}/dm_events": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "dm.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Get Direct Messages Events by Conversation ID", "operationId": "getDirectMessagesEventsByConversationId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]{1,19}-[0-9]{1,19}|[0-9]{15,19})$" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "name": "event_types", "in": "query", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "MessageCreate", "ParticipantsJoin", "ParticipantsLeave" ] }, "default": [ "MessageCreate", "ParticipantsLeave", "ParticipantsJoin" ] }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/DmEventFieldsParameter" }, { "$ref": "#/components/parameters/DmEventExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDirectMessagesEventsByConversationIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_events": { "get": { "security": [ { "OAuth2UserToken": [ "dm.read", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Get Direct Messages Events", "operationId": "getDirectMessagesEvents", "parameters": [ { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "name": "event_types", "in": "query", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "MessageCreate", "ParticipantsJoin", "ParticipantsLeave" ] }, "default": [ "MessageCreate", "ParticipantsLeave", "ParticipantsJoin" ] }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/DmEventFieldsParameter" }, { "$ref": "#/components/parameters/DmEventExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDirectMessagesEventsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/dm_events/{event_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "dm.write", "dm.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Delete DM event", "description": "Deletes a specific direct message event by its ID, if owned by the authenticated user.", "operationId": "deleteDirectMessagesEvents", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDirectMessagesEventsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "security": [ { "OAuth2UserToken": [ "users.read", "dm.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Direct Messages" ], "summary": "Get Direct Messages Events by ID", "operationId": "getDirectMessagesEventsById", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" }, { "$ref": "#/components/parameters/DmEventFieldsParameter" }, { "$ref": "#/components/parameters/DmEventExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDirectMessagesEventsByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/likes/compliance/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Likes compliance data", "description": "Streams all compliance data related to Likes for Users.", "operationId": "streamLikesCompliance", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamLikesComplianceResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/likes/firehose/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream all Likes", "description": "Streams all public Likes in real-time.", "operationId": "streamLikesFirehose", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 20, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "like_with_tweet_author.fields", "in": "query", "description": "A comma separated list of LikeWithTweetAuthor fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "attachments_media_keys", "created_at", "id", "liked_tweet_author_id", "liked_tweet_id", "timestamp_ms" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "attachments.media_keys", "liked_tweet_author_id", "liked_tweet_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamLikesFirehoseResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/likes/sample10/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream sampled Likes", "description": "Streams a 10% sample of public Likes in real-time.", "operationId": "streamLikesSample10", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "like_with_tweet_author.fields", "in": "query", "description": "A comma separated list of LikeWithTweetAuthor fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "attachments_media_keys", "created_at", "id", "liked_tweet_author_id", "liked_tweet_id", "timestamp_ms" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "attachments.media_keys", "liked_tweet_author_id", "liked_tweet_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamLikesSample10Response" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/lists": { "post": { "security": [ { "OAuth2UserToken": [ "users.read", "list.write", "list.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Lists" ], "summary": "Create Lists", "operationId": "createLists", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListsRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/lists/{id}": { "delete": { "security": [ { "OAuth2UserToken": [ "list.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Lists" ], "summary": "Delete List", "description": "Deletes a specific List owned by the authenticated user by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id" }, "operationId": "deleteLists", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteListsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "list.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Lists" ], "summary": "Get Lists by ID", "operationId": "getListsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" }, { "$ref": "#/components/parameters/ListFieldsParameter" }, { "$ref": "#/components/parameters/ListExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListsByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "security": [ { "OAuth2UserToken": [ "list.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Lists" ], "summary": "Update List", "description": "Updates the details of a specific List owned by the authenticated user by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id" }, "operationId": "updateLists", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateListsRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateListsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/lists/{id}/followers": { "get": { "security": [ { "OAuth2UserToken": [ "list.read", "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Lists" ], "summary": "Get Lists Followers", "operationId": "getListsFollowers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A 64-bit signed integer.", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListsFollowersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/lists/{id}/members": { "get": { "security": [ { "OAuth2UserToken": [ "list.read", "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Lists" ], "summary": "Get Lists Members", "operationId": "getListsMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A 64-bit signed integer.", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListsMembersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "list.write", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Lists" ], "summary": "Add Lists Member", "operationId": "addListsMember", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddListsMemberRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddListsMemberResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/lists/{id}/members/{user_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "list.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Lists" ], "summary": "Remove a List member", "description": "Removes a User from a List by their ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/delete-lists-id-members-user_id" }, "operationId": "removeListsMemberByUserId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" }, { "name": "user_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveListsMemberByUserIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/lists/{id}/tweets": { "get": { "security": [ { "OAuth2UserToken": [ "list.read", "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Lists" ], "summary": "Get Lists Posts", "operationId": "getListsPosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListsPostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Media" ], "summary": "Get Media by media keys", "operationId": "getMediaByMediaKeys", "parameters": [ { "name": "media_keys", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^([0-9]+)_([0-9]+)$" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/MediaFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaByMediaKeysResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/analytics": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Get Media analytics", "operationId": "getMediaAnalytics", "parameters": [ { "name": "media_keys", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^([0-9]+)_([0-9]+)$" } }, "explode": false, "style": "form" }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hourly", "daily", "total" ], "default": "daily" }, "style": "form" }, { "$ref": "#/components/parameters/MediaAnalyticsFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaAnalyticsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/metadata": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Create Media metadata", "description": "Creates metadata for a Media file.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-metadata-create#metadata-create" }, "operationId": "createMediaMetadata", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaMetadataRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaMetadataResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/subtitles": { "delete": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Delete Media subtitles", "description": "Deletes subtitles for a specific Media file.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-subtitles-delete" }, "operationId": "deleteMediaSubtitles", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMediaSubtitlesRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMediaSubtitlesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Create Media subtitles", "description": "Creates subtitles for a specific Media file.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-subtitles-create" }, "operationId": "createMediaSubtitles", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaSubtitlesRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaSubtitlesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/upload": { "get": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Get Media upload status", "description": "Retrieves the status of a Media upload by its ID.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload-status#media-upload-status" }, "operationId": "getMediaUploadStatus", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/MediaId" }, "style": "form" }, { "name": "command", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "STATUS" ] }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaUploadStatusResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Upload media", "description": "Uploads a media file for use in posts or other content.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload" }, "operationId": "mediaUpload", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUploadRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MediaUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUploadResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/upload/initialize": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Initialize media upload", "description": "Initializes a media upload.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload" }, "operationId": "initializeMediaUpload", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitializeMediaUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitializeMediaUploadResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/upload/{id}/append": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Append Media Upload", "operationId": "appendMediaUpload", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppendMediaUploadRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppendMediaUploadRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppendMediaUploadResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/upload/{id}/finalize": { "post": { "security": [ { "OAuth2UserToken": [ "media.write" ] }, { "UserToken": [] } ], "tags": [ "Media" ], "summary": "Finalize Media upload", "description": "Finalizes a Media upload request.", "externalDocs": { "url": "https://docs.x.com/x-api/media/media-upload" }, "operationId": "finalizeMediaUpload", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalizeMediaUploadResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/media/{media_key}": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Media" ], "summary": "Get Media by media key", "operationId": "getMediaByMediaKey", "parameters": [ { "name": "media_key", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^([0-9]+)_([0-9]+)$" }, "style": "simple" }, { "$ref": "#/components/parameters/MediaFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaByMediaKeyResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/news/search": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "News" ], "summary": "Search News", "operationId": "searchNews", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "max_age_hours", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 720, "format": "int32", "default": 168 }, "style": "form" }, { "$ref": "#/components/parameters/NewsFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchNewsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/news/{id}": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "News" ], "summary": "Get news stories by ID", "description": "Retrieves news story by its ID.", "externalDocs": { "url": "https://docs.x.com/x-api/news/introduction" }, "operationId": "getNews", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" }, { "$ref": "#/components/parameters/NewsFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNewsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/notes": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Community Notes" ], "summary": "Create Community Notes", "operationId": "createCommunityNotes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommunityNotesRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommunityNotesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/notes/evaluate": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Community Notes" ], "summary": "Evaluate Community Notes", "operationId": "evaluateCommunityNotes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateCommunityNotesRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateCommunityNotesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/notes/search/notes_written": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Community Notes" ], "summary": "Search Community Notes Written", "operationId": "searchCommunityNotesWritten", "parameters": [ { "name": "test_mode", "in": "query", "required": true, "schema": { "type": "boolean" }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/NoteFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCommunityNotesWrittenResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/notes/search/posts_eligible_for_notes": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Community Notes" ], "summary": "Search Eligible Posts", "operationId": "searchEligiblePosts", "parameters": [ { "name": "test_mode", "in": "query", "required": true, "schema": { "type": "boolean" }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "name": "post_selection", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchEligiblePostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/notes/{id}": { "delete": { "security": [ { "OAuth2UserToken": [ "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Community Notes" ], "summary": "Delete a Community Note", "description": "Deletes a community note.", "externalDocs": { "url": "https://communitynotes.x.com/guide/api/overview" }, "operationId": "deleteCommunityNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/NoteId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCommunityNotesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/openapi.json": { "get": { "tags": [ "General" ], "summary": "Get OpenAPI Spec.", "description": "Retrieves the full OpenAPI Specification in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)", "operationId": "getOpenApiSpec", "parameters": [], "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/2/spaces": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "space.read" ] }, { "BearerToken": [] } ], "tags": [ "Spaces" ], "summary": "Get Spaces by IDs", "operationId": "getSpacesByIds", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/SpaceFieldsParameter" }, { "$ref": "#/components/parameters/SpaceExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/TopicFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpacesByIdsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/spaces/by/creator_ids": { "get": { "security": [ { "OAuth2UserToken": [ "space.read", "tweet.read", "users.read" ] }, { "BearerToken": [] } ], "tags": [ "Spaces" ], "summary": "Get Spaces by Creator IDs", "operationId": "getSpacesByCreatorIds", "parameters": [ { "name": "user_ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/SpaceFieldsParameter" }, { "$ref": "#/components/parameters/SpaceExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/TopicFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpacesByCreatorIdsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/spaces/search": { "get": { "security": [ { "OAuth2UserToken": [ "space.read", "tweet.read", "users.read" ] }, { "BearerToken": [] } ], "tags": [ "Spaces" ], "summary": "Search Spaces", "description": "Retrieves a list of Spaces matching the specified search query.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/spaces/search/api-reference/get-spaces-search" }, "operationId": "searchSpaces", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "style": "form" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "live", "scheduled", "all" ], "default": "all" }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "$ref": "#/components/parameters/SpaceFieldsParameter" }, { "$ref": "#/components/parameters/SpaceExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/TopicFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSpacesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/spaces/{id}": { "get": { "security": [ { "OAuth2UserToken": [ "space.read", "users.read", "tweet.read" ] }, { "BearerToken": [] } ], "tags": [ "Spaces" ], "summary": "Get Spaces by ID", "operationId": "getSpacesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" }, { "$ref": "#/components/parameters/SpaceFieldsParameter" }, { "$ref": "#/components/parameters/SpaceExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/TopicFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpacesByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/spaces/{id}/buyers": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "space.read" ] } ], "tags": [ "Spaces" ], "summary": "Get Space ticket buyers", "description": "Retrieves a list of Users who purchased tickets to a specific Space by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-buyers" }, "operationId": "getSpacesBuyers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpacesBuyersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/spaces/{id}/tweets": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "space.read", "tweet.read" ] }, { "BearerToken": [] } ], "tags": [ "Spaces" ], "summary": "Get Space Posts", "description": "Retrieves a list of Posts shared in a specific Space by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-tweets" }, "operationId": "getSpacesPosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z0-9]{1,13}$" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpacesPostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/trends/by/woeid/{woeid}": { "get": { "security": [ { "OAuth2UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Trends" ], "summary": "Get Trends by Woeid", "operationId": "getTrendsByWoeid", "parameters": [ { "name": "woeid", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "style": "simple" }, { "name": "max_trends", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "format": "int32", "default": 20 }, "style": "form" }, { "$ref": "#/components/parameters/TrendFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTrendsByWoeidResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts by IDs", "operationId": "getPostsByIds", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/PostId" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsByIdsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "tweet.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Posts" ], "summary": "Create Posts", "operationId": "createPosts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePostsRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/analytics": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Analytics", "operationId": "getPostsAnalytics", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/AnalyticsId" } }, "explode": false, "style": "form" }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "hourly", "weekly", "daily", "total" ], "default": "total" }, "style": "form" }, { "$ref": "#/components/parameters/AnalyticsFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsAnalyticsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/compliance/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Posts compliance data", "description": "Streams all compliance data related to Posts.", "operationId": "streamPostsCompliance", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 4, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post Compliance events will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsComplianceResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/counts/all": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Counts All", "description": "At most one of `pagination_token`, `next_token` may be provided.", "operationId": "getPostsCountsAll", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "style": "form" }, { "name": "start_time", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "next_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "minute", "hour", "day" ], "default": "hour" }, "style": "form" }, { "name": "search_count.fields", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsCountsAllResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/counts/recent": { "get": { "security": [ { "OAuth2UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Counts Recent", "description": "At most one of `pagination_token`, `next_token` may be provided.", "operationId": "getPostsCountsRecent", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "style": "form" }, { "name": "start_time", "in": "query", "description": "Must be within the last 7 days.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "next_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "minute", "hour", "day" ], "default": "hour" }, "style": "form" }, { "name": "search_count.fields", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsCountsRecentResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/firehose/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream all Posts", "description": "Streams all public Posts in real-time.", "operationId": "streamPostsFirehose", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 20, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsFirehoseResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/firehose/stream/lang/en": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream English Posts", "description": "Streams all public English-language Posts in real-time.", "operationId": "streamPostsFirehoseEn", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 8, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsFirehoseEnResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/firehose/stream/lang/ja": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Japanese Posts", "description": "Streams all public Japanese-language Posts in real-time.", "operationId": "streamPostsFirehoseJa", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsFirehoseJaResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/firehose/stream/lang/ko": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Korean Posts", "description": "Streams all public Korean-language Posts in real-time.", "operationId": "streamPostsFirehoseKo", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsFirehoseKoResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/firehose/stream/lang/pt": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Portuguese Posts", "description": "Streams all public Portuguese-language Posts in real-time.", "operationId": "streamPostsFirehosePt", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsFirehosePtResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/label/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Post labels", "description": "Streams all labeling events applied to Posts.", "operationId": "streamLabelsCompliance", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamLabelsComplianceResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/sample/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream sampled Posts", "description": "Streams a 1% sample of public Posts in real-time.", "externalDocs": { "url": "https://docs.x.com/x-api/posts/volume-streams/introduction" }, "operationId": "streamPostsSample", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsSampleResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/sample10/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream 10% sampled Posts", "description": "Streams a 10% sample of public Posts in real-time.", "operationId": "streamPostsSample10", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsSample10Response" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/search/all": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Search Posts All", "description": "At most one of `start_time`, `since_id` may be provided. At most one of `end_time`, `until_id` may be provided. At most one of `pagination_token`, `next_token` may be provided.", "operationId": "searchPostsAll", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "style": "form" }, { "name": "start_time", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 500, "format": "int32", "default": 10 }, "style": "form" }, { "name": "next_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recency", "relevancy" ] }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchPostsAllResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/search/recent": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Search Posts Recent", "description": "At most one of `start_time`, `since_id` may be provided. At most one of `end_time`, `until_id` may be provided. At most one of `pagination_token`, `next_token` may be provided.", "operationId": "searchPostsRecent", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "next_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "start_time", "in": "query", "description": "Must be within the last 7 days.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "recency", "relevancy" ] }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchPostsRecentResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/search/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream filtered Posts", "description": "Streams Posts in real-time matching the active rule set.", "externalDocs": { "url": "https://docs.x.com/x-api/posts/filtered-stream/introduction" }, "operationId": "streamPosts", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "tweet.fields", "in": "query", "description": "A comma separated list of Tweet fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "attachments", "author_id", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_request_suggestions", "note_tweet", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_tweet_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "entities.note.mentions.username", "referenced_tweets.id", "referenced_tweets.id.attachments.media_keys", "referenced_tweets.id.author_id" ] } }, "explode": false, "style": "form" }, { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "most_recent_tweet_id", "name", "parody", "pinned_tweet_id", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/tweets/search/stream/rules": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Get filtered-stream rules", "description": "Returns the active filtered-stream rules for the authenticated app. Provide `ids` to fetch specific rules; omit it to list all rules.", "externalDocs": { "url": "https://docs.x.com/x-api/posts/rules-lookup" }, "operationId": "getRules", "parameters": [ { "name": "ids", "in": "query", "required": false, "schema": { "type": "array", "maxItems": 1000, "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "explode": false, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32", "default": 1000 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16, "maxLength": 16 }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRulesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Update stream rules", "description": "Adds or deletes rules from the active rule set for the filtered stream. Exactly one of `add`, `delete`, or `?delete_all=true` must be specified. Use `?dry_run=true` to validate without committing.", "externalDocs": { "url": "https://docs.x.com/x-api/posts/filtered-stream/integrate/add-or-delete-rules" }, "operationId": "updateRules", "parameters": [ { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "name": "delete_all", "in": "query", "required": false, "schema": { "type": "boolean" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRulesRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRulesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/search/stream/rules/counts": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Get Rule Counts", "operationId": "getRuleCounts", "parameters": [ { "name": "rules_count.fields", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRuleCountsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/search/webhooks": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Get stream links", "description": "Get a list of webhook links associated with a filtered stream ruleset.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "getWebhooksStreamLinks", "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhooksStreamLinksResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/search/webhooks/{webhook_id}": { "delete": { "security": [ { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Delete stream link", "description": "Deletes the link delivering FilteredStream events to the given webhook.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "deleteWebhooksStreamLink", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhooksStreamLinkResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Create stream link", "description": "Creates a link to deliver FilteredStream events to the given webhook.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "createWebhooksStreamLink", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhooksStreamLinkResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/{id}": { "delete": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Posts" ], "summary": "Delete Posts", "operationId": "deletePosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts by ID", "operationId": "getPostsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/{id}/liking_users": { "get": { "security": [ { "OAuth2UserToken": [ "like.read", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Liking Users", "operationId": "getPostsLikingUsers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsLikingUsersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/{id}/quote_tweets": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Quoted Posts", "operationId": "getPostsQuotedPosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 100, "format": "int32", "default": 10 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "replies", "retweets" ] } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsQuotedPostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/{id}/retweeted_by": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Reposted by", "operationId": "getPostsRepostedBy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsRepostedByResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/{id}/retweets": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Posts" ], "summary": "Get Posts Reposts", "operationId": "getPostsReposts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPostsRepostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/tweets/{tweet_id}/hidden": { "put": { "security": [ { "OAuth2UserToken": [ "tweet.moderate.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Posts" ], "summary": "Hide reply", "description": "Hides or unhides a reply to a conversation owned by the authenticated user.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden" }, "operationId": "hidePostsReply", "parameters": [ { "name": "tweet_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HidePostsReplyRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HidePostsReplyResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/usage/tweets": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Usage" ], "summary": "Get Usage", "operationId": "getUsage", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 90, "format": "int32", "default": 7 }, "style": "form" }, { "$ref": "#/components/parameters/UsageFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsageResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users by IDs", "operationId": "getUsersByIds", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/UserId" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersByIdsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/by": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users by Usernames", "operationId": "getUsersByUsernames", "parameters": [ { "name": "usernames", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "pattern": "^[A-Za-z0-9_]{1,15}$" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersByUsernamesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/by/username/{username}": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users by Username", "operationId": "getUsersByUsername", "parameters": [ { "name": "username", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_]{1,15}$" }, "style": "simple" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersByUsernameResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/compliance/stream": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Stream" ], "summary": "Stream Users compliance data", "description": "Streams all compliance data related to Users.", "operationId": "streamUsersCompliance", "parameters": [ { "name": "backfill_minutes", "in": "query", "description": "The number of minutes of backfill requested.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 5, "format": "int32" }, "style": "form" }, { "name": "partition", "in": "query", "description": "The partition number.", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 4, "format": "int32" }, "style": "form" }, { "name": "start_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamUsersComplianceResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-twitter-streaming": true } }, "/2/users/me": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Me", "operationId": "getUsersMe", "parameters": [ { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersMeResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/personalized_trends": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Trends" ], "summary": "Get Trends Personalized Trends", "operationId": "getTrendsPersonalizedTrends", "parameters": [ { "$ref": "#/components/parameters/PersonalizedTrendFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTrendsPersonalizedTrendsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/public_keys": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "dm.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get public keys", "description": "Returns registered public keys for X Chat encryption for the specified users.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "getUsersPublicKeys", "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/PublicKeyId" } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/PublicKeyFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersPublicKeysResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/reposts_of_me": { "get": { "security": [ { "OAuth2UserToken": [ "timeline.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Reposts of Me", "operationId": "getUsersRepostsOfMe", "parameters": [ { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersRepostsOfMeResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/search": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Search Users", "operationId": "searchUsers", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_' ]{1,50}$" }, "style": "form" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32", "default": 100 }, "style": "form" }, { "name": "next_token", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchUsersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users by ID", "operationId": "getUsersById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersByIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/affiliates": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Affiliates", "operationId": "getUsersAffiliates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A 64-bit signed integer.", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersAffiliatesResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/blocking": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "block.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Blocking", "operationId": "getUsersBlocking", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersBlockingResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/bookmarks": { "get": { "security": [ { "OAuth2UserToken": [ "bookmark.read", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Bookmarks", "operationId": "getUsersBookmarks", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersBookmarksResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "bookmark.write" ] } ], "tags": [ "Users" ], "summary": "Create Users Bookmark", "operationId": "createUsersBookmark", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsersBookmarkRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsersBookmarkResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/bookmarks/folders": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "bookmark.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Bookmark Folders", "operationId": "getUsersBookmarkFolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersBookmarkFoldersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "users.read", "bookmark.write" ] } ], "tags": [ "Users" ], "summary": "Create Bookmark Folder", "description": "Creates a new Bookmark folder for the authenticated user.", "operationId": "createUsersBookmarkFolder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsersBookmarkFolderRequest" } } }, "required": true }, "responses": { "201": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsersBookmarkFolderResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/bookmarks/folders/{folder_id}": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "bookmark.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Bookmarks by Folder ID", "operationId": "getUsersBookmarksByFolderId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersBookmarksByFolderIdResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/bookmarks/{tweet_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "bookmark.write" ] } ], "tags": [ "Users" ], "summary": "Delete Bookmark", "description": "Removes a Post from the authenticated user's Bookmarks by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/delete-users-id-bookmarks-tweet_id" }, "operationId": "deleteUsersBookmark", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "tweet_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteUsersBookmarkResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/dm/block": { "post": { "security": [ { "OAuth2UserToken": [ "dm.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Block Users Dms", "operationId": "blockUsersDms", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockUsersDmsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/dm/unblock": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.read", "dm.write", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unblock Users Dms", "operationId": "unblockUsersDms", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnblockUsersDmsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/followed_lists": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "list.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Followed Lists", "operationId": "getUsersFollowedLists", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A 64-bit signed integer.", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/ListFieldsParameter" }, { "$ref": "#/components/parameters/ListExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersFollowedListsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "list.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Follow List", "operationId": "followList", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowListRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowListResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/followed_lists/{list_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "users.read", "list.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unfollow a List", "description": "Causes the authenticated user to unfollow a List by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/delete-users-id-followed-lists-list_id" }, "operationId": "unfollowList", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "list_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnfollowListResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/followers": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "follows.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Followers", "operationId": "getUsersFollowers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersFollowersResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/following": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "follows.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Following", "operationId": "getUsersFollowing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 16 }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersFollowingResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "follows.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Follow User", "operationId": "followUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowUserRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowUserResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/liked_tweets": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "like.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Liked Posts", "operationId": "getUsersLikedPosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersLikedPostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/likes": { "post": { "security": [ { "OAuth2UserToken": [ "users.read", "like.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Like Post", "operationId": "likePost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikePostRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LikePostResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/likes/{tweet_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "like.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unlike Post", "operationId": "unlikePost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "tweet_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PostId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlikePostResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/list_memberships": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "list.read", "tweet.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users List Memberships", "operationId": "getUsersListMemberships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/ListFieldsParameter" }, { "$ref": "#/components/parameters/ListExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersListMembershipsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/mentions": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Mentions", "description": "When both are provided, `start_time` must be earlier than `end_time`. When both are provided, `since_id` must be less than `until_id`.", "operationId": "getUsersMentions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "start_time", "in": "query", "description": "Must be on or after 2010-11-06.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "Must be on or after 2010-11-06.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersMentionsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/muting": { "get": { "security": [ { "OAuth2UserToken": [ "mute.read", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Muting", "operationId": "getUsersMuting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/UserExpansionsParameter" }, { "$ref": "#/components/parameters/PostFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersMutingResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "users.read", "mute.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Mute User", "operationId": "muteUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MuteUserRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MuteUserResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/owned_lists": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "list.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Owned Lists", "operationId": "getUsersOwnedLists", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32", "default": 100 }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A 64-bit signed integer.", "required": false, "schema": { "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/ListFieldsParameter" }, { "$ref": "#/components/parameters/ListExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersOwnedListsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/pinned_lists": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "list.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Pinned Lists", "operationId": "getUsersPinnedLists", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "$ref": "#/components/parameters/ListFieldsParameter" }, { "$ref": "#/components/parameters/ListExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersPinnedListsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "users.read", "list.write", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Pin List", "description": "Causes the authenticated user to pin a specific List by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/post-users-id-pinned-lists" }, "operationId": "pinList", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinListRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinListResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/pinned_lists/{list_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "tweet.read", "list.write", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unpin a List", "description": "Causes the authenticated user to unpin a List by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/delete-users-id-pinned-lists-list_id" }, "operationId": "unpinList", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "list_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpinListResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/public_keys": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read", "dm.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get public keys", "description": "Returns a user's registered public keys for X Chat encryption.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "getUsersPublicKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "$ref": "#/components/parameters/PublicKeyFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersPublicKeyResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "OAuth2UserToken": [ "dm.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Chat" ], "summary": "Add public key", "description": "Registers a user's public key for X Chat encryption.", "externalDocs": { "url": "https://developer.x.com/" }, "operationId": "addUserPublicKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddUserPublicKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddUserPublicKeyResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/retweets": { "post": { "security": [ { "OAuth2UserToken": [ "tweet.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Repost Post", "description": "Causes the authenticated user to repost a specific Post by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets" }, "operationId": "repostPost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepostPostRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepostPostResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/retweets/{source_tweet_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read", "tweet.write" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unrepost Post", "description": "Causes the authenticated user to unrepost a specific Post by its ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id" }, "operationId": "unrepostPost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "source_tweet_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnrepostPostResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/timelines/reverse_chronological": { "get": { "security": [ { "OAuth2UserToken": [ "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Timeline", "description": "When both are provided, `start_time` must be earlier than `end_time`. When both are provided, `since_id` must be less than `until_id`.", "operationId": "getUsersTimeline", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "start_time", "in": "query", "description": "Must be on or after 2010-11-06.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "Must be on or after 2010-11-06.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "replies", "retweets" ] } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersTimelineResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{id}/tweets": { "get": { "security": [ { "OAuth2UserToken": [ "tweet.read", "users.read" ] }, { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Users" ], "summary": "Get Users Posts", "description": "When both are provided, `start_time` must be earlier than `end_time`. When both are provided, `since_id` must be less than `until_id`.", "operationId": "getUsersPosts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "max_results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 5, "maximum": 100, "format": "int32" }, "style": "form" }, { "name": "pagination_token", "in": "query", "description": "A base32hex-encoded pagination token.", "required": false, "schema": { "type": "string", "minLength": 1 }, "style": "form" }, { "name": "start_time", "in": "query", "description": "Must be on or after 2010-11-06.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "end_time", "in": "query", "description": "Must be on or after 2010-11-06.", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "until_id", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "form" }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "replies", "retweets" ] } }, "explode": false, "style": "form" }, { "$ref": "#/components/parameters/PostFieldsParameter" }, { "$ref": "#/components/parameters/PostExpansionsParameter" }, { "$ref": "#/components/parameters/UserFieldsParameter" }, { "$ref": "#/components/parameters/MediaFieldsParameter" }, { "$ref": "#/components/parameters/PollFieldsParameter" }, { "$ref": "#/components/parameters/PlaceFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersPostsResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{source_user_id}/following/{target_user_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "follows.write", "tweet.read", "users.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unfollow User", "description": "Causes the authenticated user to unfollow a specific user by their ID.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/delete-users-source_id-following" }, "operationId": "unfollowUser", "parameters": [ { "name": "source_user_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "target_user_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnfollowUserResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/users/{source_user_id}/muting/{target_user_id}": { "delete": { "security": [ { "OAuth2UserToken": [ "mute.write", "users.read", "tweet.read" ] }, { "UserToken": [] } ], "tags": [ "Users" ], "summary": "Unmute User", "description": "Causes the authenticated user to unmute the target user.", "externalDocs": { "url": "https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/delete-users-user_id-muting" }, "operationId": "unmuteUser", "parameters": [ { "name": "source_user_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" }, { "name": "target_user_id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/UserId" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnmuteUserResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/webhooks": { "get": { "security": [ { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Get webhook", "description": "Get a list of webhook configs associated with a client app.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "getWebhooks", "parameters": [ { "$ref": "#/components/parameters/WebhookConfigFieldsParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhooksResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "security": [ { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Create webhook", "description": "Creates a new webhook configuration.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "createWebhooks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhooksRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhooksResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/webhooks/replay": { "post": { "security": [ { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Create replay job for webhook", "description": "Creates a replay job to retrieve events from up to the past 24 hours for all events delivered or attempted to be delivered to the webhook.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "createWebhookReplayJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookReplayJobRequest" } } }, "required": true }, "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookReplayJobResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/2/webhooks/{webhook_id}": { "delete": { "security": [ { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Delete webhook", "description": "Deletes an existing webhook configuration.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "deleteWebhooks", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhooksResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "put": { "security": [ { "UserToken": [] }, { "BearerToken": [] } ], "tags": [ "Webhooks" ], "summary": "Validate webhook", "description": "Triggers a CRC check for a given webhook.", "externalDocs": { "url": "https://docs.x.com/x-api/webhooks/introduction" }, "operationId": "validateWebhooks", "parameters": [ { "name": "webhook_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,19}$" }, "style": "simple" } ], "responses": { "200": { "description": "The request has succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateWebhooksResponse" } } } }, "default": { "description": "The request has failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } } }, "servers": [ { "description": "X API", "url": "https://api.x.com" } ], "tags": [ { "name": "Account Activity", "description": "Endpoints relating to retrieving, managing Account Activity subscriptions", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/enterprise-gnip-2.0/fundamentals/account-activity" } }, { "name": "Activity", "description": "Endpoints relating to retrieving, managing activity subscriptions", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/enterprise-gnip-2.0/fundamentals/account-activity" } }, { "name": "Articles", "description": "Endpoints related to retrieving, creating & modifying Articles", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/articles/introduction" } }, { "name": "Broadcasts", "description": "Endpoints related to live broadcasts and their chat", "externalDocs": { "description": "Find out more", "url": "https://developer.x.com/" } }, { "name": "Chat", "description": "Endpoints related to Chat encrypted messaging", "externalDocs": { "description": "Find out more", "url": "https://developer.x.com/" } }, { "name": "Communities", "description": "Endpoints related to retrieving and managing Communities", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/communities/introduction" } }, { "name": "Community Notes", "description": "Endpoints related to retrieving, searching, and modifying Community Notes", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/community-notes/introduction" } }, { "name": "Compliance", "description": "Endpoints related to keeping X data in your systems compliant", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/compliance/batch-compliance/introduction" } }, { "name": "Connections", "description": "Endpoints related to streaming connections", "externalDocs": { "description": "Find out more", "url": "https://developer.x.com/en/docs/x-api/connections" } }, { "name": "Direct Messages", "description": "Endpoints related to retrieving, managing Direct Messages", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/direct-messages/introduction" } }, { "name": "General", "description": "Miscellaneous endpoints for general API functionality", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/introduction" } }, { "name": "Lists", "description": "Endpoints related to retrieving, managing Lists", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/lists/introduction" } }, { "name": "Media", "description": "Endpoints related to retrieving and uploading Media", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/media/introduction" } }, { "name": "News", "description": "Endpoint for retrieving news stories", "externalDocs": { "description": "Find out more", "url": "https://developer.x.com/" } }, { "name": "Posts", "description": "Endpoints related to retrieving, searching, and modifying Posts", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/posts/introduction" } }, { "name": "Spaces", "description": "Endpoints related to retrieving, managing Spaces", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/spaces/introduction" } }, { "name": "Stream", "description": "Endpoints related to streaming", "externalDocs": { "description": "Find out more", "url": "https://developer.x.com/" } }, { "name": "Trends", "description": "Endpoint for retrieving trends", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/trends/introduction" } }, { "name": "Usage", "description": "Endpoints related to retrieving usage", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/usage/introduction" } }, { "name": "Users", "description": "Endpoints related to retrieving, managing relationships of Users", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/users/introduction" } }, { "name": "Webhooks", "description": "Endpoints relating to retrieving, managing webhooks and webhook configs", "externalDocs": { "description": "Find out more", "url": "https://docs.x.com/x-api/enterprise-gnip-2.0/fundamentals/account-activity" } } ], "components": { "securitySchemes": { "BearerToken": { "type": "http", "scheme": "bearer" }, "OAuth2UserToken": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://api.x.com/2/oauth2/authorize", "tokenUrl": "https://api.x.com/2/oauth2/token", "scopes": { "block.read": "View accounts you have blocked.", "bookmark.read": "Read your bookmarked Posts.", "bookmark.write": "Create and delete your bookmarks.", "broadcast.read": "View your live broadcasts and their chat.", "broadcast.write": "Manage your live broadcasts and send chat messages on your behalf.", "dm.read": "Read all your Direct Messages.", "dm.write": "Send and manage your Direct Messages.", "follows.read": "View accounts you follow and accounts following you.", "follows.write": "Follow and unfollow accounts on your behalf.", "like.read": "View Posts you have liked and likes you can see.", "like.write": "Like and unlike Posts on your behalf.", "list.read": "View Lists, members, and followers of Lists you created or are a member of, including private Lists.", "list.write": "Create and manage Lists on your behalf.", "media.write": "Upload media, such as photos and videos, on your behalf.", "mute.read": "View accounts you have muted.", "mute.write": "Mute and unmute accounts on your behalf.", "offline.access": "Request a refresh token for the app.", "space.read": "View all Spaces you have access to.", "timeline.read": "View all Custom Timelines you can see.", "tweet.moderate.write": "Hide and unhide replies to your posts.", "tweet.read": "View all posts you can see, including those from protected accounts.", "tweet.write": "Create and repost on your behalf.", "users.read": "View any account you can see, including protected accounts." } } } }, "UserToken": { "type": "http", "scheme": "OAuth" } }, "schemas": { "ActivityEventId": { "type": "string", "description": "The unique identifier of an Activity event.", "pattern": "^[0-9]{1,19}$", "example": "1146654567674912769" }, "ActivityStreamResponse": { "type": "object", "description": "An activity event or error that can be returned by the x activity streaming API.", "properties": { "data": { "type": "object", "properties": { "event_type": { "type": "string" }, "event_uuid": { "$ref": "#/components/schemas/ActivityEventId" }, "filter": { "$ref": "#/components/schemas/ActivitySubscriptionFilter" }, "includes": { "$ref": "#/components/schemas/Expansions" }, "payload": { "$ref": "#/components/schemas/ActivityStreamingResponsePayload" }, "tag": { "type": "string" } } }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } } } }, "ActivityStreamingResponsePayload": { "oneOf": [ { "$ref": "#/components/schemas/ProfileUpdateActivityResponsePayload" }, { "$ref": "#/components/schemas/NewsActivityResponsePayload" }, { "$ref": "#/components/schemas/FollowActivityResponsePayload" }, { "$ref": "#/components/schemas/Post" }, { "$ref": "#/components/schemas/PostDeleteActivityResponsePayload" }, { "$ref": "#/components/schemas/LikeWithPostAuthor" } ], "discriminator": { "propertyName": "../event_type", "mapping": { "follow.follow": "#/components/schemas/FollowActivityResponsePayload", "follow.unfollow": "#/components/schemas/FollowActivityResponsePayload", "like.create": "#/components/schemas/LikeWithPostAuthor", "news.new": "#/components/schemas/NewsActivityResponsePayload", "post.create": "#/components/schemas/Post", "post.delete": "#/components/schemas/PostDeleteActivityResponsePayload", "post.mention.create": "#/components/schemas/Post", "profile.update.affiliate_badge": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.banner_picture": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.bio": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.geo": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.handle": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.profile_picture": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.screenname": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.url": "#/components/schemas/ProfileUpdateActivityResponsePayload", "profile.update.verified_badge": "#/components/schemas/ProfileUpdateActivityResponsePayload" } } }, "ActivitySubscriptionFilter": { "type": "object", "description": "An XAA subscription filter.", "properties": { "direction": { "type": "string", "description": "Optional direction filter for directional events.", "enum": [ "inbound", "outbound" ] }, "keyword": { "$ref": "#/components/schemas/Keyword" }, "user_id": { "$ref": "#/components/schemas/UserId" } }, "additionalProperties": false }, "AddChatGroupMembersActionSignatures": { "type": "object", "required": [ "message_id", "encoded_message_event_detail", "message_event_signature" ], "properties": { "encoded_message_event_detail": { "type": "string", "description": "Base64-encoded message event detail.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "message_event_signature": { "description": "Message event signature supplied with an action signature.", "$ref": "#/components/schemas/AddChatGroupMembersActionSignaturesMessageEventSignature" }, "message_id": { "type": "string", "description": "Client-generated ID of the message being signed.", "minLength": 1 }, "signature_payload": { "type": "string", "description": "Payload string the client signed; used only in server-side failure logs." } } }, "AddChatGroupMembersActionSignaturesMessageEventSignature": { "type": "object", "required": [ "signature", "public_key_version", "signature_version" ], "properties": { "message_signing_key_info_list": { "type": "array", "description": "List of signing key information for message verification.", "items": { "$ref": "#/components/schemas/AddChatGroupMembersActionSignaturesMessageEventSignatureMessageSigningKeyInfoList" } }, "public_key_version": { "type": "string", "description": "The version of the public key used for signing.", "pattern": "^[0-9]+$" }, "signature": { "type": "string", "description": "The signature of the message event.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "signature_version": { "type": "string", "description": "The version of the signature algorithm.", "pattern": "^[0-9]+$" }, "signing_public_key": { "type": "string", "description": "The public key used for signing." } } }, "AddChatGroupMembersActionSignaturesMessageEventSignatureMessageSigningKeyInfoList": { "type": "object", "properties": { "member_id": { "type": "string", "description": "The member ID associated with this signing key." }, "public_key_version": { "type": "string", "description": "The version of the public key." }, "signing_public_key": { "type": "string", "description": "The signing public key." } } }, "AddChatGroupMembersConversationParticipantKeys": { "type": "object", "properties": { "encrypted_conversation_key": { "type": "string", "description": "Conversation key encrypted with this participant's public key." }, "public_key_version": { "type": "string", "description": "Version of the participant's public key used for encryption." }, "user_id": { "type": "string", "description": "Participant user ID." } } }, "AddChatGroupMembersRequest": { "type": "object", "required": [ "user_ids" ], "properties": { "action_signatures": { "type": "array", "description": "Cryptographic signatures for the action.", "items": { "$ref": "#/components/schemas/AddChatGroupMembersActionSignatures" } }, "conversation_key_version": { "type": "string", "description": "Version of the new rotated conversation key." }, "conversation_participant_keys": { "type": "array", "description": "Encrypted conversation keys for each participant.", "items": { "$ref": "#/components/schemas/AddChatGroupMembersConversationParticipantKeys" } }, "encrypted_avatar_url": { "type": "string", "description": "Re-encrypted group avatar URL with new conversation key." }, "encrypted_title": { "type": "string", "description": "Re-encrypted group title with new conversation key." }, "user_ids": { "type": "array", "description": "List of user IDs to add to the group conversation.", "items": { "type": "string" } } } }, "AddChatGroupMembersResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "AddConversationKeysActionSignatures": { "type": "object", "required": [ "message_id", "encoded_message_event_detail", "message_event_signature" ], "properties": { "encoded_message_event_detail": { "type": "string", "description": "Base64-encoded message event detail.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "message_event_signature": { "description": "Message event signature supplied with an action signature.", "$ref": "#/components/schemas/AddConversationKeysActionSignaturesMessageEventSignature" }, "message_id": { "type": "string", "description": "Client-generated ID of the message being signed.", "minLength": 1 }, "signature_payload": { "type": "string", "description": "Payload string the client signed; used only in server-side failure logs." } } }, "AddConversationKeysActionSignaturesMessageEventSignature": { "type": "object", "required": [ "signature", "public_key_version", "signature_version" ], "properties": { "message_signing_key_info_list": { "type": "array", "description": "List of signing key information for message verification.", "items": { "$ref": "#/components/schemas/AddConversationKeysActionSignaturesMessageEventSignatureMessageSigningKeyInfoList" } }, "public_key_version": { "type": "string", "description": "The version of the public key used for signing.", "pattern": "^[0-9]+$" }, "signature": { "type": "string", "description": "The signature of the message event.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "signature_version": { "type": "string", "description": "The version of the signature algorithm.", "pattern": "^[0-9]+$" }, "signing_public_key": { "type": "string", "description": "The public key used for signing." } } }, "AddConversationKeysActionSignaturesMessageEventSignatureMessageSigningKeyInfoList": { "type": "object", "properties": { "member_id": { "type": "string", "description": "The member ID associated with this signing key." }, "public_key_version": { "type": "string", "description": "The version of the public key." }, "signing_public_key": { "type": "string", "description": "The signing public key." } } }, "AddConversationKeysConversationParticipantKeys": { "type": "object", "properties": { "encrypted_conversation_key": { "type": "string", "description": "Conversation key encrypted with this participant's public key." }, "public_key_version": { "type": "string", "description": "Version of the participant's public key used for encryption." }, "user_id": { "type": "string", "description": "Participant user ID." } } }, "AddConversationKeysRequest": { "type": "object", "required": [ "conversation_key_version", "conversation_participant_keys" ], "properties": { "action_signatures": { "type": "array", "description": "Cryptographic signatures for the action.", "items": { "$ref": "#/components/schemas/AddConversationKeysActionSignatures" } }, "base64_encoded_key_rotation": { "type": "string", "description": "Base64-encoded key rotation payload for ratchet tree key management." }, "conversation_key_version": { "type": "string", "description": "Version of the conversation encryption key (typically a timestamp in milliseconds)." }, "conversation_participant_keys": { "type": "array", "description": "Encrypted conversation keys for each participant.", "items": { "$ref": "#/components/schemas/AddConversationKeysConversationParticipantKeys" } } } }, "AddConversationKeysResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddConversationKeysResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "AddConversationKeysResponseData": { "type": "object", "properties": { "conversation_id": { "type": "string", "description": "Canonical ID of the conversation." }, "sequence_id": { "type": "string", "description": "Sequence ID of the key change." } } }, "AddListsMemberRequest": { "type": "object", "required": [ "user_id" ], "properties": { "user_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "AddListsMemberResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddListsMemberResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "AddListsMemberResponseData": { "type": "object", "required": [ "is_member" ], "properties": { "is_member": { "type": "boolean", "description": "Indicates whether the user is a member of the List." } } }, "AddUserPublicKeyPublicKey": { "type": "object", "properties": { "identity_public_key_signature": { "type": "string", "description": "Signature over the identity public key." }, "public_key": { "type": "string", "description": "Identity public key (base64 encoded)." }, "public_key_fingerprint": { "type": "string", "description": "Fingerprint of the identity public key." }, "registration_method": { "type": "string", "description": "Registration method for the public key." }, "signing_public_key": { "type": "string", "description": "Signing public key (base64 encoded)." }, "signing_public_key_signature": { "type": "string", "description": "Signature over the signing public key." } } }, "AddUserPublicKeyRequest": { "type": "object", "required": [ "public_key", "version" ], "properties": { "generate_version": { "type": "boolean", "description": "When true, the server generates a new version." }, "public_key": { "description": "Public key registration payload.", "$ref": "#/components/schemas/AddUserPublicKeyPublicKey" }, "version": { "type": "string", "description": "Public key version." } } }, "AddUserPublicKeyResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AddUserPublicKeyResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "AddUserPublicKeyResponseData": { "type": "object", "properties": { "juicebox_config": { "type": "object", "description": "Juicebox recovery-service configuration for this key." }, "public_key_version": { "type": "string", "description": "Version assigned to the registered public key." } } }, "Analytics": { "type": "object", "properties": { "app_install_attempts": { "type": "integer" }, "app_opens": { "type": "integer" }, "bookmarks": { "type": "integer" }, "detail_expands": { "type": "integer" }, "email_tweet": { "type": "integer" }, "engagements": { "type": "integer" }, "follows": { "type": "integer" }, "hashtag_clicks": { "type": "integer" }, "id": { "type": "string" }, "impressions": { "type": "integer" }, "likes": { "type": "integer" }, "media_views": { "type": "integer" }, "permalink_clicks": { "type": "integer" }, "quote_tweets": { "type": "integer" }, "replies": { "type": "integer" }, "retweets": { "type": "integer" }, "shares": { "type": "integer" }, "timestamp": { "type": "string" }, "timestamped_metrics": { "$ref": "#/components/schemas/AnalyticsTimestampedMetrics" }, "unfollows": { "type": "integer" }, "unlikes": { "type": "integer" }, "url_clicks": { "type": "integer" }, "user_profile_clicks": { "type": "integer" } } }, "AnalyticsId": { "type": "string", "description": "Unique identifier of a Analytics", "pattern": "^[0-9]{1,19}$" }, "AnalyticsTimestampedMetrics": { "type": "array", "description": "Time-bucketed engagement metrics for the Post, one entry per granularity bucket.", "items": { "type": "object", "properties": { "metrics": { "type": "object", "description": "Engagement metric counts for this bucket.", "properties": { "app_install_attempts": { "type": "integer", "format": "int64", "nullable": true }, "app_opens": { "type": "integer", "format": "int64", "nullable": true }, "bookmarks": { "type": "integer", "format": "int64", "nullable": true }, "detail_expands": { "type": "integer", "format": "int64", "nullable": true }, "email_tweet": { "type": "integer", "format": "int64", "nullable": true }, "engagements": { "type": "integer", "format": "int64", "nullable": true }, "follows": { "type": "integer", "format": "int64", "nullable": true }, "hashtag_clicks": { "type": "integer", "format": "int64", "nullable": true }, "impressions": { "type": "integer", "format": "int64", "nullable": true }, "likes": { "type": "integer", "format": "int64", "nullable": true }, "media_views": { "type": "integer", "format": "int64", "nullable": true }, "permalink_clicks": { "type": "integer", "format": "int64", "nullable": true }, "quote_tweets": { "type": "integer", "format": "int64", "nullable": true }, "replies": { "type": "integer", "format": "int64", "nullable": true }, "retweets": { "type": "integer", "format": "int64", "nullable": true }, "shares": { "type": "integer", "format": "int64", "nullable": true }, "unfollows": { "type": "integer", "format": "int64", "nullable": true }, "unlikes": { "type": "integer", "format": "int64", "nullable": true }, "url_clicks": { "type": "integer", "format": "int64", "nullable": true }, "user_profile_clicks": { "type": "integer", "format": "int64", "nullable": true } }, "nullable": true }, "timestamp": { "type": "string", "description": "Start of the metrics bucket, as an ISO 8601 date-time.", "nullable": true } } } }, "AppendMediaUploadRequest": { "type": "object", "required": [ "media", "segment_index" ], "properties": { "media": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "string", "format": "byte" } ], "description": "The media chunk to upload." }, "segment_index": { "type": "integer", "description": "The index of this segment in the upload sequence.", "minimum": 0, "maximum": 999 } }, "additionalProperties": false }, "AppendMediaUploadResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppendMediaUploadResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "AppendMediaUploadResponseData": { "type": "object", "properties": { "expires_at": { "type": "integer", "description": "Epoch seconds when the upload session expires." } } }, "ArticleCreateDraftContentState": { "type": "object", "required": [ "blocks", "entities" ], "properties": { "blocks": { "type": "array", "description": "The text blocks that make up the article body.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocks" } }, "entities": { "type": "array", "description": "Non-text entities referenced by blocks (links, embedded posts, images, emoji, markdown/code/tables, dividers, LaTeX). Full set matches article storage.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateEntities" } } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocks": { "type": "object", "required": [ "text", "type" ], "properties": { "data": { "description": "Block-level metadata for mentions, hashtags, cashtags, and URLs.", "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksData" }, "entity_ranges": { "type": "array", "description": "References to entries in entities.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksEntityRanges" } }, "inline_style_ranges": { "type": "array", "description": "Inline formatting ranges.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksInlineStyleRanges" } }, "key": { "type": "string", "description": "Optional block key." }, "text": { "type": "string", "description": "The text content of this block. For latex entities, this holds the LaTeX source; for divider/markdown/image/post atomic placeholders, typically a single space." }, "type": { "type": "string", "description": "The block type. Use atomic for non-text embeds (image, post, markdown, divider, latex).", "enum": [ "unstyled", "header-one", "header-two", "header-three", "unordered-list-item", "ordered-list-item", "blockquote", "atomic" ] } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksData": { "type": "object", "properties": { "cashtags": { "type": "array", "description": "Cashtag spans in this block.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksDataCashtags" } }, "hashtags": { "type": "array", "description": "Hashtag spans in this block.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksDataHashtags" } }, "mentions": { "type": "array", "description": "Mention spans in this block.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksDataMentions" } }, "urls": { "type": "array", "description": "URL spans in this block.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateBlocksDataUrls" } } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksDataCashtags": { "type": "object", "required": [ "from_index", "to_index", "text" ], "properties": { "from_index": { "type": "integer", "description": "Start index of the tagged span.", "minimum": 0 }, "text": { "type": "string", "description": "The tagged text." }, "to_index": { "type": "integer", "description": "End index of the tagged span.", "minimum": 0 } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksDataHashtags": { "type": "object", "required": [ "from_index", "to_index", "text" ], "properties": { "from_index": { "type": "integer", "description": "Start index of the tagged span.", "minimum": 0 }, "text": { "type": "string", "description": "The tagged text." }, "to_index": { "type": "integer", "description": "End index of the tagged span.", "minimum": 0 } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksDataMentions": { "type": "object", "required": [ "from_index", "to_index", "text" ], "properties": { "from_index": { "type": "integer", "description": "Start index of the tagged span.", "minimum": 0 }, "text": { "type": "string", "description": "The tagged text." }, "to_index": { "type": "integer", "description": "End index of the tagged span.", "minimum": 0 } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksDataUrls": { "type": "object", "required": [ "from_index", "to_index", "text" ], "properties": { "from_index": { "type": "integer", "description": "Start index of the tagged span.", "minimum": 0 }, "text": { "type": "string", "description": "The tagged text." }, "to_index": { "type": "integer", "description": "End index of the tagged span.", "minimum": 0 } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksEntityRanges": { "type": "object", "required": [ "key", "offset", "length" ], "properties": { "key": { "type": "integer", "description": "Index into the entities array.", "minimum": 0 }, "length": { "type": "integer", "description": "Length of the entity range.", "minimum": 0 }, "offset": { "type": "integer", "description": "Start offset in the text.", "minimum": 0 } }, "additionalProperties": false }, "ArticleCreateDraftContentStateBlocksInlineStyleRanges": { "type": "object", "required": [ "offset", "length", "style" ], "properties": { "length": { "type": "integer", "description": "Length of the styled range.", "minimum": 0 }, "offset": { "type": "integer", "description": "Start offset in the text.", "minimum": 0 }, "style": { "type": "string", "description": "The inline style.", "enum": [ "bold", "italic", "strikethrough" ] } }, "additionalProperties": false }, "ArticleCreateDraftContentStateEntities": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "The entity key referenced by entity_ranges." }, "value": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateEntitiesValue" } }, "additionalProperties": false }, "ArticleCreateDraftContentStateEntitiesValue": { "type": "object", "required": [ "type", "mutability", "data" ], "properties": { "data": { "description": "Entity payload. Fields depend on the entity type: post_id (post), url (link), media_items (image), entity_key (emoji and other opaque keys), markdown (markdown / code blocks / GFM tables). divider and latex use an empty data object; latex source is the block text; emoji uses block text for the character(s). There is no separate table entity type in article storage; tables are markdown.", "$ref": "#/components/schemas/ArticleCreateDraftContentStateEntitiesValueData" }, "mutability": { "type": "string", "description": "Whether the entity can be edited. Recommended: immutable for post, image, divider, latex; mutable for link and markdown (matches the in-app Articles composer).", "enum": [ "immutable", "mutable", "segmented" ] }, "type": { "type": "string", "description": "The entity type. markdown carries code blocks, GFM tables, and other Markdown; emoji maps to backend TWEMOJI (Twemoji is internal); divider is a horizontal rule; latex renders TeX from the block text. Tables are not a separate enum value — use type markdown with a pipe table in data.markdown.", "enum": [ "post", "link", "image", "emoji", "markdown", "divider", "latex" ] } }, "additionalProperties": false }, "ArticleCreateDraftContentStateEntitiesValueData": { "type": "object", "properties": { "caption": { "type": "string", "description": "Caption text." }, "entity_key": { "type": "string", "description": "Opaque entity key. Used with type emoji (and reserved for other keyed embeds) to match in-app Articles composer payloads." }, "markdown": { "type": "string", "description": "Markdown body for type markdown. Use fenced code blocks (```lang ... ```) for code. Max weighted length is enforced by the Articles backend (10,000 per article)." }, "media_items": { "type": "array", "description": "Media keys. Used with type image.", "items": { "$ref": "#/components/schemas/ArticleCreateDraftContentStateEntitiesValueDataMediaItems" } }, "post_id": { "type": "string", "description": "The ID of the post to embed. Used with type post." }, "url": { "type": "string", "description": "The URL. Used with type link." } }, "additionalProperties": false }, "ArticleCreateDraftContentStateEntitiesValueDataMediaItems": { "type": "object", "required": [ "media_category", "media_id" ], "properties": { "media_category": { "type": "string" }, "media_id": { "type": "string" } }, "additionalProperties": false }, "ArticleCreateDraftCoverMedia": { "type": "object", "required": [ "media_category", "media_id" ], "properties": { "media_category": { "type": "string", "description": "The media category (e.g. tweet_image)." }, "media_id": { "type": "string", "description": "The media ID from the media upload endpoint." } }, "additionalProperties": false }, "ArticleCreateDraftRequest": { "type": "object", "required": [ "title", "content_state" ], "properties": { "content_state": { "description": "DraftJS content state representing the article body. Special formatting (markdown/code/tables, dividers, LaTeX, emoji, images, embedded posts) uses atomic blocks with entity_ranges pointing into entities.", "$ref": "#/components/schemas/ArticleCreateDraftContentState" }, "cover_media": { "description": "Optional cover media for the Article.", "$ref": "#/components/schemas/ArticleCreateDraftCoverMedia" }, "title": { "type": "string", "description": "The title of the Article.", "minLength": 1 } }, "additionalProperties": false }, "ArticleCreateDraftResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ArticleCreateDraftResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ArticleCreateDraftResponseData": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the created draft Article.", "pattern": "^[0-9]{1,19}$" }, "title": { "type": "string", "description": "The title of the draft Article." } } }, "ArticlePublishResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ArticlePublishResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ArticlePublishResponseData": { "type": "object", "required": [ "post_id" ], "properties": { "post_id": { "type": "string", "description": "The ID of the post created for the published Article." } } }, "BlockUsersDmsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BlockUsersDmsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "BlockUsersDmsResponseData": { "type": "object", "required": [ "blocked" ], "properties": { "blocked": { "type": "boolean", "description": "Indicates whether the target user is DM-blocked." } } }, "Broadcast": { "type": "object", "properties": { "available_for_replay": { "type": "boolean" }, "broadcast_id": { "type": "string" }, "chat_option": { "type": "integer" }, "created_at_ms": { "type": "string" }, "end_ms": { "type": "string" }, "height": { "type": "integer" }, "id": { "type": "string" }, "image_url": { "type": "string" }, "image_url_medium": { "type": "string" }, "image_url_small": { "type": "string" }, "is_high_latency": { "type": "boolean" }, "language": { "type": "string" }, "media_key": { "type": "string" }, "scheduled_end_ms": { "type": "string" }, "scheduled_start_ms": { "type": "string" }, "share_url": { "type": "string" }, "source_id": { "type": "string" }, "start_ms": { "type": "string" }, "state": { "type": "string" }, "title": { "type": "string" }, "total_watched": { "type": "string" }, "total_watching": { "type": "string" }, "tweet_id": { "type": "string" }, "twitter_user_id": { "type": "string" }, "updated_at_ms": { "type": "string" }, "width": { "type": "integer" } } }, "ChatConversation": { "type": "object", "properties": { "admin_ids": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "group_avatar_url": { "type": "string" }, "group_name": { "type": "string" }, "id": { "type": "string" }, "is_muted": { "type": "boolean" }, "member_ids": { "type": "array", "items": { "type": "string" } }, "message_ttl_ms": { "type": "integer" }, "participant_ids": { "type": "array", "items": { "type": "string" } }, "screen_capture_blocking_enabled": { "type": "boolean" }, "screen_capture_detection_enabled": { "type": "boolean" }, "type": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" } } }, "ChatMediaUploadAppendRequest": { "type": "object", "required": [ "media", "segment_index", "conversation_id", "media_hash_key" ], "properties": { "conversation_id": { "type": "string", "description": "The XChat conversation the upload belongs to." }, "media": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "string", "format": "byte" } ], "description": "The media segment bytes: base64-encoded in JSON bodies, raw bytes in multipart bodies." }, "media_hash_key": { "type": "string", "description": "The media hash key returned by the initialize step." }, "segment_index": { "type": "integer", "description": "The index of this segment in the upload sequence.", "minimum": 0, "maximum": 999 } }, "additionalProperties": false }, "ChatMediaUploadAppendResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChatMediaUploadAppendResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ChatMediaUploadAppendResponseData": { "type": "object", "properties": { "expires_at": { "type": "integer", "description": "Epoch seconds when the upload session expires." } } }, "ChatMediaUploadFinalizeRequest": { "type": "object", "required": [ "conversation_id", "media_hash_key", "num_parts" ], "properties": { "conversation_id": { "type": "string", "description": "The XChat conversation the upload belongs to." }, "media_hash_key": { "type": "string", "description": "The media hash key returned by the initialize step." }, "message_id": { "type": "string", "description": "Optional message identifier associated with the upload." }, "num_parts": { "type": "string", "description": "Total number of uploaded parts, as a numeric string." }, "ttl_msec": { "type": "string", "description": "Optional TTL for the media in milliseconds, as a numeric string." } }, "additionalProperties": false }, "ChatMediaUploadFinalizeResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChatMediaUploadFinalizeResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ChatMediaUploadFinalizeResponseData": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Whether the upload was finalized." } } }, "ChatMediaUploadInitializeRequest": { "type": "object", "required": [ "conversation_id", "total_bytes" ], "properties": { "conversation_id": { "type": "string", "description": "The XChat conversation the upload belongs to." }, "total_bytes": { "type": "integer", "description": "Total size of the media upload in bytes.", "minimum": 0 } }, "additionalProperties": false }, "ChatMediaUploadInitializeResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChatMediaUploadInitializeResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ChatMediaUploadInitializeResponseData": { "type": "object", "required": [ "session_id", "media_hash_key", "conversation_id" ], "properties": { "conversation_id": { "type": "string", "description": "Canonical ID of the conversation." }, "media_hash_key": { "type": "string", "description": "Hash key addressing the uploaded media." }, "session_id": { "type": "string", "description": "Upload session ID." } } }, "ChatMessageEvent": { "type": "object", "properties": { "conversation_id": { "type": "string" }, "conversation_token": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "encoded_event": { "type": "string" }, "id": { "type": "string" }, "is_trusted": { "type": "boolean" }, "message_event_signature": { "type": "object" }, "previous_id": { "type": "string" }, "sender_id": { "type": "string" } } }, "Community": { "type": "object", "properties": { "access": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "join_policy": { "type": "string" }, "member_count": { "type": "integer" }, "name": { "type": "string" } } }, "CommunityId": { "type": "string", "description": "Unique identifier of a Community", "pattern": "^[0-9]{1,19}$" }, "ComplianceJob": { "type": "object", "properties": { "created_at": { "type": "string" }, "download_expires_at": { "type": "string" }, "download_url": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "resumable": { "type": "boolean" }, "status": { "type": "string" }, "type": { "type": "string" }, "upload_expires_at": { "type": "string" }, "upload_url": { "type": "string" } } }, "Connection": { "type": "object", "properties": { "client_ip": { "type": "string" }, "connected_at": { "type": "string", "format": "date-time" }, "disconnect_reason": { "type": "string" }, "disconnected_at": { "type": "string", "format": "date-time" }, "endpoint_name": { "type": "string" }, "id": { "type": "string" } } }, "CountryCode": { "type": "string", "description": "A two-letter ISO 3166-1 alpha-2 country code.", "pattern": "^[A-Z]{2}$", "example": "US" }, "CreateAccountActivitySubscriptionRequest": { "type": "object", "properties": {} }, "CreateAccountActivitySubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateAccountActivitySubscriptionResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateAccountActivitySubscriptionResponseData": { "type": "object", "required": [ "subscribed" ], "properties": { "subscribed": { "type": "boolean", "description": "Whether the subscription is active." } } }, "CreateActivitySubscriptionFilter": { "type": "object", "properties": { "direction": { "type": "string", "description": "Optional direction filter for directional events. Not supported for mute.* or block.* events.", "enum": [ "inbound", "outbound" ] }, "keyword": { "type": "string", "description": "Optional keyword filter." }, "user_id": { "type": "string", "description": "User the subscription is scoped to. For mute.* and block.* events, this must be the authenticated source user." } }, "additionalProperties": false }, "CreateActivitySubscriptionRequest": { "type": "object", "required": [ "event_type", "filter" ], "properties": { "event_type": { "type": "string", "description": "Activity event type in dot notation.", "enum": [ "profile.update.bio", "profile.update.profile_picture", "profile.update.banner_picture", "profile.update.screenname", "profile.update.geo", "profile.update.url", "profile.update.verified_badge", "profile.update.affiliate_badge", "profile.update.handle", "news.new", "follow.follow", "follow.unfollow", "spaces.start", "spaces.end", "chat.received", "chat.sent", "chat.conversation_join", "dm.sent", "dm.received", "dm.indicate_typing", "dm.read", "post.create", "post.delete", "post.mention.create", "like.create", "mute.mute", "mute.unmute", "block.block", "block.unblock" ] }, "filter": { "description": "Subscription filter.", "$ref": "#/components/schemas/CreateActivitySubscriptionFilter" }, "tag": { "type": "string", "description": "Optional caller-defined tag.", "minLength": 1, "maxLength": 200 }, "webhook_id": { "type": "string", "description": "Webhook to deliver the subscription events to.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreateActivitySubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateActivitySubscriptionResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateActivitySubscriptionResponseData": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/CreateActivitySubscriptionResponseDataSubscription" } } }, "CreateActivitySubscriptionResponseDataSubscription": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Subscription creation time." }, "event_type": { "type": "string", "description": "Activity event type in dot notation." }, "filter": { "description": "Subscription filter.", "$ref": "#/components/schemas/CreateActivitySubscriptionResponseDataSubscriptionFilter" }, "subscription_id": { "type": "string", "description": "Unique identifier of the subscription." }, "tag": { "type": "string", "description": "Optional caller-defined tag." }, "updated_at": { "type": "string", "description": "Subscription last-update time." }, "webhook_id": { "type": "string", "description": "Webhook receiving the subscription events." } }, "additionalProperties": false }, "CreateActivitySubscriptionResponseDataSubscriptionFilter": { "type": "object", "properties": { "direction": { "type": "string", "description": "Optional direction filter for directional events. Not present for mute.* or block.* events." }, "keyword": { "type": "string", "description": "Optional keyword filter." }, "user_id": { "type": "string", "description": "User the subscription is scoped to." } }, "additionalProperties": false }, "CreateChatConversationActionSignatures": { "type": "object", "required": [ "message_id", "encoded_message_event_detail", "message_event_signature" ], "properties": { "encoded_message_event_detail": { "type": "string", "description": "Base64-encoded message event detail.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "message_event_signature": { "description": "Message event signature supplied with an action signature.", "$ref": "#/components/schemas/CreateChatConversationActionSignaturesMessageEventSignature" }, "message_id": { "type": "string", "description": "Client-generated ID of the message being signed.", "minLength": 1 }, "signature_payload": { "type": "string", "description": "Payload string the client signed; used only in server-side failure logs." } } }, "CreateChatConversationActionSignaturesMessageEventSignature": { "type": "object", "required": [ "signature", "public_key_version", "signature_version" ], "properties": { "message_signing_key_info_list": { "type": "array", "description": "List of signing key information for message verification.", "items": { "$ref": "#/components/schemas/CreateChatConversationActionSignaturesMessageEventSignatureMessageSigningKeyInfoList" } }, "public_key_version": { "type": "string", "description": "The version of the public key used for signing.", "pattern": "^[0-9]+$" }, "signature": { "type": "string", "description": "The signature of the message event.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "signature_version": { "type": "string", "description": "The version of the signature algorithm.", "pattern": "^[0-9]+$" }, "signing_public_key": { "type": "string", "description": "The public key used for signing." } } }, "CreateChatConversationActionSignaturesMessageEventSignatureMessageSigningKeyInfoList": { "type": "object", "properties": { "member_id": { "type": "string", "description": "The member ID associated with this signing key." }, "public_key_version": { "type": "string", "description": "The version of the public key." }, "signing_public_key": { "type": "string", "description": "The signing public key." } } }, "CreateChatConversationConversationParticipantKeys": { "type": "object", "properties": { "encrypted_conversation_key": { "type": "string", "description": "Conversation key encrypted with this participant's public key." }, "public_key_version": { "type": "string", "description": "Version of the participant's public key used for encryption." }, "user_id": { "type": "string", "description": "Participant user ID." } } }, "CreateChatConversationRequest": { "type": "object", "required": [ "conversation_id", "conversation_key_version", "conversation_participant_keys", "group_members" ], "properties": { "action_signatures": { "type": "array", "description": "Cryptographic signatures for the action.", "items": { "$ref": "#/components/schemas/CreateChatConversationActionSignatures" } }, "base64_encoded_key_rotation": { "type": "string", "description": "Base64-encoded key rotation payload." }, "conversation_id": { "type": "string", "description": "Client-generated conversation ID." }, "conversation_key_version": { "type": "string", "description": "Version of the conversation encryption key." }, "conversation_participant_keys": { "type": "array", "description": "Encrypted conversation keys for each participant.", "items": { "$ref": "#/components/schemas/CreateChatConversationConversationParticipantKeys" } }, "group_admins": { "type": "array", "description": "User IDs of group admins. Defaults to the creator if omitted.", "items": { "type": "string" } }, "group_avatar_url": { "type": "string", "description": "URL of the avatar image for the group conversation." }, "group_description": { "type": "string", "description": "Description for the group conversation." }, "group_members": { "type": "array", "description": "User IDs of group members to include in the conversation.", "items": { "type": "string" } }, "group_name": { "type": "string", "description": "Display name for the group conversation." }, "ttl_msec": { "type": "string", "description": "Message time-to-live in milliseconds. Messages expire after this duration." } } }, "CreateChatConversationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateChatConversationResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateChatConversationResponseData": { "type": "object", "required": [ "conversation_id" ], "properties": { "conversation_id": { "type": "string", "description": "Canonical ID of the created conversation." }, "conversation_key_change_sequence_id": { "type": "string", "description": "Sequence ID of the conversation key change." } } }, "CreateCommunityNotesInfo": { "type": "object", "required": [ "text", "classification", "misleading_tags", "trustworthy_sources" ], "properties": { "classification": { "type": "string", "description": "Community Note classification.", "enum": [ "misinformed_or_potentially_misleading", "not_misleading" ] }, "is_media_note": { "type": "boolean", "description": "Whether the note is a media note." }, "misleading_tags": { "type": "array", "description": "Tags describing why the Post is misleading.", "items": { "type": "string", "enum": [ "disputed_claim_as_fact", "factual_error", "manipulated_media", "misinterpreted_satire", "missing_important_context", "other", "outdated_information" ] } }, "text": { "type": "string", "description": "The text summary of the Community Note (must contain a URL).", "pattern": "^(?=[\\s\\S]*https?://\\S+)[\\s\\S]+$" }, "trustworthy_sources": { "type": "boolean", "description": "Whether the note cites trustworthy sources." } }, "additionalProperties": false }, "CreateCommunityNotesRequest": { "type": "object", "required": [ "test_mode", "post_id", "info" ], "properties": { "info": { "description": "The Community Note contents.", "$ref": "#/components/schemas/CreateCommunityNotesInfo" }, "post_id": { "type": "string", "description": "ID of the Post the note is about.", "pattern": "^[0-9]{1,19}$" }, "test_mode": { "type": "boolean", "description": "If true, the note is only for testing and is not publicly visible." } }, "additionalProperties": false }, "CreateCommunityNotesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateCommunityNotesResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateCommunityNotesResponseData": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the created Community Note." } } }, "CreateComplianceJobsRequest": { "type": "object", "required": [ "type" ], "properties": { "name": { "type": "string", "description": "A user-provided name for this job.", "maxLength": 64 }, "resumable": { "type": "boolean", "description": "Whether to enable the upload URL with support for resumable uploads." }, "type": { "type": "string", "description": "Type of compliance job to list.", "enum": [ "tweets", "users" ] } }, "additionalProperties": false }, "CreateComplianceJobsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ComplianceJob" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateDirectMessagesByConversationIdAttachments": { "type": "object", "required": [ "media_id" ], "properties": { "media_id": { "type": "string", "description": "A media id to attach to the message.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreateDirectMessagesByConversationIdRequest": { "anyOf": [ { "required": [ "text" ] }, { "required": [ "attachments" ] } ], "type": "object", "description": "At least one of `text`, `attachments` is required.", "properties": { "attachments": { "type": "array", "description": "Attachments to include with the message.", "items": { "$ref": "#/components/schemas/CreateDirectMessagesByConversationIdAttachments" } }, "text": { "type": "string", "description": "Text of the Direct Message.", "minLength": 1 } }, "additionalProperties": false }, "CreateDirectMessagesByConversationIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDirectMessagesByConversationIdResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateDirectMessagesByConversationIdResponseData": { "type": "object", "required": [ "dm_conversation_id", "dm_event_id" ], "properties": { "dm_conversation_id": { "type": "string", "description": "The conversation the message was sent to." }, "dm_event_id": { "type": "string", "description": "The id of the created DM event." } } }, "CreateDirectMessagesByParticipantIdAttachments": { "type": "object", "required": [ "media_id" ], "properties": { "media_id": { "type": "string", "description": "A media id to attach to the message.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreateDirectMessagesByParticipantIdRequest": { "anyOf": [ { "required": [ "text" ] }, { "required": [ "attachments" ] } ], "type": "object", "description": "At least one of `text`, `attachments` is required.", "properties": { "attachments": { "type": "array", "description": "Attachments to include with the message.", "items": { "$ref": "#/components/schemas/CreateDirectMessagesByParticipantIdAttachments" } }, "text": { "type": "string", "description": "Text of the Direct Message.", "minLength": 1 } }, "additionalProperties": false }, "CreateDirectMessagesByParticipantIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDirectMessagesByParticipantIdResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateDirectMessagesByParticipantIdResponseData": { "type": "object", "required": [ "dm_conversation_id", "dm_event_id" ], "properties": { "dm_conversation_id": { "type": "string", "description": "The conversation the message was sent to." }, "dm_event_id": { "type": "string", "description": "The id of the created DM event." } } }, "CreateDirectMessagesConversationMessage": { "type": "object", "properties": { "attachments": { "type": "array", "description": "Attachments to include with the message.", "items": { "$ref": "#/components/schemas/CreateDirectMessagesConversationMessageAttachments" } }, "text": { "type": "string", "description": "Text of the Direct Message.", "minLength": 1 } }, "additionalProperties": false }, "CreateDirectMessagesConversationMessageAttachments": { "type": "object", "required": [ "media_id" ], "properties": { "media_id": { "type": "string", "description": "A media id to attach to the message.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreateDirectMessagesConversationRequest": { "type": "object", "required": [ "conversation_type", "participant_ids", "message" ], "properties": { "conversation_type": { "type": "string", "description": "The conversation type to create. Supports `Group` only.", "enum": [ "Group" ] }, "message": { "description": "The initial Direct Message to send to the conversation.", "$ref": "#/components/schemas/CreateDirectMessagesConversationMessage" }, "participant_ids": { "type": "array", "description": "Participants for the conversation.", "minItems": 2, "maxItems": 49, "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } } }, "additionalProperties": false }, "CreateDirectMessagesConversationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDirectMessagesConversationResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateDirectMessagesConversationResponseData": { "type": "object", "required": [ "dm_conversation_id", "dm_event_id" ], "properties": { "dm_conversation_id": { "type": "string", "description": "The id of the created conversation." }, "dm_event_id": { "type": "string", "description": "The id of the created DM event." } } }, "CreateListsRequest": { "type": "object", "required": [ "name" ], "properties": { "description": { "type": "string", "description": "Description of the List (up to 100 characters).", "maxLength": 100 }, "name": { "type": "string", "description": "Name of the List (1-25 characters).", "minLength": 1, "maxLength": 25 }, "private": { "type": "boolean", "description": "Whether the List is private." } }, "additionalProperties": false }, "CreateListsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateListsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateListsResponseData": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the created List." }, "name": { "type": "string", "description": "The name of the created List." } } }, "CreateMediaMetadataMetadata": { "type": "object", "properties": { "allow_download_status": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataAllowDownloadStatus" }, "alt_text": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataAltText" }, "audience_policy": { "type": "object" }, "content_expiration": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataContentExpiration" }, "domain_restrictions": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataDomainRestrictions" }, "found_media_origin": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataFoundMediaOrigin" }, "geo_restrictions": { "type": "object" }, "management_info": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataManagementInfo" }, "preview_image": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataPreviewImage" }, "sensitive_media_warning": { "type": "object" }, "shared_info": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataSharedInfo" }, "sticker_info": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataStickerInfo" }, "upload_source": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataUploadSource" } } }, "CreateMediaMetadataMetadataAllowDownloadStatus": { "type": "object", "properties": { "allow_download": { "type": "boolean" } } }, "CreateMediaMetadataMetadataAltText": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "maxLength": 1000 } } }, "CreateMediaMetadataMetadataContentExpiration": { "type": "object", "required": [ "timestamp_sec" ], "properties": { "timestamp_sec": { "type": "number" } } }, "CreateMediaMetadataMetadataDomainRestrictions": { "type": "object", "required": [ "whitelist" ], "properties": { "whitelist": { "type": "array", "items": { "type": "string" } } } }, "CreateMediaMetadataMetadataFoundMediaOrigin": { "type": "object", "required": [ "provider", "id" ], "properties": { "id": { "type": "string" }, "provider": { "type": "string" } } }, "CreateMediaMetadataMetadataManagementInfo": { "type": "object", "required": [ "managed" ], "properties": { "managed": { "type": "boolean" } } }, "CreateMediaMetadataMetadataPreviewImage": { "type": "object", "required": [ "media_key" ], "properties": { "media_key": { "type": "object" } } }, "CreateMediaMetadataMetadataSharedInfo": { "type": "object", "required": [ "shared" ], "properties": { "shared": { "type": "boolean" } } }, "CreateMediaMetadataMetadataStickerInfo": { "type": "object", "required": [ "stickers" ], "properties": { "stickers": { "type": "array", "items": { "$ref": "#/components/schemas/CreateMediaMetadataMetadataStickerInfoStickers" } } } }, "CreateMediaMetadataMetadataStickerInfoStickers": { "type": "object", "properties": {} }, "CreateMediaMetadataMetadataUploadSource": { "type": "object", "required": [ "upload_source" ], "properties": { "upload_source": { "type": "string" } } }, "CreateMediaMetadataRequest": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The media id the metadata is attached to.", "pattern": "^[0-9]{1,19}$" }, "metadata": { "description": "User-defined metadata to associate with the media.", "$ref": "#/components/schemas/CreateMediaMetadataMetadata" } } }, "CreateMediaMetadataResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateMediaMetadataResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateMediaMetadataResponseData": { "type": "object", "required": [ "id" ], "properties": { "associated_metadata": { "type": "object", "description": "The metadata now associated with the media." }, "id": { "type": "string", "description": "The media id the metadata was attached to." } } }, "CreateMediaSubtitlesRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "The media id of the video the subtitles belong to.", "pattern": "^[0-9]{1,19}$" }, "media_category": { "type": "string", "description": "The media category of the target media.", "enum": [ "AmplifyVideo", "TweetVideo" ] }, "subtitles": { "description": "The subtitle tracks to associate with the media.", "$ref": "#/components/schemas/CreateMediaSubtitlesSubtitles" } } }, "CreateMediaSubtitlesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateMediaSubtitlesResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateMediaSubtitlesResponseData": { "type": "object", "properties": { "associated_subtitles": { "type": "object", "description": "The subtitles now associated with the media." }, "id": { "type": "string", "description": "The media id." }, "media_category": { "type": "string", "description": "The media category." } } }, "CreateMediaSubtitlesSubtitles": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Language name in a human readable form." }, "id": { "type": "string", "description": "The media id of the subtitle track.", "pattern": "^[0-9]{1,19}$" }, "language_code": { "type": "string", "description": "BCP47 language code of the subtitle track.", "pattern": "^[A-Z]{2}$" } } }, "CreatePostsEditOptions": { "type": "object", "required": [ "previous_post_id" ], "properties": { "previous_post_id": { "type": "string", "description": "The ID of the Post being edited.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreatePostsGeo": { "type": "object", "required": [ "place_id" ], "properties": { "place_id": { "type": "string", "description": "Place ID for geo tagging." } }, "additionalProperties": false }, "CreatePostsMedia": { "type": "object", "required": [ "media_ids" ], "properties": { "call_to_actions": { "description": "Call-to-action button rendered on the media entity.", "$ref": "#/components/schemas/CreatePostsMediaCallToActions" }, "description": { "type": "string", "description": "Description for the media, rendered on the Post card for video and Amplify content." }, "embeddable": { "type": "boolean", "description": "When true, the media's asset URLs do not expire and external syndicated playback is allowed." }, "media_ids": { "type": "array", "description": "Media IDs to attach to the tweet.", "minItems": 1, "maxItems": 4, "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "preview_media_id": { "type": "string", "description": "Media id whose asset is used as the preview image.", "pattern": "^[0-9]{1,19}$" }, "tagged_user_ids": { "type": "array", "description": "User IDs tagged in the media.", "maxItems": 10, "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "title": { "type": "string", "description": "Title for the media, rendered on the Post card for video and Amplify content." } }, "additionalProperties": false }, "CreatePostsMediaCallToActions": { "type": "object", "properties": { "app_install": { "description": "App Install CTA. At least one store id should be provided.", "$ref": "#/components/schemas/CreatePostsMediaCallToActionsAppInstall" }, "visit_site": { "description": "Visit Site CTA.", "$ref": "#/components/schemas/CreatePostsMediaCallToActionsVisitSite" }, "watch_now": { "description": "Watch Now CTA.", "$ref": "#/components/schemas/CreatePostsMediaCallToActionsWatchNow" } }, "additionalProperties": false }, "CreatePostsMediaCallToActionsAppInstall": { "type": "object", "properties": { "app_store_id": { "type": "string", "description": "Apple App Store iPhone app id." }, "ipad_app_store_id": { "type": "string", "description": "Apple App Store iPad app id." }, "play_store_id": { "type": "string", "description": "Google Play Store app id." } }, "additionalProperties": false }, "CreatePostsMediaCallToActionsVisitSite": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "HTTPS URL the CTA links to." } }, "additionalProperties": false }, "CreatePostsMediaCallToActionsWatchNow": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "HTTPS URL the CTA links to." } }, "additionalProperties": false }, "CreatePostsPoll": { "type": "object", "required": [ "options", "duration_minutes" ], "properties": { "duration_minutes": { "type": "integer", "description": "Duration of the poll in minutes.", "minimum": 5, "maximum": 10080 }, "options": { "type": "array", "description": "Poll options (2-4 choices, 1-25 characters each).", "minItems": 2, "maxItems": 4, "items": { "type": "string", "minLength": 1, "maxLength": 25 } }, "reply_settings": { "type": "string", "description": "Who can reply to the poll Tweet. Accepted for compatibility; it carries no backend argument and is dropped before the mutation is issued (see `translate_body`).", "enum": [ "following", "mentionedUsers", "subscribers", "verified" ] } }, "additionalProperties": false }, "CreatePostsReply": { "type": "object", "required": [ "in_reply_to_tweet_id" ], "properties": { "auto_populate_reply_metadata": { "type": "boolean", "description": "If true, reply metadata is automatically populated. Accepted for compatibility; it carries no backend argument and is dropped before the mutation is issued (see `translate_body`)." }, "exclude_reply_user_ids": { "type": "array", "description": "User IDs to exclude from the reply thread.", "items": { "type": "string" } }, "in_reply_to_tweet_id": { "type": "string", "description": "The ID of the tweet being replied to.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreatePostsRequest": { "type": "object", "properties": { "card_uri": { "type": "string", "description": "Card URI parameter." }, "community_id": { "type": "string", "description": "Community to post the tweet to.", "pattern": "^[0-9]{1,19}$" }, "direct_message_deep_link": { "type": "string", "description": "Direct message deep link." }, "edit_options": { "description": "Edit an existing tweet rather than creating a new one.", "$ref": "#/components/schemas/CreatePostsEditOptions" }, "for_super_followers_only": { "type": "boolean", "description": "Restrict tweet to super followers." }, "geo": { "description": "Geo location for the tweet.", "$ref": "#/components/schemas/CreatePostsGeo" }, "made_with_ai": { "type": "boolean", "description": "Disclose that the tweet contains AI-generated media." }, "media": { "description": "Media attachments.", "$ref": "#/components/schemas/CreatePostsMedia" }, "nullcast": { "type": "boolean", "description": "If true, the tweet is not shown in the public timeline." }, "paid_partnership": { "type": "boolean", "description": "Disclose that the tweet is a paid partnership." }, "poll": { "description": "Poll configuration.", "$ref": "#/components/schemas/CreatePostsPoll" }, "quote_tweet_id": { "type": "string", "description": "Tweet ID to quote.", "pattern": "^[0-9]{1,19}$" }, "reply": { "description": "Tweet reply configuration.", "$ref": "#/components/schemas/CreatePostsReply" }, "reply_settings": { "type": "string", "description": "Who can reply to this tweet.", "enum": [ "following", "mentionedUsers", "subscribers", "verified" ] }, "share_with_followers": { "type": "boolean", "description": "Share an exclusive (super-follower) tweet with all followers." }, "text": { "type": "string", "description": "Text of the tweet. Required unless media is provided. Defaulted to an empty string so it is always sent: the backend's `tweet_text` variable is non-null and rejects an absent value.", "default": "" } }, "additionalProperties": false }, "CreatePostsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreatePostsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreatePostsResponseData": { "type": "object", "required": [ "id", "text" ], "properties": { "edit_history_post_ids": { "type": "array", "description": "Post IDs in this Post's edit history chain.", "items": { "type": "string" } }, "id": { "type": "string", "description": "Unique identifier of the created Post.", "pattern": "^[0-9]{1,19}$" }, "text": { "type": "string", "description": "The content of the created Post." } } }, "CreateScheduledBroadcastRecurrence": { "type": "object", "required": [ "frequency", "repeats" ], "properties": { "frequency": { "type": "string", "description": "Recurrence frequency.", "enum": [ "Daily", "Weekly" ] }, "repeats": { "type": "string", "description": "Number of repeats (numeric string).", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreateScheduledBroadcastRequest": { "type": "object", "required": [ "source_id", "scheduled_start_ms", "scheduled_end_ms" ], "properties": { "available_for_replay": { "type": "boolean", "description": "Enable replay." }, "chat_option": { "type": "string", "description": "Chat permission option (numeric string).", "pattern": "^[0-9]{1,19}$" }, "description": { "type": "string", "description": "Description." }, "is_locked": { "type": "boolean", "description": "Lock the broadcast." }, "locale": { "type": "string", "description": "Locale." }, "manual_publish": { "type": "boolean", "description": "If true, do not auto-publish at start; call POST .../live when ready." }, "recurrence": { "description": "If set, creates a recurring series.", "$ref": "#/components/schemas/CreateScheduledBroadcastRecurrence" }, "scheduled_end_ms": { "type": "string", "description": "End time, ms since Unix epoch (decimal string).", "pattern": "^[0-9]{1,19}$" }, "scheduled_start_ms": { "type": "string", "description": "Start time, ms since Unix epoch (decimal string).", "pattern": "^[0-9]{1,19}$" }, "source_id": { "type": "string", "description": "Ingest / source id to bind (same as sources `rtmp_stream_key`).", "minLength": 1 }, "telecast_id": { "type": "string", "description": "Optional telecast id (numeric string).", "pattern": "^[0-9]{1,19}$" }, "thumbnail_media_id": { "type": "string", "description": "Pre-live slate media id (numeric string).", "pattern": "^[0-9]{1,19}$" }, "title": { "type": "string", "description": "Title / status text." } }, "additionalProperties": false }, "CreateScheduledBroadcastResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateScheduledBroadcastResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateScheduledBroadcastResponseData": { "type": "object", "properties": { "available_for_replay": { "type": "boolean", "description": "Whether replay is enabled." }, "broadcast_id": { "type": "string", "description": "Alphanumeric UBS broadcast id (path `:id` for get/update/delete/live)." }, "chat_option": { "type": "string", "description": "Optional chat permission option." }, "description": { "type": "string", "description": "Optional description." }, "locale": { "type": "string", "description": "Optional locale." }, "manual_publish": { "type": "boolean", "description": "When true, coordinator will not auto-publish; call POST .../live when ready." }, "recurring_schedule_id": { "type": "string", "description": "Set when this occurrence belongs to a recurrence." }, "scheduled_broadcast_id": { "type": "string", "description": "Numeric scheduler id. Required in the update request body." }, "scheduled_end_ms": { "type": "string", "description": "Scheduled end, milliseconds since Unix epoch (decimal string)." }, "scheduled_start_ms": { "type": "string", "description": "Scheduled start, milliseconds since Unix epoch (decimal string)." }, "source_id": { "type": "string", "description": "Bound ingest / source id (`rtmp_stream_key`)." }, "state": { "type": "string", "description": "Scheduler state (Created, Scheduled, Running, …)." }, "telecast_id": { "type": "string", "description": "Optional telecast association." }, "thumbnail_media_id": { "type": "string", "description": "Optional pre-live slate media id." }, "title": { "type": "string", "description": "Broadcast title / status text." } } }, "CreateUsersBookmarkFolderRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Bookmark folder (1-25 characters).", "minLength": 1, "maxLength": 25 } }, "additionalProperties": false }, "CreateUsersBookmarkFolderResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateUsersBookmarkFolderResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateUsersBookmarkFolderResponseData": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the created Bookmark folder." }, "name": { "type": "string", "description": "The name of the created Bookmark folder." } } }, "CreateUsersBookmarkRequest": { "type": "object", "required": [ "tweet_id" ], "properties": { "folder_id": { "type": "string", "description": "Optional ID of the Bookmark folder to add the Post to. When omitted, the Post is added to the user's top-level Bookmarks only.", "pattern": "^[0-9]{1,19}$" }, "tweet_id": { "type": "string", "description": "The ID of the Post to add to the user's Bookmarks.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "CreateUsersBookmarkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateUsersBookmarkResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateUsersBookmarkResponseData": { "type": "object", "required": [ "bookmarked" ], "properties": { "bookmarked": { "type": "boolean", "description": "Indicates whether the Post is bookmarked by the user." } } }, "CreateWebhookReplayJobRequest": { "type": "object", "required": [ "webhook_id", "from_date", "to_date" ], "properties": { "from_date": { "type": "string", "description": "The oldest (inclusive) UTC timestamp from which events are replayed, in yyyymmddhhmm format.", "pattern": "^[0-9]{12}$" }, "to_date": { "type": "string", "description": "The newest (inclusive) UTC timestamp up to which events are replayed, in yyyymmddhhmm format.", "pattern": "^[0-9]{12}$" }, "webhook_id": { "type": "string", "description": "The ID of the webhook to replay events to.", "pattern": "^[0-9]{1,19}$" } } }, "CreateWebhookReplayJobResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateWebhookReplayJobResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateWebhookReplayJobResponseData": { "type": "object", "required": [ "job_id", "created_at" ], "properties": { "created_at": { "type": "string", "description": "The UTC timestamp when the replay job was created." }, "job_id": { "type": "string", "description": "The unique identifier for the initiated replay job." } } }, "CreateWebhooksRequest": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL the webhook delivers events to.", "minLength": 1, "maxLength": 200 } } }, "CreateWebhooksResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateWebhooksResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateWebhooksResponseData": { "type": "object", "required": [ "id", "url", "valid", "created_at" ], "properties": { "created_at": { "type": "string", "description": "Creation time of the webhook configuration." }, "id": { "type": "string", "description": "Unique identifier of the webhook configuration." }, "url": { "type": "string", "description": "The URL the webhook delivers events to." }, "valid": { "type": "boolean", "description": "Indicates whether the webhook URL passed validation." } } }, "CreateWebhooksStreamLinkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateWebhooksStreamLinkResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "CreateWebhooksStreamLinkResponseData": { "type": "object", "required": [ "provisioned" ], "properties": { "provisioned": { "type": "boolean", "description": "Indicates whether the stream link was provisioned." } } }, "DeleteAccountActivitySubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteAccountActivitySubscriptionResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteAccountActivitySubscriptionResponseData": { "type": "object", "required": [ "subscribed" ], "properties": { "subscribed": { "type": "boolean", "description": "Whether the user has an active subscription." } } }, "DeleteActivitySubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteActivitySubscriptionResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteActivitySubscriptionResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Whether the subscription was deleted." } } }, "DeleteActivitySubscriptionsByIdsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Whether the subscription was deleted." }, "subscription_id": { "type": "string", "description": "Id of the deleted subscription." } } } }, "errors": { "type": "array", "description": "Per-id failures; deletion continues for the remaining ids.", "items": { "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable failure detail." }, "reason": { "type": "string", "description": "Machine-readable failure reason." }, "subscription_id": { "type": "string", "description": "Id the failure applies to." } } } }, "meta": { "type": "object", "properties": { "total_subscriptions": { "type": "integer", "description": "Subscriptions remaining after deletion.", "format": "int32" } } } } }, "DeleteAllConnectionsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteAllConnectionsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteAllConnectionsResponseData": { "type": "object", "required": [ "successful_kills", "failed_kills" ], "properties": { "failed_kills": { "type": "integer", "description": "Number of connections that could not be terminated." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteAllConnectionsResponseDataResults" } }, "successful_kills": { "type": "integer", "description": "Number of connections successfully terminated." } } }, "DeleteAllConnectionsResponseDataResults": { "type": "object", "required": [ "uuid", "success" ], "properties": { "error_message": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false }, "DeleteChatMessagesActionSignatures": { "type": "object", "required": [ "message_id", "encoded_message_event_detail", "message_event_signature" ], "properties": { "encoded_message_event_detail": { "type": "string", "description": "Base64-encoded message event detail.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "message_event_signature": { "description": "Message event signature supplied with an action signature.", "$ref": "#/components/schemas/DeleteChatMessagesActionSignaturesMessageEventSignature" }, "message_id": { "type": "string", "description": "Client-generated ID of the message being signed.", "minLength": 1 }, "signature_payload": { "type": "string", "description": "Payload string the client signed; used only in server-side failure logs." } } }, "DeleteChatMessagesActionSignaturesMessageEventSignature": { "type": "object", "required": [ "signature", "public_key_version", "signature_version" ], "properties": { "message_signing_key_info_list": { "type": "array", "description": "List of signing key information for message verification.", "items": { "$ref": "#/components/schemas/DeleteChatMessagesActionSignaturesMessageEventSignatureMessageSigningKeyInfoList" } }, "public_key_version": { "type": "string", "description": "The version of the public key used for signing.", "pattern": "^[0-9]+$" }, "signature": { "type": "string", "description": "The signature of the message event.", "minLength": 1, "pattern": "^[A-Za-z0-9+/=_-]+$" }, "signature_version": { "type": "string", "description": "The version of the signature algorithm.", "pattern": "^[0-9]+$" }, "signing_public_key": { "type": "string", "description": "The public key used for signing." } } }, "DeleteChatMessagesActionSignaturesMessageEventSignatureMessageSigningKeyInfoList": { "type": "object", "properties": { "member_id": { "type": "string", "description": "The member ID associated with this signing key." }, "public_key_version": { "type": "string", "description": "The version of the public key." }, "signing_public_key": { "type": "string", "description": "The signing public key." } } }, "DeleteChatMessagesRequest": { "type": "object", "required": [ "sequence_ids", "delete_message_action", "action_signatures" ], "properties": { "action_signatures": { "type": "array", "description": "Cryptographic signatures for the action.", "items": { "$ref": "#/components/schemas/DeleteChatMessagesActionSignatures" } }, "delete_message_action": { "type": "string", "description": "delete_for_all removes the messages for every participant; delete_for_self removes them only from the authenticated user's view.", "enum": [ "delete_for_all", "delete_for_self" ] }, "media_hash_keys": { "type": "array", "description": "Hash keys of encrypted media blobs to delete alongside the messages (delete_for_all only).", "items": { "type": "string" } }, "sequence_ids": { "type": "array", "description": "Sequence IDs of the messages to delete.", "minItems": 1, "items": { "type": "string" } } } }, "DeleteChatMessagesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteChatMessagesResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteChatMessagesResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Whether the messages were deleted." } } }, "DeleteCommunityNotesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteCommunityNotesResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteCommunityNotesResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the Community Note was deleted." } } }, "DeleteConnectionsByEndpointResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteConnectionsByEndpointResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteConnectionsByEndpointResponseData": { "type": "object", "required": [ "successful_kills", "failed_kills" ], "properties": { "failed_kills": { "type": "integer", "description": "Number of connections that could not be terminated." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteConnectionsByEndpointResponseDataResults" } }, "successful_kills": { "type": "integer", "description": "Number of connections successfully terminated." } } }, "DeleteConnectionsByEndpointResponseDataResults": { "type": "object", "required": [ "uuid", "success" ], "properties": { "error_message": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false }, "DeleteConnectionsByUuidsRequest": { "type": "object", "required": [ "uuids" ], "properties": { "uuids": { "type": "array", "description": "Connection UUIDs to terminate (1-100).", "minItems": 1, "maxItems": 100, "items": { "type": "string" } } }, "additionalProperties": false }, "DeleteConnectionsByUuidsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteConnectionsByUuidsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteConnectionsByUuidsResponseData": { "type": "object", "required": [ "successful_kills", "failed_kills" ], "properties": { "failed_kills": { "type": "integer", "description": "Number of connections that could not be terminated." }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteConnectionsByUuidsResponseDataResults" } }, "successful_kills": { "type": "integer", "description": "Number of connections successfully terminated." } } }, "DeleteConnectionsByUuidsResponseDataResults": { "type": "object", "required": [ "uuid", "success" ], "properties": { "error_message": { "type": "string" }, "success": { "type": "boolean" }, "uuid": { "type": "string" } }, "additionalProperties": false }, "DeleteDirectMessagesEventsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteDirectMessagesEventsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteDirectMessagesEventsResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Whether the event was deleted." } } }, "DeleteListsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteListsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteListsResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the List was deleted." } } }, "DeleteMediaSubtitlesRequest": { "type": "object", "required": [ "id", "media_category", "language_code" ], "properties": { "id": { "type": "string", "description": "The media id of the video the subtitles belong to." }, "language_code": { "type": "string", "description": "The language code of the subtitles to delete." }, "media_category": { "type": "string", "description": "The media category of the target media." } } }, "DeleteMediaSubtitlesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteMediaSubtitlesResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteMediaSubtitlesResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the subtitles were deleted." } } }, "DeletePostsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeletePostsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeletePostsResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Whether the Post was deleted." } } }, "DeleteScheduledBroadcastResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteScheduledBroadcastResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteScheduledBroadcastResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Whether the scheduled broadcast was deleted." } } }, "DeleteUsersBookmarkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteUsersBookmarkResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteUsersBookmarkResponseData": { "type": "object", "required": [ "bookmarked" ], "properties": { "bookmarked": { "type": "boolean", "description": "Whether the Post is bookmarked." } } }, "DeleteWebhooksResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteWebhooksResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteWebhooksResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the webhook configuration was deleted." } } }, "DeleteWebhooksStreamLinkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteWebhooksStreamLinkResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "DeleteWebhooksStreamLinkResponseData": { "type": "object", "required": [ "deleted" ], "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the stream link was deleted." } } }, "DisallowedResourceProblem": { "type": "object", "required": [ "type", "title", "detail" ], "properties": { "detail": { "type": "string" }, "resource_id": { "type": "string" }, "resource_type": { "type": "string" }, "section": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/disallowed-resource" ] } } }, "DmEvent": { "type": "object", "properties": { "attachments": { "$ref": "#/components/schemas/DmEventAttachments" }, "created_at": { "type": "string", "format": "date-time" }, "dm_conversation_id": { "type": "string" }, "entities": { "$ref": "#/components/schemas/DmEventEntities" }, "event_type": { "type": "string" }, "id": { "type": "string" }, "participant_ids": { "type": "array", "items": { "type": "string" } }, "referenced_posts": { "$ref": "#/components/schemas/DmEventReferencedPosts" }, "sender_id": { "type": "string" }, "text": { "type": "string" } } }, "DmEventAttachments": { "type": "object", "description": "Media and card attachments present in this Direct Message event.", "properties": { "card_ids": { "type": "array", "description": "IDs of cards attached to this Direct Message.", "items": { "type": "string" }, "nullable": true }, "media_keys": { "type": "array", "description": "Media keys of media (including audio) attached to this Direct Message.", "items": { "type": "string" }, "nullable": true } } }, "DmEventEntities": { "type": "object", "description": "A list of metadata entities (hashtags, cashtags, mentions, URLs) found in the Direct Message text.", "properties": { "cashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "hashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "mentions": { "type": "array", "items": { "type": "object", "description": "A user mention entity.", "required": [ "start", "end", "username" ], "properties": { "end": { "type": "integer", "format": "int64" }, "id": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "username": { "type": "string" } } }, "nullable": true }, "urls": { "type": "array", "items": { "type": "object", "description": "A URL entity.", "required": [ "start", "end", "url" ], "properties": { "display_url": { "type": "string", "description": "The URL as displayed in the Direct Message text.", "nullable": true }, "end": { "type": "integer", "format": "int64" }, "expanded_url": { "type": "string", "description": "The fully resolved URL.", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "url": { "type": "string", "description": "The t.co shortened URL." } } }, "nullable": true } } }, "DmEventReferencedPosts": { "type": "array", "items": { "type": "object", "description": "A reference from this event to a Post.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the referenced Post." } } } }, "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } }, "EvaluateCommunityNotesRequest": { "type": "object", "required": [ "post_id", "note_text" ], "properties": { "note_text": { "type": "string", "description": "Text of the community note to evaluate." }, "post_id": { "type": "string", "description": "ID of the Post the note evaluates.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "EvaluateCommunityNotesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EvaluateCommunityNotesResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "EvaluateCommunityNotesResponseData": { "type": "object", "properties": { "claim_opinion_score": { "type": "number", "description": "The evaluated claim-opinion score for the note." } } }, "Expansions": { "type": "object", "properties": { "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "places": { "type": "array", "items": { "$ref": "#/components/schemas/Place" } }, "polls": { "type": "array", "items": { "$ref": "#/components/schemas/Poll" } }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "topics": { "type": "array", "items": { "$ref": "#/components/schemas/Topic" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "FieldHydrationFailureProblem": { "type": "object", "required": [ "type", "title", "detail", "field" ], "properties": { "detail": { "type": "string" }, "field": { "type": "string" }, "resource_type": { "type": "string" }, "section": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/field-hydration-failure" ] } } }, "FieldUnauthorizedProblem": { "type": "object", "required": [ "type", "title", "detail", "field" ], "properties": { "detail": { "type": "string" }, "field": { "type": "string" }, "resource_type": { "type": "string" }, "section": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/field-unauthorized" ] } } }, "FinalizeMediaUploadResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinalizeMediaUploadResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "FinalizeMediaUploadResponseData": { "type": "object", "required": [ "id" ], "properties": { "expires_after_secs": { "type": "integer", "description": "Seconds until the upload session expires." }, "id": { "type": "string", "description": "Unique identifier of the media." }, "image": { "$ref": "#/components/schemas/FinalizeMediaUploadResponseDataImage" }, "media_key": { "type": "string", "description": "The media key for the uploaded media." }, "processing_info": { "$ref": "#/components/schemas/FinalizeMediaUploadResponseDataProcessingInfo" }, "size": { "type": "integer", "description": "Total size of the media in bytes." }, "video": { "$ref": "#/components/schemas/FinalizeMediaUploadResponseDataVideo" } } }, "FinalizeMediaUploadResponseDataImage": { "type": "object", "properties": { "h": { "type": "integer", "description": "Height in pixels." }, "image_type": { "type": "string", "description": "MIME type of the uploaded image." }, "w": { "type": "integer", "description": "Width in pixels." } }, "additionalProperties": false }, "FinalizeMediaUploadResponseDataProcessingInfo": { "type": "object", "properties": { "check_after_secs": { "type": "integer", "description": "Seconds to wait before polling status again." }, "progress_percent": { "type": "integer", "description": "Processing completion percentage." }, "state": { "type": "string", "description": "Processing state (pending, in_progress, failed, succeeded)." } }, "additionalProperties": false }, "FinalizeMediaUploadResponseDataVideo": { "type": "object", "properties": { "video_type": { "type": "string", "description": "MIME type of the processed video." } }, "additionalProperties": false }, "FollowActivityResponsePayload": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/User" }, "target": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "FollowListRequest": { "type": "object", "required": [ "list_id" ], "properties": { "list_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "FollowListResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FollowListResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "FollowListResponseData": { "type": "object", "required": [ "following" ], "properties": { "following": { "type": "boolean", "description": "Whether the user is following the List." } } }, "FollowUserRequest": { "type": "object", "required": [ "target_user_id" ], "properties": { "target_user_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "FollowUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FollowUserResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "FollowUserResponseData": { "type": "object", "required": [ "following", "pending_follow" ], "properties": { "following": { "type": "boolean", "description": "Whether the source User is following the target User." }, "pending_follow": { "type": "boolean", "description": "Whether the follow request is pending the target User's approval." } } }, "GetAccountActivitySubscriptionCountResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetAccountActivitySubscriptionCountResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetAccountActivitySubscriptionCountResponseData": { "type": "object", "properties": { "account_name": { "type": "string", "description": "Name of the subscribing account." }, "provisioned_count": { "type": "string", "description": "Number of subscriptions provisioned for the app." }, "subscriptions_count_all": { "type": "string", "description": "Number of active subscriptions across all event types." }, "subscriptions_count_direct_messages": { "type": "string", "description": "Number of active Direct Message subscriptions." } } }, "GetAccountActivitySubscriptionsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetAccountActivitySubscriptionsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetAccountActivitySubscriptionsResponseData": { "type": "object", "properties": { "application_id": { "type": "string", "description": "App the subscriptions belong to." }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/GetAccountActivitySubscriptionsResponseDataSubscriptions" } }, "webhook_id": { "type": "string", "description": "Webhook receiving the subscription events." }, "webhook_url": { "type": "string", "description": "URL the webhook delivers events to." } } }, "GetAccountActivitySubscriptionsResponseDataSubscriptions": { "type": "object", "properties": { "user_id": { "type": "string", "description": "Subscribed user." } }, "additionalProperties": false }, "GetActivitySubscriptionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetActivitySubscriptionsResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetActivitySubscriptionsResponseData": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Subscription creation time." }, "event_type": { "type": "string", "description": "Activity event type in dot notation." }, "filter": { "$ref": "#/components/schemas/GetActivitySubscriptionsResponseDataFilter" }, "subscription_id": { "type": "string", "description": "Unique identifier of the subscription." }, "tag": { "type": "string", "description": "Optional caller-defined tag." }, "updated_at": { "type": "string", "description": "Subscription last-update time." }, "webhook_id": { "type": "string", "description": "Webhook receiving the subscription events." } } }, "GetActivitySubscriptionsResponseDataFilter": { "type": "object", "properties": { "direction": { "type": "string", "description": "Optional direction filter for directional events. Not present for mute.* or block.* events." }, "keyword": { "type": "string", "description": "Optional keyword filter." }, "user_id": { "type": "string", "description": "User the subscription is scoped to." } }, "additionalProperties": false }, "GetBroadcastResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Broadcast" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetChatConversationEventsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessageEvent" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "conversation_key_events": { "type": "array", "items": { "type": "string" } }, "has_more": { "type": "boolean" }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetChatConversationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChatConversation" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetChatConversationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatConversation" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "has_message_requests": { "type": "boolean" }, "has_more": { "type": "boolean" }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetCommunitiesByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Community" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetComplianceJobsByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ComplianceJob" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetComplianceJobsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ComplianceJob" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetConnectionHistoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetDirectMessagesEventsByConversationIdResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmEvent" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetDirectMessagesEventsByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DmEvent" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetDirectMessagesEventsByParticipantIdResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmEvent" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetDirectMessagesEventsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DmEvent" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetListsByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/List" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetListsFollowersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetListsMembersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetListsPostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetMediaAnalyticsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAnalytics" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetMediaByMediaKeyResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Media" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetMediaByMediaKeysResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetMediaUploadStatusResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetMediaUploadStatusResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetMediaUploadStatusResponseData": { "type": "object", "required": [ "id" ], "properties": { "expires_after_secs": { "type": "integer", "description": "Seconds until the upload session expires." }, "id": { "type": "string", "description": "Unique identifier of the media." }, "image": { "$ref": "#/components/schemas/GetMediaUploadStatusResponseDataImage" }, "media_key": { "type": "string", "description": "The media key for the uploaded media." }, "processing_info": { "$ref": "#/components/schemas/GetMediaUploadStatusResponseDataProcessingInfo" }, "size": { "type": "integer", "description": "Total size of the media in bytes." }, "video": { "$ref": "#/components/schemas/GetMediaUploadStatusResponseDataVideo" } } }, "GetMediaUploadStatusResponseDataImage": { "type": "object", "properties": { "h": { "type": "integer", "description": "Height in pixels." }, "image_type": { "type": "string", "description": "MIME type of the uploaded image." }, "w": { "type": "integer", "description": "Width in pixels." } }, "additionalProperties": false }, "GetMediaUploadStatusResponseDataProcessingInfo": { "type": "object", "properties": { "check_after_secs": { "type": "integer", "description": "Seconds to wait before polling status again." }, "progress_percent": { "type": "integer", "description": "Processing completion percentage." }, "state": { "type": "string", "description": "Processing state (pending, in_progress, failed, succeeded)." } }, "additionalProperties": false }, "GetMediaUploadStatusResponseDataVideo": { "type": "object", "properties": { "video_type": { "type": "string", "description": "MIME type of the processed video." } }, "additionalProperties": false }, "GetNewsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/News" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetPostsAnalyticsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Analytics" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetPostsByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetPostsByIdsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetPostsCountsAllResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetPostsCountsAllResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "total_post_count": { "type": "integer", "format": "int64" } } } } }, "GetPostsCountsAllResponseData": { "type": "object", "required": [ "start", "end", "post_count" ], "properties": { "end": { "type": "string", "description": "End of the count bucket (exclusive), RFC 3339." }, "post_count": { "type": "integer", "description": "Number of Posts in the bucket." }, "start": { "type": "string", "description": "Start of the count bucket (inclusive), RFC 3339." } } }, "GetPostsCountsRecentResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetPostsCountsRecentResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "total_post_count": { "type": "integer", "format": "int64" } } } } }, "GetPostsCountsRecentResponseData": { "type": "object", "required": [ "start", "end", "post_count" ], "properties": { "end": { "type": "string", "description": "End of the count bucket (exclusive), RFC 3339." }, "post_count": { "type": "integer", "description": "Number of Posts in the bucket." }, "start": { "type": "string", "description": "Start of the count bucket (inclusive), RFC 3339." } } }, "GetPostsLikingUsersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetPostsQuotedPostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetPostsRepostedByResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetPostsRepostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetRuleCountsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetRuleCountsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetRuleCountsResponseData": { "type": "object", "required": [ "cap_per_client_app", "cap_per_project", "project_rules_count", "client_app_rules_count" ], "properties": { "all_project_client_apps": { "type": "array", "description": "Per-client-app rule counts across the project.", "items": { "$ref": "#/components/schemas/GetRuleCountsResponseDataAllProjectClientApps" } }, "cap_per_client_app": { "type": "string", "description": "Maximum number of rules allowed per client application." }, "cap_per_project": { "type": "string", "description": "Maximum number of rules allowed across the project." }, "client_app_rules_count": { "description": "The calling client application's own rule count.", "$ref": "#/components/schemas/GetRuleCountsResponseDataClientAppRulesCount" }, "project_rules_count": { "type": "string", "description": "Number of rules across every client application in the project." } } }, "GetRuleCountsResponseDataAllProjectClientApps": { "type": "object", "required": [ "rule_count" ], "properties": { "client_app_id": { "type": "string", "description": "Unique identifier of the client application." }, "rule_count": { "type": "integer", "description": "Number of rules configured for the client application." } }, "additionalProperties": false }, "GetRuleCountsResponseDataClientAppRulesCount": { "type": "object", "required": [ "rule_count" ], "properties": { "client_app_id": { "type": "string", "description": "Unique identifier of the client application." }, "rule_count": { "type": "integer", "description": "Number of rules configured for the client application." } }, "additionalProperties": false }, "GetRulesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetRulesResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetRulesResponseData": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the rule." }, "tag": { "type": "string", "description": "Optional caller-defined label for the rule." }, "value": { "type": "string", "description": "The rule's filter expression." } } }, "GetScheduledBroadcastResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetScheduledBroadcastResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetScheduledBroadcastResponseData": { "type": "object", "properties": { "available_for_replay": { "type": "boolean", "description": "Whether replay is enabled." }, "broadcast_id": { "type": "string", "description": "Alphanumeric UBS broadcast id (path `:id` for get/update/delete/live)." }, "chat_option": { "type": "string", "description": "Optional chat permission option." }, "description": { "type": "string", "description": "Optional description." }, "locale": { "type": "string", "description": "Optional locale." }, "manual_publish": { "type": "boolean", "description": "When true, coordinator will not auto-publish; call POST .../live when ready." }, "recurring_schedule_id": { "type": "string", "description": "Set when this occurrence belongs to a recurrence." }, "scheduled_broadcast_id": { "type": "string", "description": "Numeric scheduler id. Required in the update request body." }, "scheduled_end_ms": { "type": "string", "description": "Scheduled end, milliseconds since Unix epoch (decimal string)." }, "scheduled_start_ms": { "type": "string", "description": "Scheduled start, milliseconds since Unix epoch (decimal string)." }, "source_id": { "type": "string", "description": "Bound ingest / source id (`rtmp_stream_key`)." }, "state": { "type": "string", "description": "Scheduler state (Created, Scheduled, Running, …)." }, "telecast_id": { "type": "string", "description": "Optional telecast association." }, "thumbnail_media_id": { "type": "string", "description": "Optional pre-live slate media id." }, "title": { "type": "string", "description": "Broadcast title / status text." } } }, "GetSpacesBuyersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetSpacesByCreatorIdsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Space" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetSpacesByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Space" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetSpacesByIdsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Space" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetSpacesPostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetTrendsByWoeidResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Trend" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetTrendsPersonalizedTrendsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalizedTrend" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetUsageResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Usage" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetUsersAffiliatesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersBlockingResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersBookmarkFoldersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetUsersBookmarkFoldersResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetUsersBookmarkFoldersResponseData": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the bookmark folder." }, "name": { "type": "string", "description": "Display name of the bookmark folder." } } }, "GetUsersBookmarksByFolderIdResponse": { "type": "object", "properties": { "data": { "type": "array", "description": "The Posts in this bookmark folder, by ID.", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/PostId" } } } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetUsersBookmarksResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetUsersByIdsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetUsersByUsernameResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetUsersByUsernamesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetUsersFollowedListsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/List" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersFollowersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersFollowingResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersLikedPostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersListMembershipsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/List" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersMeResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/User" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "GetUsersMentionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "newest_id": { "type": "string", "description": "Most recent ID in the data array." }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "oldest_id": { "type": "string", "description": "Oldest ID in the data array." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersMutingResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersOwnedListsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/List" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersPinnedListsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/List" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersPostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "newest_id": { "type": "string", "description": "Most recent ID in the data array." }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "oldest_id": { "type": "string", "description": "Oldest ID in the data array." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersPublicKeyResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PublicKey" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetUsersPublicKeysResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PublicKey" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetUsersRepostsOfMeResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetUsersTimelineResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "newest_id": { "type": "string", "description": "Most recent ID in the data array." }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "oldest_id": { "type": "string", "description": "Oldest ID in the data array." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetWebhooksResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookConfig" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "GetWebhooksStreamLinksResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetWebhooksStreamLinksResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GetWebhooksStreamLinksResponseData": { "type": "object", "properties": { "application_id": { "type": "string", "description": "The application ID" }, "business_user_id": { "type": "string", "description": "The user ID" }, "created_at": { "type": "string", "description": "The datetime the webhook was linked to the stream" }, "fields": { "type": "array", "description": "Requested fields to be rendered", "items": { "type": "string" } }, "instance_id": { "type": "string", "description": "The stream ID associated with the FilteredStream instance" }, "webhook_id": { "type": "string", "description": "The unique identifier for the webhook" } } }, "GoLiveScheduledBroadcastResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GoLiveScheduledBroadcastResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "GoLiveScheduledBroadcastResponseData": { "type": "object", "properties": { "available_for_replay": { "type": "boolean", "description": "Whether replay is enabled." }, "broadcast_id": { "type": "string", "description": "Alphanumeric UBS broadcast id (path `:id` for get/update/delete/live)." }, "chat_option": { "type": "string", "description": "Optional chat permission option." }, "description": { "type": "string", "description": "Optional description." }, "locale": { "type": "string", "description": "Optional locale." }, "manual_publish": { "type": "boolean", "description": "When true, coordinator will not auto-publish; call POST .../live when ready." }, "recurring_schedule_id": { "type": "string", "description": "Set when this occurrence belongs to a recurrence." }, "scheduled_broadcast_id": { "type": "string", "description": "Numeric scheduler id. Required in the update request body." }, "scheduled_end_ms": { "type": "string", "description": "Scheduled end, milliseconds since Unix epoch (decimal string)." }, "scheduled_start_ms": { "type": "string", "description": "Scheduled start, milliseconds since Unix epoch (decimal string)." }, "source_id": { "type": "string", "description": "Bound ingest / source id (`rtmp_stream_key`)." }, "state": { "type": "string", "description": "Scheduler state (Created, Scheduled, Running, …)." }, "telecast_id": { "type": "string", "description": "Optional telecast association." }, "thumbnail_media_id": { "type": "string", "description": "Optional pre-live slate media id." }, "title": { "type": "string", "description": "Broadcast title / status text." } } }, "HidePostsReplyRequest": { "type": "object", "required": [ "hidden" ], "properties": { "hidden": { "type": "boolean", "description": "Whether the reply should be hidden." } }, "additionalProperties": false }, "HidePostsReplyResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HidePostsReplyResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "HidePostsReplyResponseData": { "type": "object", "properties": { "hidden": { "type": "boolean", "description": "Whether the reply is hidden." } } }, "InitializeChatGroupResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InitializeChatGroupResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "InitializeChatGroupResponseData": { "type": "object", "required": [ "conversation_id" ], "properties": { "conversation_id": { "type": "string", "description": "Unique ID for the new group conversation." } } }, "InitializeMediaUploadRequest": { "type": "object", "properties": { "additional_owners": { "type": "array", "description": "User ids granted access to the uploaded media.", "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "media_category": { "type": "string", "description": "The media category of the upload.", "enum": [ "amplify_video", "tweet_gif", "tweet_image", "tweet_video", "dm_gif", "dm_image", "dm_video", "subtitles" ] }, "media_type": { "type": "string", "description": "The type of media.", "enum": [ "video/mp4", "video/webm", "video/mp2t", "video/quicktime", "text/srt", "text/vtt", "image/jpeg", "image/gif", "image/bmp", "image/png", "image/webp", "image/pjpeg", "image/tiff", "model/gltf-binary", "model/vnd.usdz+zip" ] }, "shared": { "type": "boolean", "description": "Whether this media is shared or not." }, "total_bytes": { "type": "integer", "description": "The total size of the media upload in bytes.", "minimum": 0, "maximum": 17179869184 } }, "additionalProperties": false }, "InitializeMediaUploadResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InitializeMediaUploadResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "InitializeMediaUploadResponseData": { "type": "object", "required": [ "id" ], "properties": { "expires_after_secs": { "type": "integer", "description": "Seconds until the upload session expires." }, "id": { "type": "string", "description": "Unique identifier of the upload session." }, "media_key": { "type": "string", "description": "The media key for the uploaded media." } } }, "InternalErrorProblem": { "type": "object", "required": [ "type", "title", "detail" ], "properties": { "detail": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/internal-error" ] } } }, "InvalidRequestProblem": { "type": "object", "required": [ "type", "title", "detail" ], "properties": { "detail": { "type": "string" }, "parameter": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/invalid-request" ] }, "value": { "type": "string" } } }, "Keyword": { "type": "string", "description": "A keyword to filter on.", "minLength": 1, "maxLength": 150, "example": "The President" }, "LikeComplianceSchema": { "type": "object", "required": [ "delete" ], "properties": { "delete": { "$ref": "#/components/schemas/UnlikeComplianceSchema" } } }, "LikeId": { "type": "string", "description": "The unique identifier of this Like.", "pattern": "^[A-Za-z0-9_]{1,40}$", "example": "8ba4f34e6235d905a46bac021d98e923" }, "LikePostRequest": { "type": "object", "required": [ "tweet_id" ], "properties": { "tweet_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "LikePostResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LikePostResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "LikePostResponseData": { "type": "object", "required": [ "liked" ], "properties": { "liked": { "type": "boolean", "description": "Whether the User likes the Post." } } }, "LikeWithPostAuthor": { "type": "object", "description": "A Like event, with the tweet author user and the tweet being liked", "properties": { "created_at": { "type": "string", "description": "Creation time of the Tweet.", "format": "date-time", "example": "2021-01-06T18:40:40.000Z" }, "id": { "$ref": "#/components/schemas/LikeId" }, "liked_tweet_id": { "$ref": "#/components/schemas/PostId" }, "timestamp_ms": { "type": "integer", "description": "Timestamp in milliseconds of creation.", "format": "int32" }, "tweet_author_id": { "$ref": "#/components/schemas/UserId" } } }, "List": { "type": "object", "properties": { "created_at": { "type": "string" }, "description": { "type": "string" }, "follower_count": { "$ref": "#/components/schemas/ListFollowerCount" }, "id": { "type": "string" }, "member_count": { "$ref": "#/components/schemas/ListMemberCount" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "private": { "type": "boolean" } } }, "ListFollowerCount": { "type": "integer", "description": "The number of users who follow this List.", "format": "int64" }, "ListId": { "type": "string", "description": "Unique identifier of a List", "pattern": "^[0-9]{1,19}$", "example": "1146654567674912769" }, "ListMemberCount": { "type": "integer", "description": "The number of members in this List.", "format": "int64" }, "ListScheduledBroadcastsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListScheduledBroadcastsResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ListScheduledBroadcastsResponseData": { "type": "object", "properties": { "available_for_replay": { "type": "boolean", "description": "Whether replay is enabled." }, "broadcast_id": { "type": "string", "description": "Alphanumeric UBS broadcast id (path `:id` for get/update/delete/live)." }, "chat_option": { "type": "string", "description": "Optional chat permission option." }, "description": { "type": "string", "description": "Optional description." }, "locale": { "type": "string", "description": "Optional locale." }, "manual_publish": { "type": "boolean", "description": "When true, coordinator will not auto-publish; call POST .../live when ready." }, "recurring_schedule_id": { "type": "string", "description": "Set when this occurrence belongs to a recurrence." }, "scheduled_broadcast_id": { "type": "string", "description": "Numeric scheduler id. Required in the update request body." }, "scheduled_end_ms": { "type": "string", "description": "Scheduled end, milliseconds since Unix epoch (decimal string)." }, "scheduled_start_ms": { "type": "string", "description": "Scheduled start, milliseconds since Unix epoch (decimal string)." }, "source_id": { "type": "string", "description": "Bound ingest / source id (`rtmp_stream_key`)." }, "state": { "type": "string", "description": "Scheduler state (Created, Scheduled, Running, …)." }, "telecast_id": { "type": "string", "description": "Optional telecast association." }, "thumbnail_media_id": { "type": "string", "description": "Optional pre-live slate media id." }, "title": { "type": "string", "description": "Broadcast title / status text." } } }, "MarkChatConversationReadRequest": { "type": "object", "required": [ "seen_until_sequence_id" ], "properties": { "seen_until_sequence_id": { "type": "string", "description": "The sequence ID of the last message to mark as read up to." } } }, "MarkChatConversationReadResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarkChatConversationReadResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "MarkChatConversationReadResponseData": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Whether the conversation was marked read." } } }, "Media": { "type": "object", "properties": { "alt_text": { "type": "string" }, "duration_ms": { "type": "integer" }, "height": { "type": "integer" }, "media_key": { "type": "string" }, "non_public_metrics": { "$ref": "#/components/schemas/MediaNonPublicMetrics" }, "organic_metrics": { "$ref": "#/components/schemas/MediaOrganicMetrics" }, "preview_image_url": { "type": "string" }, "promoted_metrics": { "$ref": "#/components/schemas/MediaPromotedMetrics" }, "public_metrics": { "$ref": "#/components/schemas/MediaPublicMetrics" }, "type": { "type": "string" }, "url": { "type": "string" }, "variants": { "$ref": "#/components/schemas/MediaVariants" }, "width": { "type": "integer" } } }, "MediaAnalytics": { "type": "object", "properties": { "cta_url_clicks": { "type": "integer" }, "cta_watch_clicks": { "type": "integer" }, "media_key": { "type": "string" }, "play_from_tap": { "type": "integer" }, "playback25": { "type": "integer" }, "playback50": { "type": "integer" }, "playback75": { "type": "integer" }, "playback_complete": { "type": "integer" }, "playback_start": { "type": "integer" }, "timestamp": { "type": "string" }, "timestamped_metrics": { "$ref": "#/components/schemas/MediaAnalyticsTimestampedMetrics" }, "video_views": { "type": "integer" }, "watch_time_ms": { "type": "integer" } } }, "MediaAnalyticsTimestampedMetrics": { "type": "array", "description": "Time-bucketed video metrics for the media, one entry per granularity bucket.", "items": { "type": "object", "properties": { "metrics": { "type": "object", "description": "Video metric counts for this bucket. Counters are integers when the backend value parses as a number, otherwise the original string is preserved.", "properties": { "cta_url_clicks": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "cta_watch_clicks": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "play_from_tap": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "playback25": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "playback50": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "playback75": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "playback_complete": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "playback_start": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "video_views": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true }, "watch_time_ms": { "description": "A video metric counter: an integer when the backend value parses as a number, otherwise the original string.", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ], "nullable": true } }, "nullable": true }, "timestamp": { "type": "string", "description": "Start of the metrics bucket, as an ISO 8601 date-time.", "nullable": true } } } }, "MediaId": { "type": "string", "description": "Unique identifier of a Media", "pattern": "^[0-9]{1,19}$" }, "MediaNonPublicMetrics": { "type": "object", "description": "Nonpublic engagement metrics for the media at the time of the request.", "properties": { "playback_0_count": { "type": "integer", "description": "Number of users who started playback (0% quartile) of this video.", "format": "int64", "nullable": true }, "playback_100_count": { "type": "integer", "description": "Number of users who completed playback (100% quartile) of this video.", "format": "int64", "nullable": true }, "playback_25_count": { "type": "integer", "description": "Number of users who watched at least 25% of this video.", "format": "int64", "nullable": true }, "playback_50_count": { "type": "integer", "description": "Number of users who watched at least 50% of this video.", "format": "int64", "nullable": true }, "playback_75_count": { "type": "integer", "description": "Number of users who watched at least 75% of this video.", "format": "int64", "nullable": true } } }, "MediaOrganicMetrics": { "type": "object", "description": "Organic nonpublic engagement metrics for the media at the time of the request.", "properties": { "playback_0_count": { "type": "integer", "description": "Number of users who started playback (0% quartile) of this video.", "format": "int64", "nullable": true }, "playback_100_count": { "type": "integer", "description": "Number of users who completed playback (100% quartile) of this video.", "format": "int64", "nullable": true }, "playback_25_count": { "type": "integer", "description": "Number of users who watched at least 25% of this video.", "format": "int64", "nullable": true }, "playback_50_count": { "type": "integer", "description": "Number of users who watched at least 50% of this video.", "format": "int64", "nullable": true }, "playback_75_count": { "type": "integer", "description": "Number of users who watched at least 75% of this video.", "format": "int64", "nullable": true }, "view_count": { "type": "integer", "description": "The number of organic views of this video. Null when the backend returns quartile data without a view count.", "format": "int64", "nullable": true } } }, "MediaPromotedMetrics": { "type": "object", "description": "Promoted nonpublic engagement metrics for the media at the time of the request.", "properties": { "playback_0_count": { "type": "integer", "description": "Number of users who started playback (0% quartile) of this video.", "format": "int64", "nullable": true }, "playback_100_count": { "type": "integer", "description": "Number of users who completed playback (100% quartile) of this video.", "format": "int64", "nullable": true }, "playback_25_count": { "type": "integer", "description": "Number of users who watched at least 25% of this video.", "format": "int64", "nullable": true }, "playback_50_count": { "type": "integer", "description": "Number of users who watched at least 50% of this video.", "format": "int64", "nullable": true }, "playback_75_count": { "type": "integer", "description": "Number of users who watched at least 75% of this video.", "format": "int64", "nullable": true }, "view_count": { "type": "integer", "description": "The number of promoted views of this video. Null when the backend returns quartile data without a view count.", "format": "int64", "nullable": true } } }, "MediaPublicMetrics": { "type": "object", "description": "Public engagement metrics for the media at the time of the request.", "required": [ "view_count" ], "properties": { "view_count": { "type": "integer", "description": "The number of times this video has been viewed.", "format": "int64" } } }, "MediaUploadRequest": { "type": "object", "required": [ "media", "media_category" ], "properties": { "additional_owners": { "type": "string", "description": "Comma-separated list of user IDs who can use this media." }, "media": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "string", "format": "byte" } ], "description": "The media file to upload: base64-encoded in JSON bodies, raw bytes in multipart bodies." }, "media_category": { "type": "string", "description": "The category of the media being uploaded.", "enum": [ "tweet_image", "tweet_video", "tweet_gif", "dm_image", "dm_video", "dm_gif", "subtitles" ] } }, "additionalProperties": false }, "MediaUploadResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaUploadResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "MediaUploadResponseData": { "type": "object", "required": [ "id" ], "properties": { "expires_after_secs": { "type": "integer", "description": "Seconds until the upload session expires." }, "id": { "type": "string", "description": "Unique identifier of the media." }, "image": { "$ref": "#/components/schemas/MediaUploadResponseDataImage" }, "media_key": { "type": "string", "description": "The media key for the uploaded media." }, "processing_info": { "$ref": "#/components/schemas/MediaUploadResponseDataProcessingInfo" }, "size": { "type": "integer", "description": "Total size of the media in bytes." }, "video": { "$ref": "#/components/schemas/MediaUploadResponseDataVideo" } } }, "MediaUploadResponseDataImage": { "type": "object", "properties": { "h": { "type": "integer", "description": "Height in pixels." }, "image_type": { "type": "string", "description": "MIME type of the uploaded image." }, "w": { "type": "integer", "description": "Width in pixels." } }, "additionalProperties": false }, "MediaUploadResponseDataProcessingInfo": { "type": "object", "properties": { "check_after_secs": { "type": "integer", "description": "Seconds to wait before polling status again." }, "progress_percent": { "type": "integer", "description": "Processing completion percentage." }, "state": { "type": "string", "description": "Processing state (pending, in_progress, failed, succeeded)." } }, "additionalProperties": false }, "MediaUploadResponseDataVideo": { "type": "object", "properties": { "video_type": { "type": "string", "description": "MIME type of the processed video." } }, "additionalProperties": false }, "MediaVariants": { "type": "array", "description": "Each media object may have multiple display or playback variants, with different resolutions or formats.", "items": { "type": "object", "description": "A single playback or display variant of a media object.", "properties": { "bit_rate": { "type": "integer", "description": "The bit rate of this variant, in bits per second. Absent for playlist variants.", "format": "int64", "nullable": true }, "content_type": { "type": "string", "description": "The MIME type of this variant, for example \"video/mp4\" or \"application/x-mpegURL\".", "nullable": true }, "url": { "type": "string", "description": "The URL to this media variant.", "nullable": true } } } }, "MuteUserRequest": { "type": "object", "required": [ "target_user_id" ], "properties": { "target_user_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "MuteUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MuteUserResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "MuteUserResponseData": { "type": "object", "required": [ "muting" ], "properties": { "muting": { "type": "boolean", "description": "Whether the source User is muting the target User." } } }, "News": { "type": "object", "properties": { "category": { "type": "string" }, "cluster_posts_results": { "$ref": "#/components/schemas/NewsClusterPostsResults" }, "contexts": { "type": "object" }, "disclaimer": { "type": "string" }, "hook": { "type": "string" }, "id": { "type": "string" }, "keywords": { "type": "object" }, "name": { "type": "string" }, "summary": { "type": "string" }, "updated_at": { "type": "string" } } }, "NewsActivityResponsePayload": { "type": "object", "properties": { "category": { "type": "string" }, "headline": { "type": "string" }, "hook": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": false }, "NewsClusterPostsResults": { "type": "array", "items": { "type": "object", "description": "A Post belonging to this news story's cluster.", "required": [ "post_id" ], "properties": { "post_id": { "type": "string", "description": "Unique identifier of the Post." } } } }, "NotAuthorizedForFieldProblem": { "type": "object", "required": [ "type", "title", "detail", "field" ], "properties": { "detail": { "type": "string" }, "field": { "type": "string" }, "parameter": { "type": "string" }, "resource_id": { "type": "string" }, "resource_type": { "type": "string" }, "section": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/not-authorized-for-field" ] }, "value": { "type": "string" } } }, "NotAuthorizedForResourceProblem": { "type": "object", "required": [ "type", "title", "detail", "resource_type" ], "properties": { "detail": { "type": "string" }, "parameter": { "type": "string" }, "resource_id": { "type": "string" }, "resource_type": { "type": "string" }, "section": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/not-authorized-for-resource" ] }, "value": { "type": "string" } } }, "Note": { "type": "object", "properties": { "id": { "type": "string" }, "info": { "$ref": "#/components/schemas/NoteInfo" }, "scoring_status": { "$ref": "#/components/schemas/NoteScoringStatus" }, "status": { "type": "string" }, "test_result": { "$ref": "#/components/schemas/NoteTestResult" } } }, "NoteId": { "type": "string", "description": "Unique identifier of a Note", "pattern": "^[0-9]{1,19}$" }, "NoteInfo": { "type": "object", "description": "Details about the Community Note's content, classification and source.", "properties": { "classification": { "type": "string", "description": "How the noted Post was classified (snake_case).", "nullable": true }, "misleading_tags": { "type": "array", "description": "Reasons the noted Post may be misleading (snake_case).", "items": { "type": "string" }, "nullable": true }, "post_id": { "type": "string", "description": "Unique identifier of the Post this note is about.", "nullable": true }, "rating_status": { "type": "string", "description": "Current rating status of the note.", "nullable": true }, "text": { "type": "string", "description": "The text of the Community Note.", "nullable": true }, "trustworthy_sources": { "type": "boolean", "description": "Whether the note cites trustworthy sources.", "nullable": true } } }, "NoteScoringStatus": { "type": "object", "description": "Per-model scoring breakdown for the Community Note.", "properties": { "has_access": { "type": "boolean", "description": "Whether the caller has access to the scoring details.", "nullable": true }, "rating_counts_per_model": { "type": "array", "description": "Rating counts broken down per scoring model.", "items": { "type": "object", "description": "Rating counts for one scoring model.", "properties": { "model_name": { "type": "string", "description": "Name of the scoring model.", "nullable": true }, "value": { "type": "object", "description": "Per-factor bucket counts for a scoring model.", "properties": { "negative_factor_bucket_counts": { "type": "object", "description": "Helpfulness counts for one rating factor bucket.", "properties": { "helpful_count": { "type": "integer", "format": "int64", "nullable": true }, "helpful_tag_counts": { "type": "array", "items": { "type": "object", "description": "A tag and its count.", "properties": { "tag_count": { "type": "integer", "format": "int64", "nullable": true }, "tag_name": { "type": "string", "nullable": true } } }, "nullable": true }, "not_helpful_count": { "type": "integer", "format": "int64", "nullable": true }, "not_helpful_tag_counts": { "type": "array", "items": { "type": "object", "description": "A tag and its count.", "properties": { "tag_count": { "type": "integer", "format": "int64", "nullable": true }, "tag_name": { "type": "string", "nullable": true } } }, "nullable": true }, "somewhat_helpful_count": { "type": "integer", "format": "int64", "nullable": true } }, "nullable": true }, "neutral_factor_bucket_counts": { "type": "object", "description": "Helpfulness counts for one rating factor bucket.", "properties": { "helpful_count": { "type": "integer", "format": "int64", "nullable": true }, "helpful_tag_counts": { "type": "array", "items": { "type": "object", "description": "A tag and its count.", "properties": { "tag_count": { "type": "integer", "format": "int64", "nullable": true }, "tag_name": { "type": "string", "nullable": true } } }, "nullable": true }, "not_helpful_count": { "type": "integer", "format": "int64", "nullable": true }, "not_helpful_tag_counts": { "type": "array", "items": { "type": "object", "description": "A tag and its count.", "properties": { "tag_count": { "type": "integer", "format": "int64", "nullable": true }, "tag_name": { "type": "string", "nullable": true } } }, "nullable": true }, "somewhat_helpful_count": { "type": "integer", "format": "int64", "nullable": true } }, "nullable": true }, "positive_factor_bucket_counts": { "type": "object", "description": "Helpfulness counts for one rating factor bucket.", "properties": { "helpful_count": { "type": "integer", "format": "int64", "nullable": true }, "helpful_tag_counts": { "type": "array", "items": { "type": "object", "description": "A tag and its count.", "properties": { "tag_count": { "type": "integer", "format": "int64", "nullable": true }, "tag_name": { "type": "string", "nullable": true } } }, "nullable": true }, "not_helpful_count": { "type": "integer", "format": "int64", "nullable": true }, "not_helpful_tag_counts": { "type": "array", "items": { "type": "object", "description": "A tag and its count.", "properties": { "tag_count": { "type": "integer", "format": "int64", "nullable": true }, "tag_name": { "type": "string", "nullable": true } } }, "nullable": true }, "somewhat_helpful_count": { "type": "integer", "format": "int64", "nullable": true } }, "nullable": true } }, "nullable": true } } }, "nullable": true } } }, "NoteTestResult": { "type": "object", "description": "AI evaluation results for the Community Note (returned in test mode).", "properties": { "evaluation_outcome": { "type": "array", "description": "Per-evaluator outcomes for the note.", "items": { "type": "object", "description": "A single evaluator's outcome for a Community Note.", "required": [ "evaluator_type", "evaluator_score_bucket" ], "properties": { "evaluator_score_bucket": { "type": "string", "description": "The score bucket the evaluator assigned." }, "evaluator_type": { "type": "string", "description": "The type of evaluator that produced this outcome." } } }, "nullable": true } } }, "PersonalizedTrend": { "type": "object", "properties": { "category": { "type": "string" }, "post_count": { "type": "string" }, "trend_name": { "type": "string" }, "trending_since": { "type": "string" } } }, "PinListRequest": { "type": "object", "required": [ "list_id" ], "properties": { "list_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "PinListResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PinListResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "PinListResponseData": { "type": "object", "required": [ "pinned" ], "properties": { "pinned": { "type": "boolean", "description": "Indicates whether the List is pinned by the authenticated user." } } }, "Place": { "type": "object", "properties": { "contained_within": { "$ref": "#/components/schemas/PlaceContainedWithin" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "full_name": { "type": "string" }, "geo": { "$ref": "#/components/schemas/PlaceGeo" }, "id": { "type": "string" }, "name": { "type": "string" }, "place_type": { "type": "string" } } }, "PlaceContainedWithin": { "type": "array", "description": "A list of unique identifiers of the Places that contain this place.", "items": { "type": "string" } }, "PlaceGeo": { "type": "object", "description": "The geographic location of this place, expressed as a GeoJSON Feature.", "required": [ "type", "bbox", "properties" ], "properties": { "bbox": { "type": "array", "description": "The bounding box as [southwest_longitude, southwest_latitude, northeast_longitude, northeast_latitude].", "minItems": 4, "maxItems": 4, "items": { "type": "number", "format": "double" } }, "properties": { "type": "object", "description": "Additional GeoJSON feature properties." }, "type": { "description": "The GeoJSON feature type.", "oneOf": [ { "type": "string", "enum": [ "Feature" ] } ] } } }, "Poll": { "type": "object", "properties": { "duration_minutes": { "type": "integer" }, "end_datetime": { "type": "string" }, "id": { "type": "string" }, "options": { "$ref": "#/components/schemas/PollOptions" }, "voting_status": { "type": "string" } } }, "PollOptions": { "type": "array", "description": "The list of options (choices) available in this poll.", "items": { "type": "object", "description": "A single option (choice) available in a poll.", "required": [ "position", "label", "votes" ], "properties": { "label": { "type": "string", "description": "The text label of this poll option." }, "position": { "type": "integer", "description": "The 1-based position of this option within the poll.", "format": "int64" }, "votes": { "type": "integer", "description": "The number of votes this option has received.", "format": "int64" } } } }, "Post": { "type": "object", "properties": { "article": { "type": "object" }, "article_title": { "type": "object", "description": "Metadata about the long-form Article attached to this Post, if any." }, "attachments": { "$ref": "#/components/schemas/PostAttachments" }, "author_id": { "type": "string", "description": "Unique identifier of the author of this Post." }, "card_uri": { "type": "string" }, "community_id": { "type": "string", "description": "The unique identifier of the Community this Post belongs to, if any." }, "context_annotations": { "$ref": "#/components/schemas/PostContextAnnotations" }, "conversation_id": { "type": "string", "description": "The ID of the conversation this Post belongs to (matches the root Post's ID)." }, "created_at": { "type": "string", "description": "Creation time of the Post.", "format": "date-time" }, "display_text_range": { "$ref": "#/components/schemas/PostDisplayTextRange" }, "edit_controls": { "$ref": "#/components/schemas/PostEditControls" }, "edit_history_post_ids": { "type": "array", "description": "A list of Post IDs in this Post's edit history chain.", "items": { "type": "string" } }, "entities": { "$ref": "#/components/schemas/PostEntities" }, "geo": { "$ref": "#/components/schemas/PostGeo" }, "id": { "type": "string", "description": "Unique identifier of this Post." }, "in_reply_to_user_id": { "type": "string", "description": "Unique identifier of the User this Post is replying to." }, "lang": { "type": "string", "description": "Language of the Post, if detected by X. Returned as a BCP47 language tag." }, "matched_media_notes": { "$ref": "#/components/schemas/PostMatchedMediaNotes" }, "media_metadata": { "$ref": "#/components/schemas/PostMediaMetadata" }, "non_public_metrics": { "type": "object", "description": "Nonpublic engagement metrics for the Post at the time of the request." }, "note_post": { "$ref": "#/components/schemas/PostNotePost" }, "note_request_suggestions": { "$ref": "#/components/schemas/PostNoteRequestSuggestions" }, "organic_metrics": { "type": "object", "description": "Organic nonpublic engagement metrics for the Post at the time of the request." }, "paid_partnership": { "type": "boolean", "description": "Indicates if this Post is a paid partnership, i.e. it has been disclosed by the author as containing paid promotion." }, "possibly_sensitive": { "type": "boolean", "description": "Indicates if this Post contains URLs marked as sensitive, for example content suitable for mature audiences." }, "promoted_metrics": { "type": "object", "description": "Promoted nonpublic engagement metrics for the Post at the time of the request." }, "public_metrics": { "$ref": "#/components/schemas/PostPublicMetrics" }, "referenced_posts": { "$ref": "#/components/schemas/PostReferencedPosts" }, "reply_settings": { "type": "string", "description": "Shows who can reply to this Post." }, "scopes": { "$ref": "#/components/schemas/PostScopes" }, "source": { "type": "string", "description": "The name of the app the user posted from. This is deprecated." }, "suggested_source_links": { "$ref": "#/components/schemas/PostSuggestedSourceLinks" }, "suggested_source_links_with_counts": { "$ref": "#/components/schemas/PostSuggestedSourceLinksWithCounts" }, "text": { "type": "string", "description": "The content of the Post." }, "username": { "type": "string" }, "withheld": { "$ref": "#/components/schemas/PostWithheld" } } }, "PostAttachments": { "type": "object", "description": "Specifies the type of attachments (if any) present in this Post.", "properties": { "media_keys": { "type": "array", "description": "Media keys of media attached to this Post.", "items": { "type": "string" }, "nullable": true }, "media_source_tweet_id": { "type": "array", "description": "IDs of the source Posts the attached media originated from.", "items": { "type": "string" }, "nullable": true }, "poll_ids": { "type": "array", "description": "IDs of polls attached to this Post.", "items": { "type": "string" }, "nullable": true } } }, "PostComplianceData": { "description": "Tweet compliance data.", "oneOf": [ { "$ref": "#/components/schemas/PostDeleteComplianceSchema" }, { "$ref": "#/components/schemas/PostWithheldComplianceSchema" }, { "$ref": "#/components/schemas/PostDropComplianceSchema" }, { "$ref": "#/components/schemas/PostUndropComplianceSchema" }, { "$ref": "#/components/schemas/PostEditComplianceSchema" } ] }, "PostComplianceSchema": { "type": "object", "required": [ "tweet", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "quote_tweet_id": { "$ref": "#/components/schemas/PostId" }, "tweet": { "type": "object", "required": [ "id", "author_id" ], "properties": { "author_id": { "$ref": "#/components/schemas/UserId" }, "id": { "$ref": "#/components/schemas/PostId" } } } } }, "PostContextAnnotations": { "type": "array", "description": "Annotations inferred about the Post (domain and entity context).", "items": { "type": "object", "description": "A single inferred annotation about the Post (domain and entity context).", "required": [ "domain", "entity" ], "properties": { "domain": { "description": "The domain (broad category) this annotation belongs to.", "oneOf": [ { "type": "object", "description": "A domain or entity referenced by a context annotation.", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } } ] }, "entity": { "description": "The specific entity recognized within the domain.", "oneOf": [ { "type": "object", "description": "A domain or entity referenced by a context annotation.", "properties": { "description": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } } ] } } } }, "PostDeleteActivityResponsePayload": { "type": "object", "description": "The identity of a deleted Post.", "required": [ "id", "author_id" ], "properties": { "author_id": { "$ref": "#/components/schemas/UserId" }, "id": { "$ref": "#/components/schemas/PostId" } }, "additionalProperties": false }, "PostDeleteComplianceSchema": { "type": "object", "required": [ "delete" ], "properties": { "delete": { "$ref": "#/components/schemas/PostComplianceSchema" } } }, "PostDisplayTextRange": { "type": "array", "description": "The inclusive start and exclusive end indices of the displayable content of the Post.", "minItems": 2, "maxItems": 2, "items": { "type": "integer", "format": "int64" } }, "PostDropComplianceSchema": { "type": "object", "required": [ "drop" ], "properties": { "drop": { "$ref": "#/components/schemas/PostComplianceSchema" } } }, "PostEditComplianceObjectSchema": { "type": "object", "required": [ "tweet", "event_at", "initial_tweet_id", "edit_tweet_ids" ], "properties": { "edit_tweet_ids": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/PostId" } }, "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "initial_tweet_id": { "$ref": "#/components/schemas/PostId" }, "tweet": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/PostId" } } } } }, "PostEditComplianceSchema": { "type": "object", "required": [ "tweet_edit" ], "properties": { "tweet_edit": { "$ref": "#/components/schemas/PostEditComplianceObjectSchema" } } }, "PostEditControls": { "type": "object", "description": "Indicates how much longer (if at all) this Post can be edited.", "properties": { "editable_until": { "type": "string", "description": "The time until which this Post can be edited.", "nullable": true }, "edits_remaining": { "type": "integer", "description": "Number of edits still allowed for this Post.", "format": "int64", "nullable": true }, "is_edit_eligible": { "type": "boolean", "description": "Indicates whether this Post is eligible to be edited.", "nullable": true } } }, "PostEntities": { "type": "object", "description": "A list of metadata entities (hashtags, mentions, URLs) found in the Post text.", "properties": { "cashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "hashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "mentions": { "type": "array", "items": { "type": "object", "description": "A user mention entity.", "required": [ "start", "end" ], "properties": { "end": { "type": "integer", "format": "int64" }, "id": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "username": { "type": "string", "nullable": true } } }, "nullable": true }, "urls": { "type": "array", "items": { "type": "object", "description": "A URL entity found in the Post text, enriched with link metadata.", "required": [ "start", "end" ], "properties": { "description": { "type": "string", "description": "Description of the linked page, when available.", "nullable": true }, "display_url": { "type": "string", "description": "The URL as displayed in the Post text.", "nullable": true }, "end": { "type": "integer", "format": "int64" }, "expanded_url": { "type": "string", "description": "The fully resolved URL.", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "description": "A preview image for a linked page.", "properties": { "height": { "type": "integer", "format": "int64", "nullable": true }, "url": { "type": "string", "nullable": true }, "width": { "type": "integer", "format": "int64", "nullable": true } } }, "nullable": true }, "media_key": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "description": "HTTP status from resolving the URL.", "format": "int64", "nullable": true }, "title": { "type": "string", "description": "Title of the linked page, when available.", "nullable": true }, "unwound_url": { "type": "string", "description": "The final destination after following redirects.", "nullable": true }, "url": { "type": "string", "description": "The t.co shortened URL.", "nullable": true } } }, "nullable": true } } }, "PostGeo": { "type": "object", "description": "The location tagged on the Post, if the user provided one.", "properties": { "coordinates": { "type": "object", "description": "A GeoJSON Point geometry.", "required": [ "type", "coordinates" ], "properties": { "coordinates": { "type": "array", "description": "[longitude, latitude].", "minItems": 2, "maxItems": 2, "items": { "type": "number", "format": "double" } }, "type": { "type": "string", "description": "The GeoJSON geometry type.", "enum": [ "Point" ] } }, "nullable": true }, "place_id": { "type": "string", "description": "The unique identifier of the tagged place.", "nullable": true } } }, "PostId": { "type": "string", "description": "Unique identifier of a Post", "pattern": "^[0-9]{1,19}$", "example": "1346889436626259968" }, "PostLabelData": { "description": "Tweet label data.", "oneOf": [ { "$ref": "#/components/schemas/PostNoticeSchema" }, { "$ref": "#/components/schemas/PostUnviewableSchema" } ] }, "PostMatchedMediaNotes": { "type": "array", "description": "Community-Notes media matches for this Post.", "items": { "type": "object", "description": "A Community-Notes media match for this Post.", "properties": { "match_status": { "type": "string", "description": "The status of the media note match.", "nullable": true }, "note_id": { "type": "string", "description": "The matched note's unique identifier.", "nullable": true } } } }, "PostMediaMetadata": { "type": "array", "description": "Metadata for media attached to this Post.", "items": { "type": "object", "description": "Metadata for one media item attached to this Post.", "properties": { "alt_text": { "type": "string", "description": "Alternative text describing the media for accessibility.", "nullable": true }, "description": { "type": "string", "description": "Description of the media.", "nullable": true }, "media_key": { "type": "string", "description": "The unique identifier of the media.", "nullable": true }, "title": { "type": "string", "description": "Title of the media.", "nullable": true } } } }, "PostNotePost": { "type": "object", "description": "The full content of the Post, including text beyond 280 characters.", "required": [ "text" ], "properties": { "entities": { "type": "object", "description": "Metadata entities (hashtags, cashtags, mentions, URLs) found in the note Post text.", "properties": { "cashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "hashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "mentions": { "type": "array", "items": { "type": "object", "description": "A user mention entity.", "required": [ "start", "end" ], "properties": { "end": { "type": "integer", "format": "int64" }, "id": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "username": { "type": "string", "nullable": true } } }, "nullable": true }, "urls": { "type": "array", "items": { "type": "object", "description": "A URL entity found in note Post text.", "required": [ "start", "end" ], "properties": { "display_url": { "type": "string", "nullable": true }, "end": { "type": "integer", "format": "int64" }, "expanded_url": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "url": { "type": "string", "nullable": true } } }, "nullable": true } }, "nullable": true }, "text": { "type": "string", "description": "The full note text of the Post." } } }, "PostNoteRequestSuggestions": { "type": "array", "description": "Community-Notes request suggestions for this Post.", "items": { "type": "object", "description": "A Community-Notes request suggestion for this Post.", "properties": { "source_link": { "type": "string", "description": "A suggested source link supporting the note request.", "nullable": true }, "suggestion": { "type": "string", "description": "The text of the note request suggestion.", "nullable": true }, "suggestion_id": { "type": "string", "description": "The unique identifier of the note request suggestion.", "nullable": true } } } }, "PostNotice": { "type": "object", "required": [ "tweet", "event_type", "event_at", "application" ], "properties": { "application": { "type": "string", "description": "If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’.", "example": "apply" }, "details": { "type": "string", "description": "Information shown on the Tweet label" }, "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "event_type": { "type": "string", "description": "The type of label on the Tweet", "example": "misleading" }, "extended_details_url": { "type": "string", "description": "Link to more information about this kind of label" }, "label_title": { "type": "string", "description": "Title/header of the Tweet label" }, "tweet": { "type": "object", "required": [ "id", "author_id" ], "properties": { "author_id": { "$ref": "#/components/schemas/UserId" }, "id": { "$ref": "#/components/schemas/PostId" } } } } }, "PostNoticeSchema": { "type": "object", "required": [ "public_tweet_notice" ], "properties": { "public_tweet_notice": { "$ref": "#/components/schemas/PostNotice" } } }, "PostPublicMetrics": { "type": "object", "description": "Engagement metrics for the Post at the time of the request.", "required": [ "repost_count", "reply_count", "like_count", "quote_count", "bookmark_count", "impression_count" ], "properties": { "bookmark_count": { "type": "integer", "description": "Number of times this Post has been bookmarked.", "format": "int64" }, "impression_count": { "type": "integer", "description": "Number of times this Post has been viewed.", "format": "int64" }, "like_count": { "type": "integer", "description": "Number of likes on this Post.", "format": "int64" }, "quote_count": { "type": "integer", "description": "Number of quote Posts of this Post.", "format": "int64" }, "reply_count": { "type": "integer", "description": "Number of replies to this Post.", "format": "int64" }, "repost_count": { "type": "integer", "description": "Number of times this Post has been reposted.", "format": "int64" } } }, "PostReferencedPosts": { "type": "array", "description": "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.", "items": { "type": "object", "description": "A reference from this Post to another Post (repost, quote, or reply).", "required": [ "type", "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the referenced Post." }, "type": { "description": "How this Post references the other Post.", "oneOf": [ { "type": "string", "description": "The kind of Post-to-Post reference.", "enum": [ "retweeted", "quoted", "replied_to" ] } ] } } } }, "PostScopes": { "type": "object", "description": "The scopes for this Post.", "required": [ "followers" ], "properties": { "followers": { "type": "boolean", "description": "Indicates whether visibility of this Post is limited to the author's followers." } } }, "PostSuggestedSourceLinks": { "type": "array", "description": "URLs suggested as sources for this Post.", "items": { "type": "string" } }, "PostSuggestedSourceLinksWithCounts": { "type": "array", "description": "Suggested source URLs for this Post, each with the number of times it was suggested.", "items": { "type": "object", "description": "A suggested source URL for this Post with the number of times it was suggested.", "properties": { "count": { "type": "integer", "description": "Number of times this source link was suggested.", "format": "int64", "nullable": true }, "url": { "type": "string", "description": "The suggested source URL.", "nullable": true } } } }, "PostTakedownComplianceSchema": { "type": "object", "required": [ "tweet", "withheld_in_countries", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "quote_tweet_id": { "$ref": "#/components/schemas/PostId" }, "tweet": { "type": "object", "required": [ "id", "author_id" ], "properties": { "author_id": { "$ref": "#/components/schemas/UserId" }, "id": { "$ref": "#/components/schemas/PostId" } } }, "withheld_in_countries": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/CountryCode" } } } }, "PostUndropComplianceSchema": { "type": "object", "required": [ "undrop" ], "properties": { "undrop": { "$ref": "#/components/schemas/PostComplianceSchema" } } }, "PostUnviewable": { "type": "object", "required": [ "tweet", "event_at", "application" ], "properties": { "application": { "type": "string", "description": "If the label is being applied or removed. Possible values are ‘apply’ or ‘remove’.", "example": "apply" }, "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "tweet": { "type": "object", "required": [ "id", "author_id" ], "properties": { "author_id": { "$ref": "#/components/schemas/UserId" }, "id": { "$ref": "#/components/schemas/PostId" } } } } }, "PostUnviewableSchema": { "type": "object", "required": [ "public_tweet_unviewable" ], "properties": { "public_tweet_unviewable": { "$ref": "#/components/schemas/PostUnviewable" } } }, "PostWithheld": { "type": "object", "description": "Withholding details for withheld content.", "required": [ "copyright", "country_codes" ], "properties": { "copyright": { "type": "boolean", "description": "Indicates whether this content is withheld due to a copyright claim." }, "country_codes": { "type": "array", "description": "Uppercase ISO 3166-1 alpha-2 country codes where this content is withheld.", "items": { "type": "string" } }, "scope": { "type": "string", "description": "Whether the withholding applies to a Post or a User.", "enum": [ "post", "user" ], "nullable": true } } }, "PostWithheldComplianceSchema": { "type": "object", "required": [ "withheld" ], "properties": { "withheld": { "$ref": "#/components/schemas/PostTakedownComplianceSchema" } } }, "Problem": { "oneOf": [ { "$ref": "#/components/schemas/ResourceNotFoundProblem" }, { "$ref": "#/components/schemas/InvalidRequestProblem" }, { "$ref": "#/components/schemas/NotAuthorizedForResourceProblem" }, { "$ref": "#/components/schemas/NotAuthorizedForFieldProblem" }, { "$ref": "#/components/schemas/FieldUnauthorizedProblem" }, { "$ref": "#/components/schemas/FieldHydrationFailureProblem" }, { "$ref": "#/components/schemas/ResourceUnavailableProblem" }, { "$ref": "#/components/schemas/DisallowedResourceProblem" }, { "$ref": "#/components/schemas/InternalErrorProblem" } ], "discriminator": { "propertyName": "type", "mapping": { "https://api.x.com/2/problems/disallowed-resource": "#/components/schemas/DisallowedResourceProblem", "https://api.x.com/2/problems/field-hydration-failure": "#/components/schemas/FieldHydrationFailureProblem", "https://api.x.com/2/problems/field-unauthorized": "#/components/schemas/FieldUnauthorizedProblem", "https://api.x.com/2/problems/internal-error": "#/components/schemas/InternalErrorProblem", "https://api.x.com/2/problems/invalid-request": "#/components/schemas/InvalidRequestProblem", "https://api.x.com/2/problems/not-authorized-for-field": "#/components/schemas/NotAuthorizedForFieldProblem", "https://api.x.com/2/problems/not-authorized-for-resource": "#/components/schemas/NotAuthorizedForResourceProblem", "https://api.x.com/2/problems/resource-not-found": "#/components/schemas/ResourceNotFoundProblem", "https://api.x.com/2/problems/resource-unavailable": "#/components/schemas/ResourceUnavailableProblem" } } }, "ProfileUpdateActivityResponsePayload": { "type": "object", "properties": { "after": { "type": "string" }, "before": { "type": "string" } }, "additionalProperties": false }, "PublicKey": { "type": "object", "properties": { "identity_public_key_signature": { "type": "string" }, "juicebox_config": { "type": "object" }, "public_key": { "type": "string" }, "public_key_version": { "type": "string" }, "signing_public_key": { "type": "string" } } }, "PublicKeyId": { "type": "string", "description": "Unique identifier of a PublicKey", "pattern": "^[0-9]{1,19}$" }, "RemoveListsMemberByUserIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RemoveListsMemberByUserIdResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "RemoveListsMemberByUserIdResponseData": { "type": "object", "required": [ "is_member" ], "properties": { "is_member": { "type": "boolean", "description": "Indicates whether the user is a member of the List." } } }, "RepostPostRequest": { "type": "object", "required": [ "tweet_id" ], "properties": { "tweet_id": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "RepostPostResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RepostPostResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "RepostPostResponseData": { "type": "object", "required": [ "retweeted", "rest_id" ], "properties": { "rest_id": { "type": "string", "description": "The ID of the reposted Post." }, "retweeted": { "type": "boolean", "description": "Indicates whether the user reposted the Post." } } }, "ResourceNotFoundProblem": { "type": "object", "required": [ "type", "title", "detail", "resource_type" ], "properties": { "detail": { "type": "string" }, "parameter": { "type": "string" }, "resource_id": { "type": "string" }, "resource_type": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/resource-not-found" ] }, "value": { "type": "string" } } }, "ResourceUnavailableProblem": { "type": "object", "required": [ "type", "title", "detail", "resource_type" ], "properties": { "detail": { "type": "string" }, "resource_id": { "type": "string" }, "resource_type": { "type": "string" }, "status": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "https://api.x.com/2/problems/resource-unavailable" ] } } }, "RuleId": { "type": "string", "description": "Unique identifier of this rule.", "pattern": "^[0-9]{1,19}$", "example": "120897978112909812" }, "RuleTag": { "type": "string", "description": "A tag meant for the labeling of user provided rules.", "example": "Non-retweeted coffee Posts" }, "RulesCount": { "type": "object", "properties": { "all_project_client_apps": { "$ref": "#/components/schemas/RulesCountAllProjectClientApps" }, "cap_per_client_app": { "type": "string" }, "cap_per_project": { "type": "string" }, "client_app_rules_count": { "$ref": "#/components/schemas/RulesCountClientAppRulesCount" }, "project_rules_count": { "type": "string" } } }, "RulesCountAllProjectClientApps": { "type": "array", "items": { "type": "object", "description": "A count of filtered-stream rules for a single client application.", "required": [ "rule_count" ], "properties": { "client_app_id": { "type": "string", "description": "Unique identifier of the client application.", "nullable": true }, "rule_count": { "type": "integer", "description": "Number of rules configured for the client application.", "format": "int64" } } } }, "RulesCountClientAppRulesCount": { "type": "object", "description": "A count of filtered-stream rules for a single client application.", "required": [ "rule_count" ], "properties": { "client_app_id": { "type": "string", "description": "Unique identifier of the client application.", "nullable": true }, "rule_count": { "type": "integer", "description": "Number of rules configured for the client application.", "format": "int64" } } }, "SearchCommunitiesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Community" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." } } } } }, "SearchCommunityNotesWrittenResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "SearchEligiblePostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "SearchNewsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/News" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "SearchPostsAllResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "newest_id": { "type": "string", "description": "Most recent ID in the data array." }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "oldest_id": { "type": "string", "description": "Oldest ID in the data array." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "SearchPostsRecentResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "newest_id": { "type": "string", "description": "Most recent ID in the data array." }, "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "oldest_id": { "type": "string", "description": "Oldest ID in the data array." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." }, "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "SearchSpacesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Space" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "result_count": { "type": "integer", "description": "Number of items in the data array.", "format": "int32" } } } } }, "SearchUsersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "meta": { "type": "object", "properties": { "next_token": { "type": "string", "description": "Pagination token for the next page of results." }, "previous_token": { "type": "string", "description": "Pagination token for the previous page of results." } } } } }, "SendBroadcastChatRequest": { "type": "object", "required": [ "text" ], "properties": { "reply_to": { "type": "string", "description": "Message id to reply to, returned as timestamp when sent.", "pattern": "^[0-9]{1,19}$" }, "text": { "type": "string", "description": "The chat message text.", "minLength": 1, "maxLength": 140 } }, "additionalProperties": false }, "SendBroadcastChatResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SendBroadcastChatResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "SendBroadcastChatResponseData": { "type": "object", "required": [ "success", "timestamp" ], "properties": { "success": { "type": "boolean", "description": "Whether the chat message was sent." }, "timestamp": { "type": "string", "description": "Server timestamp of the message, in nanoseconds." } } }, "SendChatMessageRequest": { "type": "object", "required": [ "message_id", "encoded_message_create_event" ], "properties": { "conversation_token": { "type": "string", "description": "Optional conversation token." }, "encoded_message_create_event": { "type": "string", "description": "Base64-encoded Thrift MessageCreateEvent containing encrypted message contents." }, "encoded_message_event_signature": { "type": "string", "description": "Base64-encoded Thrift MessageEventSignature for message verification." }, "message_id": { "type": "string", "description": "Unique identifier for this message." } } }, "SendChatMessageResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SendChatMessageResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "SendChatMessageResponseData": { "type": "object", "required": [ "encoded_message_event" ], "properties": { "encoded_message_event": { "type": "string", "description": "Base64-encoded Thrift message event for the sent message." } } }, "SendChatTypingIndicatorResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SendChatTypingIndicatorResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "SendChatTypingIndicatorResponseData": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Whether the typing indicator was sent." } } }, "Space": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "creator_id": { "type": "string" }, "ended_at": { "type": "string", "format": "date-time" }, "host_ids": { "$ref": "#/components/schemas/SpaceHostIds" }, "id": { "type": "string" }, "invited_user_ids": { "$ref": "#/components/schemas/SpaceInvitedUserIds" }, "is_ticketed": { "type": "boolean" }, "lang": { "type": "string" }, "participant_count": { "type": "integer" }, "scheduled_start": { "type": "string", "format": "date-time" }, "speaker_ids": { "$ref": "#/components/schemas/SpaceSpeakerIds" }, "started_at": { "type": "string", "format": "date-time" }, "state": { "type": "string" }, "subscriber_count": { "type": "integer" }, "title": { "type": "string" }, "topic_ids": { "$ref": "#/components/schemas/SpaceTopicIds" }, "updated_at": { "type": "string", "format": "date-time" } } }, "SpaceHostIds": { "type": "array", "description": "A list of unique identifiers of the Users who host this Space.", "items": { "type": "string" } }, "SpaceInvitedUserIds": { "type": "array", "description": "A list of unique identifiers of the Users invited to this Space.", "items": { "type": "string" } }, "SpaceSpeakerIds": { "type": "array", "description": "A list of unique identifiers of the Users who are speakers in this Space.", "items": { "type": "string" } }, "SpaceTopicIds": { "type": "array", "description": "A list of unique identifiers of the Topics associated with this Space.", "items": { "type": "string" } }, "StreamLabelsComplianceResponse": { "description": "Tweet label stream events.", "oneOf": [ { "type": "object", "description": "Tweet Label event.", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PostLabelData" } } }, { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } } } } ] }, "StreamLikesComplianceResponse": { "description": "Likes compliance stream events.", "oneOf": [ { "type": "object", "description": "Compliance event.", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/LikeComplianceSchema" } } }, { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } } } } ] }, "StreamLikesFirehoseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LikeWithPostAuthor" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamLikesSample10Response": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LikeWithPostAuthor" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsComplianceResponse": { "description": "Tweet compliance stream events.", "oneOf": [ { "type": "object", "description": "Compliance event.", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PostComplianceData" } } }, { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } } } } ] }, "StreamPostsFirehoseEnResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsFirehoseJaResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsFirehoseKoResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsFirehosePtResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsFirehoseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsResponse": { "type": "object", "description": "A Tweet or error that can be returned by the streaming Tweet API. The values returned with a successful streamed Tweet includes the user provided rules that the Tweet matched.", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" }, "matching_rules": { "type": "array", "description": "The list of rules which matched the Tweet", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/RuleId" }, "tag": { "$ref": "#/components/schemas/RuleTag" } } } } } }, "StreamPostsSample10Response": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamPostsSampleResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Post" }, "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } }, "includes": { "$ref": "#/components/schemas/Expansions" } } }, "StreamUsersComplianceResponse": { "description": "User compliance stream events.", "oneOf": [ { "type": "object", "description": "User compliance event.", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserComplianceData" } } }, { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Problem" } } } } ] }, "Topic": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "Trend": { "type": "object", "properties": { "trend_name": { "type": "string" }, "tweet_count": { "type": "integer" } } }, "UnblockUsersDmsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnblockUsersDmsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnblockUsersDmsResponseData": { "type": "object", "required": [ "blocked" ], "properties": { "blocked": { "type": "boolean", "description": "Indicates whether the target user is DM-blocked." } } }, "UnfollowListResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnfollowListResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnfollowListResponseData": { "type": "object", "required": [ "following" ], "properties": { "following": { "type": "boolean", "description": "Indicates whether the user is following the List." } } }, "UnfollowUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnfollowUserResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnfollowUserResponseData": { "type": "object", "required": [ "following" ], "properties": { "following": { "type": "boolean", "description": "Whether the user is followed." } } }, "UnlikeComplianceSchema": { "type": "object", "required": [ "favorite", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "favorite": { "type": "object", "required": [ "id", "user_id" ], "properties": { "id": { "$ref": "#/components/schemas/PostId" }, "user_id": { "$ref": "#/components/schemas/UserId" } } } } }, "UnlikePostResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnlikePostResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnlikePostResponseData": { "type": "object", "required": [ "liked" ], "properties": { "liked": { "type": "boolean", "description": "Whether the Post is liked." } } }, "UnmuteUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnmuteUserResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnmuteUserResponseData": { "type": "object", "required": [ "muting" ], "properties": { "muting": { "type": "boolean", "description": "Whether the user is muted." } } }, "UnpinListResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnpinListResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnpinListResponseData": { "type": "object", "required": [ "pinned" ], "properties": { "pinned": { "type": "boolean", "description": "Indicates whether the List is pinned by the authenticated user." } } }, "UnrepostPostResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnrepostPostResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UnrepostPostResponseData": { "type": "object", "required": [ "retweeted" ], "properties": { "retweeted": { "type": "boolean", "description": "Whether the Post is reposted." } } }, "UpdateActivitySubscriptionRequest": { "type": "object", "properties": { "tag": { "type": "string", "description": "Optional caller-defined tag.", "minLength": 1, "maxLength": 200 }, "webhook_id": { "type": "string", "description": "Webhook to deliver the subscription events to.", "pattern": "^[0-9]{1,19}$" } }, "additionalProperties": false }, "UpdateActivitySubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateActivitySubscriptionResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UpdateActivitySubscriptionResponseData": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/UpdateActivitySubscriptionResponseDataSubscription" }, "total_subscriptions": { "type": "integer", "description": "Total active subscriptions for the instance." } } }, "UpdateActivitySubscriptionResponseDataSubscription": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Subscription creation time." }, "event_type": { "type": "string", "description": "Activity event type in dot notation." }, "filter": { "description": "Subscription filter.", "$ref": "#/components/schemas/UpdateActivitySubscriptionResponseDataSubscriptionFilter" }, "subscription_id": { "type": "string", "description": "Unique identifier of the subscription." }, "tag": { "type": "string", "description": "Optional caller-defined tag." }, "updated_at": { "type": "string", "description": "Subscription last-update time." }, "webhook_id": { "type": "string", "description": "Webhook receiving the subscription events." } }, "additionalProperties": false }, "UpdateActivitySubscriptionResponseDataSubscriptionFilter": { "type": "object", "properties": { "direction": { "type": "string", "description": "Optional direction filter for directional events. Not present for mute.* or block.* events." }, "keyword": { "type": "string", "description": "Optional keyword filter." }, "user_id": { "type": "string", "description": "User the subscription is scoped to." } }, "additionalProperties": false }, "UpdateListsRequest": { "type": "object", "properties": { "description": { "type": "string", "description": "New description for the List (up to 100 characters).", "maxLength": 100 }, "name": { "type": "string", "description": "New name for the List (1-25 characters).", "minLength": 1, "maxLength": 25 }, "private": { "type": "boolean", "description": "Whether the List is private." } }, "additionalProperties": false }, "UpdateListsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateListsResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UpdateListsResponseData": { "type": "object", "required": [ "updated" ], "properties": { "updated": { "type": "boolean", "description": "Indicates whether the List was updated." } } }, "UpdateRulesAdd": { "type": "object", "required": [ "value" ], "properties": { "tag": { "type": "string", "description": "Optional caller-defined label for the rule." }, "value": { "type": "string", "description": "Rule filter expression." } }, "additionalProperties": false }, "UpdateRulesDelete": { "type": "object", "properties": { "ids": { "type": "array", "description": "Rule ids (Snowflake external ids) to delete.", "items": { "type": "string", "pattern": "^[0-9]{1,19}$" } }, "values": { "type": "array", "description": "Rule values to delete.", "items": { "type": "string" } } }, "additionalProperties": false }, "UpdateRulesRequest": { "type": "object", "properties": { "add": { "type": "array", "description": "Rules to add.", "items": { "$ref": "#/components/schemas/UpdateRulesAdd" } }, "delete": { "description": "Rules to delete by id or by value.", "$ref": "#/components/schemas/UpdateRulesDelete" } }, "additionalProperties": false }, "UpdateRulesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateRulesResponseData" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } }, "meta": { "type": "object", "properties": { "sent": { "type": "string" }, "summary": { "type": "object" } } } } }, "UpdateRulesResponseData": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the rule." }, "tag": { "type": "string", "description": "Optional caller-defined label for the rule." }, "value": { "type": "string", "description": "The rule's filter expression." } } }, "UpdateScheduledBroadcastRequest": { "type": "object", "required": [ "scheduled_broadcast_id", "scheduled_start_ms", "scheduled_end_ms" ], "properties": { "available_for_replay": { "type": "boolean", "description": "Enable replay." }, "chat_option": { "type": "string", "description": "Chat permission option (numeric string).", "pattern": "^[0-9]{1,19}$" }, "description": { "type": "string", "description": "Description." }, "is_locked": { "type": "boolean", "description": "Lock the broadcast." }, "locale": { "type": "string", "description": "Locale." }, "manual_publish": { "type": "boolean", "description": "If true, do not auto-publish at start; call POST .../live when ready." }, "roll_forward": { "type": "boolean", "description": "When true, shift the head of a recurring series." }, "scheduled_broadcast_id": { "type": "string", "description": "Numeric scheduler id from create/list/get.", "pattern": "^[0-9]{1,19}$" }, "scheduled_end_ms": { "type": "string", "description": "End time, ms since Unix epoch (decimal string).", "pattern": "^[0-9]{1,19}$" }, "scheduled_start_ms": { "type": "string", "description": "Start time, ms since Unix epoch (decimal string).", "pattern": "^[0-9]{1,19}$" }, "source_id": { "type": "string", "description": "Ingest / source id." }, "thumbnail_media_id": { "type": "string", "description": "Pre-live slate media id (numeric string).", "pattern": "^[0-9]{1,19}$" }, "title": { "type": "string", "description": "Title / status text." } }, "additionalProperties": false }, "UpdateScheduledBroadcastResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateScheduledBroadcastResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "UpdateScheduledBroadcastResponseData": { "type": "object", "properties": { "available_for_replay": { "type": "boolean", "description": "Whether replay is enabled." }, "broadcast_id": { "type": "string", "description": "Alphanumeric UBS broadcast id (path `:id` for get/update/delete/live)." }, "chat_option": { "type": "string", "description": "Optional chat permission option." }, "description": { "type": "string", "description": "Optional description." }, "locale": { "type": "string", "description": "Optional locale." }, "manual_publish": { "type": "boolean", "description": "When true, coordinator will not auto-publish; call POST .../live when ready." }, "recurring_schedule_id": { "type": "string", "description": "Set when this occurrence belongs to a recurrence." }, "scheduled_broadcast_id": { "type": "string", "description": "Numeric scheduler id. Required in the update request body." }, "scheduled_end_ms": { "type": "string", "description": "Scheduled end, milliseconds since Unix epoch (decimal string)." }, "scheduled_start_ms": { "type": "string", "description": "Scheduled start, milliseconds since Unix epoch (decimal string)." }, "source_id": { "type": "string", "description": "Bound ingest / source id (`rtmp_stream_key`)." }, "state": { "type": "string", "description": "Scheduler state (Created, Scheduled, Running, …)." }, "telecast_id": { "type": "string", "description": "Optional telecast association." }, "thumbnail_media_id": { "type": "string", "description": "Optional pre-live slate media id." }, "title": { "type": "string", "description": "Broadcast title / status text." } } }, "Usage": { "type": "object", "properties": { "cap_reset_day": { "type": "integer" }, "daily_client_app_usage": { "$ref": "#/components/schemas/UsageDailyClientAppUsage" }, "daily_project_usage": { "$ref": "#/components/schemas/UsageDailyProjectUsage" }, "project_cap": { "type": "string" }, "project_id": { "type": "string" }, "project_usage": { "type": "string" } } }, "UsageDailyClientAppUsage": { "type": "array", "description": "Per-client-app daily Post usage for the caller's project.", "items": { "type": "object", "description": "Per-client-app daily Post usage entry.", "required": [ "usage_result_count" ], "properties": { "client_app_id": { "type": "string", "description": "Unique identifier of the client app.", "nullable": true }, "usage": { "type": "array", "description": "Daily usage entries for this client app.", "items": { "type": "object", "description": "A single day's usage entry.", "required": [ "date" ], "properties": { "date": { "type": "string", "description": "The day of the usage entry, as an ISO 8601 date-time." }, "usage": { "type": "string", "description": "Number of Posts used on this day.", "nullable": true } } } }, "usage_result_count": { "type": "integer", "description": "Number of daily usage entries returned for this client app.", "format": "int64" } } } }, "UsageDailyProjectUsage": { "type": "object", "description": "Project-level daily Post usage for the caller's project.", "properties": { "project_id": { "type": "string", "description": "Unique identifier of the project.", "nullable": true }, "usage": { "type": "array", "description": "Daily usage entries for the project.", "items": { "type": "object", "description": "A single day's usage entry.", "required": [ "date" ], "properties": { "date": { "type": "string", "description": "The day of the usage entry, as an ISO 8601 date-time." }, "usage": { "type": "string", "description": "Number of Posts used on this day.", "nullable": true } } }, "nullable": true } } }, "User": { "type": "object", "properties": { "affiliation": { "$ref": "#/components/schemas/UserAffiliation" }, "confirmed_email": { "type": "string" }, "connection_status": { "$ref": "#/components/schemas/UserConnectionStatus" }, "created_at": { "type": "string", "description": "Creation time of this User.", "format": "date-time" }, "description": { "type": "string", "description": "The text of this User's profile description (also known as bio), if the User provided one." }, "entities": { "$ref": "#/components/schemas/UserEntities" }, "id": { "type": "string", "description": "Unique identifier of this User." }, "is_identity_verified": { "type": "boolean", "description": "Indicates if this User has completed identity verification." }, "location": { "type": "string", "description": "The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location." }, "most_recent_post_id": { "type": "string", "description": "Unique identifier of this User's most recent Post." }, "name": { "type": "string", "description": "The friendly name of this User, as shown on their profile." }, "parody": { "type": "boolean", "description": "Indicates if this User is a parody account." }, "pinned_post_id": { "type": "string", "description": "Unique identifier of this User's pinned Post." }, "profile_banner_url": { "type": "string", "description": "The URL to the profile banner for this User." }, "profile_image_url": { "type": "string", "description": "The URL to the profile image for this User." }, "protected": { "type": "boolean", "description": "Indicates if this User has chosen to protect their Posts (in other words, if this User's Posts are private)." }, "public_metrics": { "$ref": "#/components/schemas/UserPublicMetrics" }, "receives_your_dm": { "type": "boolean", "description": "Indicates if you can send a DM to this User." }, "subscribes_to_you": { "type": "boolean", "description": "Indicates if this User subscribes to you." }, "subscription": { "$ref": "#/components/schemas/UserSubscription" }, "subscription_type": { "type": "string", "description": "The X Blue subscription type of the user, e.g.: Basic, Premium, PremiumPlus or None." }, "url": { "type": "string", "description": "The URL specified in the User's profile." }, "username": { "type": "string", "description": "The X handle (screen name) of this User." }, "verified": { "type": "boolean", "description": "Indicates if this User is a verified X User." }, "verified_followers_count": { "type": "integer", "description": "The number of verified followers of this User." }, "verified_type": { "type": "string", "description": "The X Blue verified type of the user, e.g.: blue, government, business or none." }, "withheld": { "$ref": "#/components/schemas/UserWithheld" } } }, "UserAffiliation": { "type": "object", "description": "Metadata about a user's affiliation.", "properties": { "badge_url": { "type": "string", "description": "URL of the affiliation badge image shown on the User's profile.", "nullable": true }, "description": { "type": "string", "description": "Description of the affiliation.", "nullable": true }, "url": { "type": "string", "description": "URL associated with the affiliation.", "nullable": true }, "user_id": { "type": "array", "description": "A list of unique identifiers of the accounts this User is affiliated with.", "items": { "type": "string" }, "nullable": true } } }, "UserComplianceData": { "description": "User compliance data.", "oneOf": [ { "$ref": "#/components/schemas/UserProtectComplianceSchema" }, { "$ref": "#/components/schemas/UserUnprotectComplianceSchema" }, { "$ref": "#/components/schemas/UserDeleteComplianceSchema" }, { "$ref": "#/components/schemas/UserUndeleteComplianceSchema" }, { "$ref": "#/components/schemas/UserSuspendComplianceSchema" }, { "$ref": "#/components/schemas/UserUnsuspendComplianceSchema" }, { "$ref": "#/components/schemas/UserWithheldComplianceSchema" }, { "$ref": "#/components/schemas/UserScrubGeoSchema" }, { "$ref": "#/components/schemas/UserProfileModificationComplianceSchema" } ] }, "UserComplianceSchema": { "type": "object", "required": [ "user", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "user": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/UserId" } } } } }, "UserConnectionStatus": { "type": "array", "description": "Returns detailed information about the relationship between two users.", "items": { "type": "string", "description": "A connection between the authenticated User and this User.", "enum": [ "blocking", "follow_request_received", "follow_request_sent", "followed_by", "following", "muting" ] } }, "UserDeleteComplianceSchema": { "type": "object", "required": [ "user_delete" ], "properties": { "user_delete": { "$ref": "#/components/schemas/UserComplianceSchema" } } }, "UserEntities": { "type": "object", "description": "A list of metadata found in the User's profile description.", "properties": { "description": { "type": "object", "description": "Entities found in the User's bio.", "properties": { "cashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "hashtags": { "type": "array", "items": { "type": "object", "description": "A hashtag or cashtag entity.", "required": [ "start", "end", "tag" ], "properties": { "end": { "type": "integer", "description": "End index in the text (exclusive).", "format": "int64" }, "start": { "type": "integer", "description": "Start index in the text (inclusive).", "format": "int64" }, "tag": { "type": "string" } } }, "nullable": true }, "mentions": { "type": "array", "items": { "type": "object", "description": "A user mention entity.", "required": [ "start", "end", "username" ], "properties": { "end": { "type": "integer", "format": "int64" }, "id": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "username": { "type": "string" } } }, "nullable": true }, "urls": { "type": "array", "items": { "type": "object", "description": "A URL entity found in profile text.", "required": [ "start", "end", "url" ], "properties": { "description": { "type": "string", "description": "Description of the linked page, when available.", "nullable": true }, "display_url": { "type": "string", "description": "The URL as displayed in the Post text.", "nullable": true }, "end": { "type": "integer", "format": "int64" }, "expanded_url": { "type": "string", "description": "The fully resolved URL.", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "description": "A preview image for a linked page.", "properties": { "height": { "type": "integer", "format": "int64", "nullable": true }, "url": { "type": "string", "nullable": true }, "width": { "type": "integer", "format": "int64", "nullable": true } } }, "nullable": true }, "media_key": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "description": "HTTP status from resolving the URL.", "format": "int64", "nullable": true }, "title": { "type": "string", "description": "Title of the linked page, when available.", "nullable": true }, "unwound_url": { "type": "string", "description": "The final destination after following redirects.", "nullable": true }, "url": { "type": "string", "description": "The t.co shortened URL." } } }, "nullable": true } }, "nullable": true }, "url": { "type": "object", "description": "Entities for the User's profile website URL.", "properties": { "urls": { "type": "array", "items": { "type": "object", "description": "A URL entity found in profile text.", "required": [ "start", "end", "url" ], "properties": { "description": { "type": "string", "description": "Description of the linked page, when available.", "nullable": true }, "display_url": { "type": "string", "description": "The URL as displayed in the Post text.", "nullable": true }, "end": { "type": "integer", "format": "int64" }, "expanded_url": { "type": "string", "description": "The fully resolved URL.", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "description": "A preview image for a linked page.", "properties": { "height": { "type": "integer", "format": "int64", "nullable": true }, "url": { "type": "string", "nullable": true }, "width": { "type": "integer", "format": "int64", "nullable": true } } }, "nullable": true }, "media_key": { "type": "string", "nullable": true }, "start": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "description": "HTTP status from resolving the URL.", "format": "int64", "nullable": true }, "title": { "type": "string", "description": "Title of the linked page, when available.", "nullable": true }, "unwound_url": { "type": "string", "description": "The final destination after following redirects.", "nullable": true }, "url": { "type": "string", "description": "The t.co shortened URL." } } }, "nullable": true } }, "nullable": true } } }, "UserId": { "type": "string", "description": "Unique identifier of a User", "pattern": "^[0-9]{1,19}$", "example": "2244994945" }, "UserProfileModificationComplianceSchema": { "type": "object", "required": [ "user_profile_modification" ], "properties": { "user_profile_modification": { "$ref": "#/components/schemas/UserProfileModificationObjectSchema" } } }, "UserProfileModificationObjectSchema": { "type": "object", "required": [ "user", "profile_field", "new_value", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "new_value": { "type": "string" }, "profile_field": { "type": "string" }, "user": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/UserId" } } } } }, "UserProtectComplianceSchema": { "type": "object", "required": [ "user_protect" ], "properties": { "user_protect": { "$ref": "#/components/schemas/UserComplianceSchema" } } }, "UserPublicMetrics": { "type": "object", "description": "A list of metrics for this User.", "required": [ "followers_count", "following_count", "post_count", "listed_count" ], "properties": { "followers_count": { "type": "integer", "description": "Number of Users who follow this User.", "format": "int64" }, "following_count": { "type": "integer", "description": "Number of Users this User follows.", "format": "int64" }, "like_count": { "type": "integer", "description": "Number of Posts this User has liked.", "format": "int64", "nullable": true }, "listed_count": { "type": "integer", "description": "Number of Lists that include this User.", "format": "int64" }, "media_count": { "type": "integer", "description": "Number of media items posted by this User.", "format": "int64", "nullable": true }, "post_count": { "type": "integer", "description": "Number of Posts (including Reposts) created by this User.", "format": "int64" } } }, "UserScrubGeoObjectSchema": { "type": "object", "required": [ "user", "up_to_tweet_id", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "up_to_tweet_id": { "$ref": "#/components/schemas/PostId" }, "user": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/UserId" } } } } }, "UserScrubGeoSchema": { "type": "object", "required": [ "scrub_geo" ], "properties": { "scrub_geo": { "$ref": "#/components/schemas/UserScrubGeoObjectSchema" } } }, "UserSubscription": { "type": "object", "description": "The subscription relationship between this User and you.", "required": [ "subscribes_to_you" ], "properties": { "subscribes_to_you": { "type": "boolean", "description": "Indicates if this User subscribes to you." } } }, "UserSuspendComplianceSchema": { "type": "object", "required": [ "user_suspend" ], "properties": { "user_suspend": { "$ref": "#/components/schemas/UserComplianceSchema" } } }, "UserTakedownComplianceSchema": { "type": "object", "required": [ "user", "withheld_in_countries", "event_at" ], "properties": { "event_at": { "type": "string", "description": "Event time.", "format": "date-time", "example": "2021-07-06T18:40:40.000Z" }, "user": { "type": "object", "required": [ "id" ], "properties": { "id": { "$ref": "#/components/schemas/UserId" } } }, "withheld_in_countries": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/CountryCode" } } } }, "UserUndeleteComplianceSchema": { "type": "object", "required": [ "user_undelete" ], "properties": { "user_undelete": { "$ref": "#/components/schemas/UserComplianceSchema" } } }, "UserUnprotectComplianceSchema": { "type": "object", "required": [ "user_unprotect" ], "properties": { "user_unprotect": { "$ref": "#/components/schemas/UserComplianceSchema" } } }, "UserUnsuspendComplianceSchema": { "type": "object", "required": [ "user_unsuspend" ], "properties": { "user_unsuspend": { "$ref": "#/components/schemas/UserComplianceSchema" } } }, "UserWithheld": { "type": "object", "description": "Withholding details for withheld content.", "properties": { "country_codes": { "type": "array", "description": "A list of countries (as ISO 3166-1 alpha-2 codes) where this content is withheld.", "items": { "type": "string" }, "nullable": true }, "scope": { "type": "string", "description": "The scope of the withholding. Only present, with the value \"user\", when the entire User is withheld.", "enum": [ "user" ], "nullable": true } } }, "UserWithheldComplianceSchema": { "type": "object", "required": [ "user_withheld" ], "properties": { "user_withheld": { "$ref": "#/components/schemas/UserTakedownComplianceSchema" } } }, "ValidateAccountActivitySubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ValidateAccountActivitySubscriptionResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ValidateAccountActivitySubscriptionResponseData": { "type": "object", "required": [ "subscribed" ], "properties": { "subscribed": { "type": "boolean", "description": "Whether the user has an active subscription." } } }, "ValidateWebhooksResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ValidateWebhooksResponseData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Problem" } } } }, "ValidateWebhooksResponseData": { "type": "object", "required": [ "valid" ], "properties": { "valid": { "type": "boolean", "description": "Indicates whether the CRC validation check was triggered." } } }, "WebhookConfig": { "type": "object", "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "url": { "type": "string" }, "valid": { "type": "boolean" } } }, "WebhookConfigId": { "type": "string", "description": "Unique identifier of a WebhookConfig", "pattern": "^[0-9]{1,19}$" } }, "parameters": { "AnalyticsFieldsParameter": { "name": "analytics.fields", "in": "query", "description": "A comma separated list of Analytics fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Analytics object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "app_install_attempts", "app_opens", "bookmarks", "detail_expands", "email_tweet", "engagements", "follows", "hashtag_clicks", "id", "impressions", "likes", "media_views", "permalink_clicks", "quote_tweets", "replies", "retweets", "shares", "timestamp", "timestamped_metrics", "unfollows", "unlikes", "url_clicks", "user_profile_clicks" ] } }, "explode": false, "style": "form" }, "BroadcastFieldsParameter": { "name": "broadcast.fields", "in": "query", "description": "A comma separated list of Broadcast fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Broadcast object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "available_for_replay", "broadcast_id", "chat_option", "created_at_ms", "end_ms", "height", "id", "image_url", "image_url_medium", "image_url_small", "is_high_latency", "language", "media_key", "scheduled_end_ms", "scheduled_start_ms", "share_url", "source_id", "start_ms", "state", "title", "total_watched", "total_watching", "tweet_id", "twitter_user_id", "updated_at_ms", "width" ] } }, "explode": false, "style": "form" }, "ChatConversationExpansionsParameter": { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "admin_ids", "member_ids", "participant_ids" ] } }, "explode": false, "style": "form" }, "ChatConversationFieldsParameter": { "name": "chat_conversation.fields", "in": "query", "description": "A comma separated list of ChatConversation fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a ChatConversation object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "created_at", "group_avatar_url", "group_name", "id", "is_muted", "message_ttl_ms", "screen_capture_blocking_enabled", "screen_capture_detection_enabled", "type", "updated_at" ] } }, "explode": false, "style": "form" }, "ChatMessageEventFieldsParameter": { "name": "chat_message_event.fields", "in": "query", "description": "A comma separated list of ChatMessageEvent fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a ChatMessageEvent object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "conversation_id", "conversation_token", "created_at", "encoded_event", "id", "is_trusted", "message_event_signature", "previous_id", "sender_id" ] } }, "explode": false, "style": "form" }, "CommunityFieldsParameter": { "name": "community.fields", "in": "query", "description": "A comma separated list of Community fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Community object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "access", "created_at", "description", "id", "join_policy", "member_count", "name" ] } }, "explode": false, "style": "form" }, "ComplianceJobFieldsParameter": { "name": "compliance_job.fields", "in": "query", "description": "A comma separated list of ComplianceJob fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a ComplianceJob object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "created_at", "download_expires_at", "download_url", "id", "name", "resumable", "status", "type", "upload_expires_at", "upload_url" ] } }, "explode": false, "style": "form" }, "ConnectionFieldsParameter": { "name": "connection.fields", "in": "query", "description": "A comma separated list of Connection fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Connection object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "client_ip", "connected_at", "disconnect_reason", "disconnected_at", "endpoint_name", "id" ] } }, "explode": false, "style": "form" }, "DmEventExpansionsParameter": { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "attachments.media_keys", "attachments.media_keys", "participant_ids", "referenced_posts", "sender_id" ] } }, "explode": false, "style": "form" }, "DmEventFieldsParameter": { "name": "dm_event.fields", "in": "query", "description": "A comma separated list of DmEvent fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a DmEvent object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "attachments", "created_at", "dm_conversation_id", "entities", "event_type", "id", "text" ] } }, "explode": false, "style": "form" }, "ListExpansionsParameter": { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "owner_id" ] } }, "explode": false, "style": "form" }, "ListFieldsParameter": { "name": "list.fields", "in": "query", "description": "A comma separated list of List fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a List object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "created_at", "description", "follower_count", "id", "member_count", "name", "private" ] } }, "explode": false, "style": "form" }, "MediaAnalyticsFieldsParameter": { "name": "media_analytics.fields", "in": "query", "description": "A comma separated list of MediaAnalytics fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a MediaAnalytics object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "cta_url_clicks", "cta_watch_clicks", "media_key", "play_from_tap", "playback25", "playback50", "playback75", "playback_complete", "playback_start", "timestamp", "timestamped_metrics", "video_views", "watch_time_ms" ] } }, "explode": false, "style": "form" }, "MediaFieldsParameter": { "name": "media.fields", "in": "query", "description": "A comma separated list of Media fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Media object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "alt_text", "duration_ms", "height", "media_key", "non_public_metrics", "organic_metrics", "preview_image_url", "promoted_metrics", "public_metrics", "type", "url", "variants", "width" ] } }, "explode": false, "style": "form" }, "NewsFieldsParameter": { "name": "news.fields", "in": "query", "description": "A comma separated list of News fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a News object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "category", "cluster_posts_results", "contexts", "contexts", "contexts", "contexts", "disclaimer", "hook", "id", "keywords", "name", "summary", "updated_at" ] } }, "explode": false, "style": "form" }, "NoteFieldsParameter": { "name": "note.fields", "in": "query", "description": "A comma separated list of Note fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Note object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "id", "info", "scoring_status", "status", "test_result" ] } }, "explode": false, "style": "form" }, "PersonalizedTrendFieldsParameter": { "name": "personalized_trend.fields", "in": "query", "description": "A comma separated list of PersonalizedTrend fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a PersonalizedTrend object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "category", "post_count", "trend_name", "trending_since" ] } }, "explode": false, "style": "form" }, "PlaceFieldsParameter": { "name": "place.fields", "in": "query", "description": "A comma separated list of Place fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Place object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "contained_within", "country", "country_code", "full_name", "geo", "id", "name", "place_type" ] } }, "explode": false, "style": "form" }, "PollFieldsParameter": { "name": "poll.fields", "in": "query", "description": "A comma separated list of Poll fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Poll object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "duration_minutes", "end_datetime", "id", "options", "voting_status" ] } }, "explode": false, "style": "form" }, "PostExpansionsParameter": { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article.cover_media", "article.media_entities", "attachments.media_keys", "attachments.media_source_tweet", "attachments.poll_ids", "author_id", "edit_history_post_ids", "entities.mentions.username", "geo.place_id", "in_reply_to_user_id", "referenced_posts", "username" ] } }, "explode": false, "style": "form" }, "PostFieldsParameter": { "name": "post.fields", "in": "query", "description": "A comma separated list of Post fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Post object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "article", "article_title", "attachments", "card_uri", "community_id", "context_annotations", "conversation_id", "created_at", "display_text_range", "edit_controls", "entities", "geo", "id", "lang", "matched_media_notes", "media_metadata", "non_public_metrics", "note_post", "note_request_suggestions", "organic_metrics", "paid_partnership", "possibly_sensitive", "promoted_metrics", "public_metrics", "reply_settings", "scopes", "source", "suggested_source_links", "suggested_source_links_with_counts", "text", "withheld" ] } }, "explode": false, "style": "form" }, "PublicKeyFieldsParameter": { "name": "public_key.fields", "in": "query", "description": "A comma separated list of PublicKey fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a PublicKey object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "identity_public_key_signature", "juicebox_config", "public_key", "public_key_version", "signing_public_key" ] } }, "explode": false, "style": "form" }, "RulesCountFieldsParameter": { "name": "rules_count.fields", "in": "query", "description": "A comma separated list of RulesCount fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a RulesCount object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "all_project_client_apps", "cap_per_client_app", "cap_per_project", "client_app_rules_count", "project_rules_count" ] } }, "explode": false, "style": "form" }, "SpaceExpansionsParameter": { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "creator_id", "host_ids", "invited_user_ids", "speaker_ids", "topic_ids" ] } }, "explode": false, "style": "form" }, "SpaceFieldsParameter": { "name": "space.fields", "in": "query", "description": "A comma separated list of Space fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Space object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "created_at", "ended_at", "id", "is_ticketed", "lang", "participant_count", "scheduled_start", "started_at", "state", "subscriber_count", "title", "updated_at" ] } }, "explode": false, "style": "form" }, "TopicFieldsParameter": { "name": "topic.fields", "in": "query", "description": "A comma separated list of Topic fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Topic object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "description", "id", "name" ] } }, "explode": false, "style": "form" }, "TrendFieldsParameter": { "name": "trend.fields", "in": "query", "description": "A comma separated list of Trend fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Trend object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "trend_name", "tweet_count" ] } }, "explode": false, "style": "form" }, "UsageFieldsParameter": { "name": "usage.fields", "in": "query", "description": "A comma separated list of Usage fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a Usage object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "cap_reset_day", "daily_client_app_usage", "daily_project_usage", "project_cap", "project_id", "project_usage" ] } }, "explode": false, "style": "form" }, "UserExpansionsParameter": { "name": "expansions", "in": "query", "description": "A comma separated list of fields to expand.", "required": false, "schema": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "affiliation", "most_recent_post_id", "pinned_post_id" ] } }, "explode": false, "style": "form" }, "UserFieldsParameter": { "name": "user.fields", "in": "query", "description": "A comma separated list of User fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a User object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "confirmed_email", "connection_status", "created_at", "description", "entities", "id", "is_identity_verified", "location", "name", "parody", "profile_banner_url", "profile_image_url", "protected", "public_metrics", "receives_your_dm", "subscribes_to_you", "subscription", "subscription_type", "url", "username", "verified", "verified_followers_count", "verified_type", "withheld" ] } }, "explode": false, "style": "form" }, "WebhookConfigFieldsParameter": { "name": "webhook_config.fields", "in": "query", "description": "A comma separated list of WebhookConfig fields to display.", "required": false, "schema": { "type": "array", "description": "The fields available for a WebhookConfig object.", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "created_at", "id", "url", "valid" ] } }, "explode": false, "style": "form" } } } }