{"note":"OpenAPI conversion -- returning structured metadata","name":"twitter-com-current","description":"X API v2","version":"2.175","base_url":"https://api.x.com","endpoints":270,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api X API v2\n@base https://api.x.com\n@version 2.175\n@auth Bearer bearer | OAuth2 | Bearer OAuth\n@endpoints 270\n@hint download_for_search\n@toc 2(270)\n\n@endpoint GET /2/account\n@desc Get Developer Account\n@returns(200) {data: map{account_id: str, created_at: str, name: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/account\n@desc Ensure Developer Account\n@optional {metadata: str # Optional provisioning-credit metadata (an opaque string, e.g. a subscription tier) to claim for the account, attributed to the calling app. Omit to just ensure the account.}\n@returns(200) {data: map{account_id: str, created: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/account_activity/subscriptions/count\n@desc Get Subscription Count\n@returns(200) {data: map{account_name: str, provisioned_count: str, subscriptions_count_all: str, subscriptions_count_direct_messages: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/account_activity/webhooks/{webhook_id}/subscriptions/all\n@desc Validate Subscription\n@required {webhook_id: str}\n@returns(200) {data: map{subscribed: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/account_activity/webhooks/{webhook_id}/subscriptions/all\n@desc Create Subscription\n@required {webhook_id: str}\n@returns(200) {data: map{subscribed: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/account_activity/webhooks/{webhook_id}/subscriptions/all/list\n@desc Get Subscriptions\n@required {webhook_id: str}\n@returns(200) {data: map{application_id: str, subscriptions: [map], webhook_id: str, webhook_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/account_activity/webhooks/{webhook_id}/subscriptions/{user_id}/all\n@desc Delete Subscription\n@required {webhook_id: str, user_id: str}\n@returns(200) {data: map{subscribed: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/activity/stream\n@desc Activity Stream\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the activities will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the activities will be provided.}\n@returns(200) {data: map{created_at: str(date-time), event_type: str, event_uuid: str, filter: map{direction: str, keyword: str, user_id: str}, includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, payload: any, tag: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/activity/subscriptions\n@desc Delete X Activity Subscriptions by IDs\n@required {ids: [str]}\n@returns(200) {data: [map], errors: [map], meta: map{total_subscriptions: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/activity/subscriptions\n@desc Get X Activity Subscriptions\n@optional {max_results: int(int32)=1000, pagination_token: str # A base32hex-encoded pagination token that decodes to 9 bytes., user_id: str # Only return subscriptions whose filter.user_id matches.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/activity/subscriptions\n@desc Create X Activity Subscription\n@required {event_type: str(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/subscriptions.subscribe/subscriptions.unsubscribe/spaces.start/spaces.end/broadcast.start/broadcast.end/broadcast.chat/broadcast.chat.remove/chat.received/chat.sent/chat.conversation.join/chat.conversation_join/chat.conversation.member_added/chat.conversation.member_removed/chat.conversation.admin_added/chat.conversation.admin_removed/chat.update.group_name/chat.update.restrictions/dm.sent/dm.received/dm.indicate_typing/dm.read/post.create/post.delete/post.mention.create/post.reply.create/post.quote.create/post.repost.create/like.create/mute.mute/mute.unmute/block.block/block.unblock) # Activity event type in dot notation. `chat.conversation_join` is a deprecated alias of `chat.conversation.join`; responses always use the canonical name., filter: map{direction: str, keyword: str, qualifiers: map, user_id: str}}\n@optional {expires_at: str # Optional RFC 3339 expiration time. Re-creating the same subscription refreshes this value; omitting it makes the subscription permanent., tag: str # Optional caller-defined tag., webhook_id: str # Webhook to deliver the subscription events to.}\n@returns(200) {data: map{subscription: map{created_at: str, event_type: str, expires_at: str, filter: map{direction: str, keyword: str, qualifiers: map, user_id: str}, subscription_id: str, tag: str, updated_at: str, webhook_id: str}}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/activity/subscriptions/{subscription_id}\n@desc Delete X Activity Subscription\n@required {subscription_id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/activity/subscriptions/{subscription_id}\n@desc Update X Activity Subscription\n@required {subscription_id: str}\n@optional {tag: str # Optional caller-defined tag., webhook_id: str # Webhook to deliver the subscription events to.}\n@returns(200) {data: map{subscription: map{created_at: str, event_type: str, expires_at: str, filter: map{direction: str, keyword: str, qualifiers: map, user_id: str}, subscription_id: str, tag: str, updated_at: str, webhook_id: str}, total_subscriptions: int}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/articles/draft\n@desc Create Draft Article\n@required {content_state: map{blocks!: [map], entities!: [map]}, title: str # The title of the Article.}\n@optional {cover_media: map{media_category!: str, media_id!: str}}\n@returns(201) {data: map{id: str, title: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/articles/{article_id}/publish\n@desc Publish Article\n@required {article_id: str}\n@returns(200) {data: map{post_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/bots\n@desc Get Bots\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{max_bots: int, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/bots\n@desc Create a Bot\n@required {handle: str # The bot's handle (X screen name): 5-15 characters, letters, numbers, or underscores.}\n@optional {display_name: str # The bot's display name; defaults to the handle., org_only: bool # Whether only members of the bot's developer account can add it to group chats. An org-only bot has no public profile and doesn't appear in public search. Everyone in its developer account should be able to message it, so leave its Direct Messages open to everyone rather than premium senders only. Defaults to false. Applies only when the request creates the bot: a handle that already names one of the project's bots keeps that bot's setting, which the response's org_only reports., scopes: [str] # Scopes for the bot's bearer token. Broadcast moderation additionally supports broadcast.read and broadcast.write. Defaults to the XChat scope set (dm.read, dm.write, tweet.read, users.read, media.write).}\n@returns(201) {data: map{id: str, name: str, org_only: bool, scopes: [str], token: str, token_expires_at_ms: int, username: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/bots/{id}\n@desc Delete Bot\n@required {id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/bots/{id}\n@desc Update Bot\n@required {id: str}\n@optional {display_name: str # New display name., dm_permission: str(everyone/premium/no_one) # Who may send the bot Direct Messages: everyone, or premium for verified senders only. Premium isn't meant for org-only bots, since everyone in an org-only bot's developer account should be able to message it, verified or not; requesting premium for one may be refused with a 400. The no_one value is deprecated and kept only so bots that already use it can keep it; choosing it for any other bot may be refused with a 400., handle: str # New handle (X screen name): 5-15 characters, letters, numbers, or underscores.}\n@returns(200) {data: map{updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/bots/{id}/token\n@desc Revoke Bot Token\n@required {id: str}\n@returns(200) {data: map{revoked: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/bots/{id}/token\n@desc Rotate Bot Token\n@required {id: str}\n@optional {scopes: [str] # Scopes for the new bearer token. Broadcast moderation additionally supports broadcast.read and broadcast.write. Defaults to the XChat scope set (dm.read, dm.write, tweet.read, users.read, media.write).}\n@returns(200) {data: map{id: str, name: str, scopes: [str], token: str, token_expires_at_ms: int, username: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts\n@desc List Broadcasts\n@optional {ids: [str] # Comma-separated broadcast IDs to retrieve instead of listing broadcasts., max_results: int(int32), pagination_token: str, broadcast.fields: [str] # A comma separated list of Broadcast fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/broadcasts\n@desc Go Live on a Source\n@required {source_id: str # Id of the source to go live on: a source's `id` (19 digits) from GET /2/sources.}\n@optional {additional_source_ids: [str] # Ids of further sources to go live on together with `source_id`, one per video format, at most 2, each a source's `id` from GET /2/sources. `source_id` comes first; duplicates are ignored., chat_option: int # Who can chat: 0 default, 1 chat off, 2 everyone, 3 verified accounts, 4 accounts the host follows, 5 the host's subscribers, 6 accounts followed by an account the host follows., live_category_id: str # The live category the host picked, e.g. `gaming`. Ids come from GET /2/broadcasts/categories; an unknown id is a 400. Ignored when the source already has a live broadcast., locale: str # Broadcast language, e.g. `en`., should_not_tweet: bool # Skip the Post announcing the broadcast. Defaults to false., title: str # Broadcast title. Defaults to the user's display name.}\n@returns(201) {data: map{broadcast_id: str, chat_option: int, id: str, language: str, live_category_id: str, media_key: str, share_url: str, start_ms: str, state: str, title: str, tweet_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/categories\n@desc List Live Categories\n@returns(200) {data: [map], errors: [any], meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/chat/moderators\n@desc Get Chat Moderators\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/broadcasts/chat/moderators\n@desc Add a Chat Moderator\n@required {user_id: str # The user to appoint as a moderator.}\n@returns(200) {data: map{moderator_user_ids: [str]}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/broadcasts/chat/moderators/{user_id}\n@desc Remove a Chat Moderator\n@required {user_id: str # A 64-bit signed integer.}\n@returns(200) {data: map{moderator_user_ids: [str]}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/chat/mutes\n@desc Get Muted Chat Users\n@optional {max_results: int(int32), pagination_token: str, broadcast_chat_mute.fields: [str] # A comma separated list of BroadcastChatMute fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/broadcasts/chat/mutes\n@desc Mute or Time Out a User in Chat\n@required {user_id: str # The user to mute.}\n@optional {broadcast_id: str # A broadcast whose host's chats the user is muted in. Required with `message_id`., end_at_ms: str # The Unix timestamp in milliseconds when the mute expires. Omit this field to mute indefinitely., message_id: str # A chat message in `broadcast_id` to remove while muting the user.}\n@returns(200) {data: map{muted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/broadcasts/chat/mutes/{user_id}\n@desc Unmute a User in Chat\n@required {user_id: str # A 64-bit signed integer.}\n@optional {broadcast_id: str # A broadcast whose host's chats the user is unmuted in.}\n@returns(200) {data: map{muted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/scheduled\n@desc List Scheduled Broadcasts\n@optional {max_results: int(int32), oldest_start_time: str, newest_start_time: str, pagination_token: str}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/broadcasts/scheduled\n@desc Create a Scheduled Broadcast\n@required {scheduled_start_ms: str # Start time, ms since Unix epoch (decimal string)., source_id: str # Source to bind: a source's `id` from GET /2/sources. A stream key is also accepted but deprecated; stream keys stop being accepted when the /2/users/:id/sources and /2/users/:id/broadcasts routes reach end of life on January 1, 2027.}\n@optional {available_for_replay: bool # Enable replay., chat_option: str # Who can chat (numeric string): `0` default, `1` chat off, `2` everyone, `3` verified accounts, `4` accounts the host follows, `5` the host's subscribers, `6` accounts followed by an account the host follows., description: str # Description., is_locked: bool # Lock the broadcast., locale: str # Locale., manual_publish: bool # If true, do not auto-publish at start; call POST .../live when ready., recurrence: map{frequency!: str, repeats!: str}, scheduled_end_ms: str # Optional end time, ms since Unix epoch (decimal string). Omit for an open-ended broadcast., telecast_id: str # Deprecated: telecast associations are being retired and this field will be ignored., thumbnail_media_id: str # Pre-live slate media id (numeric string)., title: str # Title / status text.}\n@returns(201) {data: map{available_for_replay: bool, broadcast_id: str, chat_option: str, description: str, locale: str, manual_publish: bool, recurring_schedule_id: str, scheduled_broadcast_id: str, scheduled_end_ms: str, scheduled_start_ms: str, source_id: str, state: str, telecast_id: str, thumbnail_media_id: str, title: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/broadcasts/scheduled/{id}\n@desc Delete a Scheduled Broadcast\n@required {id: str}\n@optional {roll_forward: bool # Deprecated: recurring schedules are being retired and `true` will be rejected.}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/scheduled/{id}\n@desc Get a Scheduled Broadcast\n@required {id: str}\n@returns(200) {data: map{available_for_replay: bool, broadcast_id: str, chat_option: str, description: str, locale: str, manual_publish: bool, recurring_schedule_id: str, scheduled_broadcast_id: str, scheduled_end_ms: str, scheduled_start_ms: str, source_id: str, state: str, telecast_id: str, thumbnail_media_id: str, title: str}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/broadcasts/scheduled/{id}\n@desc Update a Scheduled Broadcast\n@required {id: str, scheduled_broadcast_id: str # Numeric scheduler id from create/list/get., scheduled_end_ms: str # End time, ms since Unix epoch (decimal string)., scheduled_start_ms: str # Start time, ms since Unix epoch (decimal string).}\n@optional {available_for_replay: bool # Enable replay., chat_option: str # Who can chat (numeric string): `0` default, `1` chat off, `2` everyone, `3` verified accounts, `4` accounts the host follows, `5` the host's subscribers, `6` accounts followed by an account the host follows., description: str # Description., is_locked: bool # Lock the broadcast., locale: str # Locale., manual_publish: bool # If true, do not auto-publish at start; call POST .../live when ready., roll_forward: bool # Deprecated: recurring schedules are being retired and `true` will be rejected., source_id: str # Source to bind: a source's `id` from GET /2/sources. A stream key is also accepted but deprecated; stream keys stop being accepted when the /2/users/:id/sources and /2/users/:id/broadcasts routes reach end of life on January 1, 2027., thumbnail_media_id: str # Pre-live slate media id (numeric string)., title: str # Title / status text.}\n@returns(200) {data: map{available_for_replay: bool, broadcast_id: str, chat_option: str, description: str, locale: str, manual_publish: bool, recurring_schedule_id: str, scheduled_broadcast_id: str, scheduled_end_ms: str, scheduled_start_ms: str, source_id: str, state: str, telecast_id: str, thumbnail_media_id: str, title: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/broadcasts/scheduled/{id}/live\n@desc Go Live on a Scheduled Broadcast\n@required {id: str}\n@returns(200) {data: map{available_for_replay: bool, broadcast_id: str, chat_option: str, description: str, locale: str, manual_publish: bool, recurring_schedule_id: str, scheduled_broadcast_id: str, scheduled_end_ms: str, scheduled_start_ms: str, source_id: str, state: str, telecast_id: str, thumbnail_media_id: str, title: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/broadcasts/{id}\n@desc Delete a Broadcast\n@required {id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/{id}\n@desc Get a Broadcast\n@required {id: str}\n@optional {broadcast.fields: [str] # A comma separated list of Broadcast fields to display.}\n@returns(200) {data: map{available_for_replay: bool, broadcast_id: str, chat_option: int, created_at_ms: str, end_ms: str, height: int, id: str, image_url: str, image_url_medium: str, image_url_small: str, is_high_latency: bool, language: str, live_category_id: str, media_key: str, scheduled_end_ms: str, scheduled_start_ms: str, share_url: str, source_id: str, start_ms: str, state: str, title: str, total_watched: str, total_watching: str, tweet_id: str, twitter_user_id: str, updated_at_ms: str, width: int}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/broadcasts/{id}\n@desc Update a Broadcast\n@required {id: str}\n@optional {chat_option: int # Who can chat: 0 default, 1 chat off, 2 everyone, 3 verified accounts, 4 accounts the host follows, 5 the host's subscribers, 6 accounts followed by an account the host follows., live_category_id: str # New live category, e.g. `gaming`. Ids come from GET /2/broadcasts/categories; an unknown id is a 400. An empty string removes the broadcast's category., title: str # New broadcast title.}\n@returns(200) {data: map{broadcast_id: str, chat_option: int, id: str, language: str, live_category_id: str, media_key: str, share_url: str, start_ms: str, state: str, title: str, tweet_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/broadcasts/{id}/chat\n@desc Get Broadcast Chat History\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A 64-bit signed integer., broadcast_chat_message.fields: [str] # A comma separated list of BroadcastChatMessage fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/broadcasts/{id}/chat\n@desc Send a Chat Message to a Live Broadcast\n@required {id: str, text: str # The chat message text.}\n@optional {relay_source: str # The platform this message was relayed from, shown as that platform's icon next to the message: `youtube`, `twitch`, `kick`, `facebook`, `rumble`, `tiktok` or `instagram`. Only apps approved for chat relay may set it., reply_to: str # Message id to reply to, returned as timestamp when sent.}\n@returns(200) {data: map{success: bool, timestamp: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/broadcasts/{id}/chat/mutes\n@desc Mute or Time Out a User in a Broadcast Chat\n@required {id: str, user_id: str # The user to mute.}\n@optional {end_at_ms: str # The Unix timestamp in milliseconds when the mute expires. Omit this field to mute indefinitely., message_id: str # A chat message to remove while muting the user.}\n@returns(200) {data: map{muted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/broadcasts/{id}/chat/mutes/{user_id}\n@desc Unmute a User in a Broadcast Chat\n@required {id: str, user_id: str # A 64-bit signed integer.}\n@returns(200) {data: map{muted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/broadcasts/{id}/chat/{message_id}\n@desc Remove a Chat Message from a Live Broadcast\n@required {id: str, message_id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/broadcasts/{id}/state\n@desc End a Broadcast\n@required {id: str, state: str # `END`. `PUBLISH` is not supported.}\n@optional {chat_option: int # Not allowed with `END`., locale: str # Not allowed with `END`., should_not_tweet: bool # Not allowed with `END`., title: str # Not allowed with `END`.}\n@returns(200) {data: map{id: str, state: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/calls\n@desc Create a Call\n@optional {audio_only: bool # Start the call without video., conversation_id: str # XChat conversation to start the call in., join_policy: str(open/closed/trusted) # open (default): anyone with the link joins; closed: the host admits each person; trusted: members of the host's Verified Organization join, others ask., title: str # Title shown to participants.}\n@returns(201) {data: map{conversation_id: str, created_at: str, host_id: str, id: str, join_policy: str, join_url: str, participant_count: int, title: str, viewer_may_join: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/calls/scheduled\n@desc List Scheduled Calls\n@optional {start_time: str(date-time) # Calls still running at this time or starting after it (RFC 3339). Defaults to now., end_time: str(date-time) # Calls starting before this time (RFC 3339). Defaults to 24 hours after start_time., max_results: int(int32) # The most calls to return. Defaults to 20., scheduled_call.fields: [str] # A comma separated list of ScheduledCall fields to display., expansions: [str] # A comma separated list of fields to expand., call.fields: [str] # A comma separated list of Call fields to display., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/calls/scheduled\n@desc Schedule a Call\n@required {start_time: str # When the call starts (RFC 3339); not in the past.}\n@optional {description: str # What the call is about., duration_minutes: int # How long the call lasts, in minutes. Defaults to 30; at most 31 days., invitee_ids: [str] # X user ids of the people to invite., notify_invitees: bool # Whether invitees get an email about the call. Defaults to true., recurrence: str # RFC 5545 RRULE to repeat the call by, such as FREQ=WEEKLY;BYDAY=MO; the RRULE: prefix is optional., time_zone: str # IANA time zone the recurrence follows, such as America/Los_Angeles., title: str # Title invitees see.}\n@returns(201) {data: map{calendar: str, call_id: str, description: str, end_time: str, id: str, invitees: [map], join_url: str, occurrence_start_time: str, organizer_id: str, recurrence: str, start_time: str, status: str, time_zone: str, title: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/calls/scheduled/{id}\n@desc Cancel a Scheduled Call\n@required {id: str}\n@optional {scope: str(all/this/this_and_following) # Which occurrences: all (the default without occurrence_start_time), this (the default with it), or this_and_following., occurrence_start_time: str(date-time) # Start of the occurrence that scope this or this_and_following refers to (RFC 3339)., notify_invitees: bool # Whether invitees get an email about it. Defaults to true.}\n@returns(200) {data: map{cancelled: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/calls/scheduled/{id}\n@desc Get a Scheduled Call\n@required {id: str}\n@optional {scheduled_call.fields: [str] # A comma separated list of ScheduledCall fields to display., expansions: [str] # A comma separated list of fields to expand., call.fields: [str] # A comma separated list of Call fields to display., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: map{calendar: str, call_id: str, description: str, end_time: str, id: str, invitees: [map], join_url: str, occurrence_start_time: str, organizer_id: str, recurrence: str, start_time: str, status: str, time_zone: str, title: str}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint PUT /2/calls/scheduled/{id}\n@desc Update a Scheduled Call\n@required {id: str}\n@optional {description: str # What the call is about., duration_minutes: int # How long the call lasts, in minutes., invitee_ids: [str] # Everyone to invite: replaces the invite list. At most 25 of them may be people not invited yet., notify_invitees: bool # Whether invitees get an email about the change. Defaults to true., occurrence_start_time: str # Start of the occurrence that scope this or this_and_following refers to (RFC 3339)., recurrence: str # RFC 5545 RRULE to repeat the call by, such as FREQ=WEEKLY;BYDAY=MO., scope: str(all/this/this_and_following) # Which occurrences of a recurring call: all (the default without occurrence_start_time), this (the default with it), or this_and_following., start_time: str # When the call (or the chosen occurrence) starts now (RFC 3339)., time_zone: str # IANA time zone the recurrence follows., title: str # Title invitees see.}\n@returns(200) {data: map{updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/calls/scheduled/{id}/rsvp\n@desc Respond to a Scheduled Call\n@required {id: str, response: str(accepted/declined/tentative) # The answer to the invitation.}\n@optional {occurrence_start_time: str # Start of the occurrence that scope this or this_and_following refers to (RFC 3339)., scope: str(all/this/this_and_following) # Which occurrences of a recurring call: all (the default without occurrence_start_time), this (the default with it), or this_and_following.}\n@returns(200) {data: map{response: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/calls/{id}\n@desc Get a Call\n@required {id: str}\n@optional {call.fields: [str] # A comma separated list of Call fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: map{conversation_id: str, created_at: str, host_id: str, id: str, join_policy: str, join_url: str, participant_count: int, title: str, viewer_may_join: bool}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint POST /2/calls/{id}/join\n@desc Join a Call\n@required {id: str}\n@optional {media: map{audio: map, type: str}}\n@returns(200) {data: map{admission: str, call: map{conversation_id: str, created_at: str, host_id: str, id: str, join_policy: str, join_url: str, participant_count: int, title: str, viewer_may_join: bool}, expires_at: str, media_token: str, media_type: str, media_url: str, session_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/calls/{id}/leave\n@desc Leave a Call\n@required {id: str}\n@returns(200) {data: map{left: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/conversations\n@desc Get Chat Conversations\n@optional {max_results: int(int32)=200 # Conversations covered per page (1-1000, default 200). Filtered pages can return fewer., pagination_token: str # meta.next_token from the previous page. Send the same filters with it, or the request fails., unread_only: bool=false # Return only unread conversations. A page can be short; keep paging while has_more., type: str(direct/group) # Only direct (1:1) or only group conversations. Omit for both., is_archived: bool # true: only archived; false: only not archived. Omit for both., is_muted: bool # true: only muted; false: only not muted. Omit for both., participant_ids: [str] # Comma-separated numeric user IDs (1-10), all in the chat. Names or @handles: use participant_query., participant_query: str # Start here to find someone's chat: their @username or a word of their name (1-50 chars)., start_time: str(date-time) # ISO 8601, e.g. 2026-10-16T00:00:00Z. Chats whose latest message is at or after this time., end_time: str(date-time) # ISO 8601, e.g. 2026-10-17T00:00:00Z. Chats whose latest message is before this time., chat_conversation.fields: [str] # A comma separated list of ChatConversation fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{has_message_requests: bool, has_more: bool, next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/group\n@desc Create Chat Group Conversation\n@required {conversation_id: str # Client-generated conversation ID., conversation_key_version: str # Version of the conversation encryption key., conversation_participant_keys: [map{encrypted_conversation_key!: str, public_key_version!: str, user_id!: str}] # Encrypted conversation keys for each participant., group_members: [str] # User IDs of group members to include in the conversation.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., base64_encoded_key_rotation: str # Base64-encoded key rotation payload., group_admins: [str] # User IDs of group admins. Defaults to the creator if omitted., group_avatar_url: str # URL of the avatar image for the group conversation., group_description: str # Description for the group conversation., group_name: str # Display name for the group conversation., ttl_msec: str # Message time-to-live in milliseconds. Messages expire after this duration.}\n@returns(201) {data: map{conversation_id: str, conversation_key_change_sequence_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/group/initialize\n@desc Initialize Chat Group\n@returns(200) {data: map{conversation_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/chat/conversations/{id}\n@desc Delete a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/conversations/{id}\n@desc Get Chat Conversation\n@required {id: str}\n@optional {chat_conversation.fields: [str] # A comma separated list of ChatConversation fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: map{admin_ids: [str], admin_settings: map{add_member: bool?, block_screen_capture: bool?, edit_group_info: bool?, edit_message_ttl: bool?, send_message: bool?, start_call: bool?}, created_at: str(date-time), group_avatar_url: str, group_description: str, group_description_key_version: str, group_name: str, id: str, invite: map{admin_user_id: str?, expires_at: str?, invite_url: str, token: str?, welcome_message: str?}, is_archived: bool, is_muted: bool, last_read_event_id: str, member_ids: [str], message_ttl_ms: int, newest_event_id: str, participant_ids: [str], pending_member_ids: [str], screen_capture_blocking_enabled: bool, screen_capture_detection_enabled: bool, type: str, unread: bool, updated_at: str(date-time)}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint PUT /2/chat/conversations/{id}\n@desc Update a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`., conversation_key_version: str # Version of the conversation key the values are encrypted with., modified_fields: [str] # The group values this request changes.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., base64_encoded_key_rotation: str # Base64-encoded key rotation payload., conversation_participant_keys: [map{encrypted_conversation_key!: str, public_key_version!: str, user_id!: str}] # Encrypted conversation keys for each participant., group_avatar_url: str # Encrypted group avatar URL., group_description: str # Encrypted group description., group_name: str # Encrypted group name., rotated_pmk_bundle: [map{base64_encoded_encrypted_pmk!: str, message_sequence_id!: str, pme_sequence_id: str}] # Message keys re-encrypted with the rotated conversation key.}\n@returns(200) {data: map{conversation_key_change_sequence_id: str, updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/conversations/{id}/admin_requests\n@desc Get Pending Admin Requests for a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`.}\n@optional {pagination_token: str # The next_token from a previous response, to fetch the next page., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, result_count: int(int32), total_count: int}} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/admin_requests\n@desc Request Admin Permissions in a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{requested: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/admin_requests/{user_id}/approve\n@desc Approve an Admin Request in a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`., user_id: str # The ID of the user who requested admin permissions.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{approved: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/admin_requests/{user_id}/reject\n@desc Reject an Admin Request in a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`., user_id: str # The ID of the user who requested admin permissions.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{rejected: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/chat/conversations/{id}/admin_settings\n@desc Update the Admin-Only Settings of a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., add_member: bool # When true, only admins can add members., block_screen_capture: bool # When true, only admins can change screen capture blocking. Through the API, only admins can change screen capture in a group, whatever this setting says., edit_group_info: bool # When true, only admins can edit the group name, avatar, and description., edit_message_ttl: bool # When true, only admins can change the disappearing-message timer., send_message: bool # When true, only admins can send messages., start_call: bool # When true, only admins can start calls.}\n@returns(200) {data: map{updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/admins\n@desc Add Admins to a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`., user_ids: [str] # List of member user IDs to make admins.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{added: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/admins/remove\n@desc Remove Admins from a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`., user_ids: [str] # List of admin user IDs to revoke admin rights from.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{removed: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/chat/conversations/{id}/archive\n@desc Unarchive a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{archived: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/archive\n@desc Archive a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{archived: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/conversations/{id}/events\n@desc Get Chat Conversation Events\n@required {id: str}\n@optional {max_results: int(int32)=10 # The maximum number of events to return., pagination_token: str # The next_token from a previous response, to fetch the next page., chat_message_event.fields: [str] # A comma separated list of ChatMessageEvent fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{conversation_key_events: [str], has_more: bool, next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint DELETE /2/chat/conversations/{id}/invite\n@desc Disable a Chat Group Invite Link\n@required {id: str # The ID of the group conversation, starting with `g`.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{disabled: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/invite\n@desc Enable a Chat Group Invite Link\n@required {id: str # The ID of the group conversation, starting with `g`.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., affiliate_user_id: str # ID of the affiliate account to associate with the link., decrypted_avatar_url: str # Group avatar URL (https) to show on the invite preview., decrypted_title: str # Group name to show on the invite preview., invite_url: str # Invite link built by the client, in the form https://x.com/i/chat/group_join//, where the token is exactly 10 letters, digits, '-' or '_'. The conversation segment must match the path ID. It is part of the signed payload, so it is required when action_signatures is sent., validity_duration_msec: str # How long the link stays valid, in milliseconds, from the time of the request. With action_signatures, send validity_expiry_timestamp_msec instead., validity_expiry_timestamp_msec: str # When the link expires, in epoch milliseconds. Must be in the future. If validity_duration_msec is also sent, the two must agree within a minute., welcome_message: str # Message shown to people who open the link.}\n@returns(200) {data: map{conversation_id: str, expires_at: str, group_avatar_url: str, group_name: str, invite_url: str, token: str, welcome_message: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/conversations/{id}/invites/{token}\n@desc Get a Chat Group Invite Link\n@required {id: str # The ID of the group conversation, starting with `g`., token: str # The 10-character invite token from the group's invite link.}\n@optional {chat_group_invite.fields: [str] # A comma separated list of ChatGroupInvite fields to display.}\n@returns(200) {data: map{conversation_id: str, expires_at: str, group_avatar_url: str, group_name: str, invite_url: str, join_state: str, member_count: int, token: str, welcome_message: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/join_requests\n@desc Request to Join a Chat Group\n@required {id: str # The ID of the group conversation, starting with `g`., token: str # The 10-character invite token from the group's invite link.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{requested: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/join_requests/reject\n@desc Reject Join Requests for a Chat Group Conversation\n@required {id: str # The ID of the group conversation, starting with `g`., user_ids: [str] # List of user IDs whose join requests to reject.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{rejected: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/keys\n@desc Add Conversation Keys\n@required {id: str, conversation_key_version: str # Version of the conversation encryption key (typically a timestamp in milliseconds)., conversation_participant_keys: [map{encrypted_conversation_key!: str, public_key_version!: str, user_id!: str}] # Encrypted conversation keys for each participant.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., base64_encoded_key_rotation: str # Base64-encoded key rotation payload for ratchet tree key management.}\n@returns(200) {data: map{conversation_id: str, sequence_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/members\n@desc Add Members to a Chat Group Conversation\n@required {id: str, user_ids: [str] # List of user IDs to add to the group conversation.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., conversation_key_version: str # Version of the new rotated conversation key., conversation_participant_keys: [map{encrypted_conversation_key!: str, public_key_version!: str, user_id!: str}] # Encrypted conversation keys for each participant., encrypted_avatar_url: str # Re-encrypted group avatar URL with new conversation key., encrypted_title: str # Re-encrypted group title with new conversation key.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/members/remove\n@desc Remove Members from a Chat Group Conversation\n@required {id: str, user_ids: [str] # List of user IDs to remove from the group conversation.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., group_key_rotation_data: map{base64_encoded_key_rotation: str, conversation_key_version: str, conversation_participant_keys: [map], encrypted_avatar: str, encrypted_description: str, encrypted_title: str, rotated_pmk_bundle: [map]}}\n@returns(200) {data: map{removed: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/chat/conversations/{id}/message_ttl\n@desc Turn Off Disappearing Messages in a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/chat/conversations/{id}/message_ttl\n@desc Turn On Disappearing Messages in a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen., message_ttl_ms: str # How long new messages last, in milliseconds.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/messages\n@desc Send Chat Message\n@required {id: str # A conversation's id from Get Chat Conversations, or the recipient's user ID for a 1:1 chat., message_id: str # Unique identifier for this message.}\n@optional {content: map{message: map, reaction_add: map, reaction_remove: map}, conversation_token: str # Optional conversation token., encoded_message_create_event: str # Default. The end-to-end encrypted message: a base64 Thrift MessageCreateEvent from the Chat XDK., encoded_message_event_signature: str # Base64-encoded Thrift MessageEventSignature for message verification., xdk_version: str # Version of the Chat XDK that produced the payload.}\n@returns(201) {data: map{encoded_message_event: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/messages/delete\n@desc Delete Chat Messages\n@required {id: str, action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent., delete_message_action: str(delete_for_all/delete_for_self) # delete_for_all removes the messages for every participant; delete_for_self removes them only from the authenticated user's view., sequence_ids: [str] # Sequence IDs of the messages to delete.}\n@optional {media_hash_keys: [str] # Hash keys of encrypted media blobs to delete alongside the messages (delete_for_all only).}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/chat/conversations/{id}/mute\n@desc Unmute a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{muted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/mute\n@desc Mute a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for this action, forwarded in the order they are sent.}\n@returns(200) {data: map{muted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/conversations/{id}/pinned_messages\n@desc Get Chat Conversation Pinned Messages\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {pagination_token: str # The next_token from a previous response, to fetch the next page., chat_pinned_message.fields: [str] # A comma separated list of ChatPinnedMessage fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/read\n@desc Mark Conversation as Read\n@required {id: str}\n@optional {action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signature over the read receipt (a MarkConversationReadEvent). Omit to send it unsigned.}\n@returns(200) {data: map{success: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/chat/conversations/{id}/screen_capture\n@desc Update Screen Capture Settings for a Chat Conversation\n@required {id: str # The ID of the conversation: a group ID starting with `g`, the other user's ID for a 1:1 conversation, or both user IDs of a 1:1 conversation joined by a hyphen.}\n@optional {blocking: bool # Whether participants are prevented from taking screenshots., blocking_action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for the screenshot blocking change, forwarded in the order they are sent., detection: bool # Whether participants are notified when someone takes a screenshot., detection_action_signatures: [map{encoded_message_event_detail!: str, message_event_signature!: map, message_id!: str, signature_payload: str}] # Signatures for the screenshot detection change, forwarded in the order they are sent.}\n@returns(200) {data: map{blocking: bool, detection: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/typing\n@desc Send Typing Indicator\n@required {id: str}\n@returns(200) {data: map{success: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/conversations/{id}/unread\n@desc Mark Conversation as Unread\n@required {id: str}\n@returns(200) {data: map{success: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/media/upload/initialize\n@desc Initialize Chat Media Upload\n@required {conversation_id: str # The XChat conversation the upload belongs to., total_bytes: int # Total size of the media upload in bytes.}\n@returns(200) {data: map{conversation_id: str, media_hash_key: str, session_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/media/upload/{id}/append\n@desc Append Chat Media Upload\n@required {id: str, conversation_id: str # The XChat conversation the upload belongs to., media: any # The media segment bytes: base64-encoded in JSON bodies, raw bytes in multipart bodies., media_hash_key: str # The media hash key returned by the initialize step., segment_index: int # The index of this segment in the upload sequence.}\n@returns(200) {data: map{expires_at: int}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/media/upload/{id}/finalize\n@desc Finalize Chat Media Upload\n@required {id: str, conversation_id: str # The XChat conversation the upload belongs to., media_hash_key: str # The media hash key returned by the initialize step., num_parts: str # Total number of uploaded parts, as a numeric string.}\n@optional {message_id: str # Optional message identifier associated with the upload., ttl_msec: str # Optional TTL for the media in milliseconds, as a numeric string.}\n@returns(200) {data: map{success: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/media/{id}/{media_hash_key}\n@desc Download Chat Media\n@required {id: str, media_hash_key: str}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/chat/message_requests\n@desc Get Chat Message Requests\n@optional {inbox_type: str(you_may_know/low_quality)=you_may_know # Which message request inbox to list: `you_may_know` (the apps' Priority tab) or `low_quality` (the apps' Hidden tab)., max_results: int(int32)=10 # The maximum number of message requests to return., pagination_token: str # The next_token from a previous response, to fetch the next page., chat_message_request.fields: [str] # A comma separated list of ChatMessageRequest fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, result_count: int(int32), total_count: int}} # The request has succeeded.\n\n@endpoint GET /2/chat/message_requests/{id}\n@desc Get Chat Message Request\n@required {id: str # The other user's ID, or both user IDs joined by a hyphen.}\n@optional {chat_message_request_detail.fields: [str] # A comma separated list of ChatMessageRequestDetail fields to display.}\n@returns(200) {data: map{conversation_id: str, conversation_key_events: [str], has_more_events: bool, message_events: [str], message_request_state: str, participant_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/chat/message_requests/{id}/accept\n@desc Accept a Chat Message Request\n@required {id: str # The other user's ID, or both user IDs joined by a hyphen.}\n@returns(200) {data: map{accepted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/chat/settings\n@desc Get Chat Settings\n@optional {chat_settings.fields: [str] # A comma separated list of ChatSettings fields to display.}\n@returns(200) {data: map{allow_dms_from: str, always_allow_dms_from_subscribers: bool, av_settings: map{av_call_permissions: map?{accept_calls_from_addressbook: bool?, accept_calls_from_everyone: bool?, accept_calls_from_following: bool?, accept_calls_from_verified: bool?}, has_av_calls_enabled: bool?, has_enhanced_call_privacy_enabled: bool?}, dm_quality_filter: str, dm_receipt_settings: str}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/chat/settings\n@desc Update Chat Settings\n@optional {allow_dms_from: str(all/verified/following) # Who can send the user messages: `all` (anyone), `verified` (verified accounts only), or `following` (accounts the user follows). A bot may get a 400 for choosing `following` when it doesn't already have it, and an org-only bot for choosing `verified`., always_allow_dms_from_subscribers: bool # Whether the user's subscribers can always message them regardless of allow_dms_from., av_settings: map{av_call_permissions: map, has_av_calls_enabled: bool, has_enhanced_call_privacy_enabled: bool}, dm_quality_filter: str(enabled/disabled) # Low-quality message request filter: `enabled` (low-quality requests go to a separate folder) or `disabled` (all requests stay in the main inbox)., dm_receipt_settings: str(all_enabled/all_disabled) # Read receipts: `all_enabled` (send and receive read receipts) or `all_disabled` (neither).}\n@returns(200) {data: map{allow_dms_from: str, always_allow_dms_from_subscribers: bool, av_settings: map{av_call_permissions: map{accept_calls_from_addressbook: bool, accept_calls_from_everyone: bool, accept_calls_from_following: bool, accept_calls_from_verified: bool}, has_av_calls_enabled: bool, has_enhanced_call_privacy_enabled: bool}, dm_quality_filter: str, dm_receipt_settings: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/communities/search\n@desc Search Communities\n@required {query: str}\n@optional {max_results: int(int32)=10, next_token: str, pagination_token: str, community.fields: [str] # A comma separated list of Community fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str}} # The request has succeeded.\n\n@endpoint GET /2/communities/{id}\n@desc Get Community by ID\n@required {id: str}\n@optional {community.fields: [str] # A comma separated list of Community fields to display.}\n@returns(200) {data: map{access: str, created_at: str, description: str, id: str, join_policy: str, member_count: int, name: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/compliance/jobs\n@desc Get Compliance Jobs\n@required {type: str(tweets/users)}\n@optional {status: str(created/in_progress/failed/complete), compliance_job.fields: [str] # A comma separated list of ComplianceJob fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/compliance/jobs\n@desc Create Compliance Job\n@required {type: str(tweets/users) # Type of compliance job to list.}\n@optional {compliance_job.fields: [str] # A comma separated list of ComplianceJob fields to display., name: str # A user-provided name for this job., resumable: bool # Whether to enable the upload URL with support for resumable uploads.}\n@returns(200) {data: map{created_at: str, download_expires_at: str, download_url: str, id: str, name: str, resumable: bool, status: str, type: str, upload_expires_at: str, upload_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/compliance/jobs/{id}\n@desc Cancel Compliance Job\n@required {id: str}\n@optional {compliance_job.fields: [str] # A comma separated list of ComplianceJob fields to display.}\n@returns(200) {data: map{created_at: str, download_expires_at: str, download_url: str, id: str, name: str, resumable: bool, status: str, type: str, upload_expires_at: str, upload_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/compliance/jobs/{id}\n@desc Get Compliance Job by ID\n@required {id: str}\n@optional {compliance_job.fields: [str] # A comma separated list of ComplianceJob fields to display.}\n@returns(200) {data: map{created_at: str, download_expires_at: str, download_url: str, id: str, name: str, resumable: bool, status: str, type: str, upload_expires_at: str, upload_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/compliance/jobs/{id}/download\n@desc Download Compliance Job Results\n@required {id: str, token: str # Signed download token from the job's download_url.}\n@optional {compliance_job.fields: [str] # A comma separated list of ComplianceJob fields to display.}\n@returns(200) The request has succeeded.\n\n@endpoint PUT /2/compliance/jobs/{id}/upload\n@desc Upload Compliance Job Submission\n@required {id: str, token: str # Signed upload token from the job's upload_url.}\n@optional {compliance_job.fields: [str] # A comma separated list of ComplianceJob fields to display.}\n@returns(200) {data: map{created_at: str, download_expires_at: str, download_url: str, id: str, name: str, resumable: bool, status: str, type: str, upload_expires_at: str, upload_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/connections\n@desc Terminate Multiple Connections\n@required {uuids: [str] # Connection UUIDs to terminate (1-100).}\n@returns(200) {data: map{failed_kills: int, results: [map], successful_kills: int}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/connections\n@desc Get Connection History\n@optional {status: str(active/inactive/all)=active, endpoints: [str], max_results: int(int32)=10, pagination_token: str, connection.fields: [str] # A comma separated list of Connection fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint DELETE /2/connections/all\n@desc Terminate All Connections\n@returns(200) {data: map{failed_kills: int, results: [map], successful_kills: int}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/connections/{endpoint_id}\n@desc Terminate Connections by Endpoint\n@required {endpoint_id: str(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)}\n@returns(200) {data: map{failed_kills: int, results: [map], successful_kills: int}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/dm_conversations\n@desc Create DM Conversation\n@required {conversation_type: str # The conversation type to create. Supports `Group` only., message: map{attachments: [map], text: str}, participant_ids: [str] # Participants for the conversation.}\n@returns(201) {data: map{dm_conversation_id: str, dm_event_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/dm_conversations/media/{dm_id}/{media_id}/{resource_id}\n@desc Download DM Media\n@required {dm_id: str, media_id: str, resource_id: str}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/dm_conversations/with/{participant_id}/dm_events\n@desc Get DM Events by Participant ID\n@required {participant_id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., event_types: [str]=MessageCreate,ParticipantsLeave,ParticipantsJoin, dm_event.fields: [str] # A comma separated list of DmEvent fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., post.fields: [str] # A comma separated list of Post fields to display., media.fields: [str] # A comma separated list of Media fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/dm_conversations/with/{participant_id}/messages\n@desc Create DM Message by Participant ID\n@required {participant_id: str}\n@optional {attachments: [map{media_id!: str}] # Attachments to include with the message., text: str # Text of the Direct Message.}\n@returns(201) {data: map{dm_conversation_id: str, dm_event_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/dm_conversations/{dm_conversation_id}/messages\n@desc Create DM Message by Conversation ID\n@required {dm_conversation_id: str}\n@optional {attachments: [map{media_id!: str}] # Attachments to include with the message., text: str # Text of the Direct Message.}\n@returns(201) {data: map{dm_conversation_id: str, dm_event_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/dm_conversations/{id}/dm_events\n@desc Get DM Events by Conversation ID\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., event_types: [str]=MessageCreate,ParticipantsLeave,ParticipantsJoin, dm_event.fields: [str] # A comma separated list of DmEvent fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., post.fields: [str] # A comma separated list of Post fields to display., media.fields: [str] # A comma separated list of Media fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/dm_events\n@desc Get DM Events\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., event_types: [str]=MessageCreate,ParticipantsLeave,ParticipantsJoin, dm_event.fields: [str] # A comma separated list of DmEvent fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., post.fields: [str] # A comma separated list of Post fields to display., media.fields: [str] # A comma separated list of Media fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint DELETE /2/dm_events/{event_id}\n@desc Delete DM Event\n@required {event_id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/dm_events/{event_id}\n@desc Get DM Event by ID\n@required {event_id: str}\n@optional {dm_event.fields: [str] # A comma separated list of DmEvent fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., post.fields: [str] # A comma separated list of Post fields to display., media.fields: [str] # A comma separated list of Media fields to display.}\n@returns(200) {data: map{attachments: map{card_ids: [str]?, media_keys: [str]?}, created_at: str(date-time), dm_conversation_id: str, entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, event_type: str, id: str, participant_ids: [str], referenced_posts: [map], sender_id: str, text: str}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/likes/compliance/stream\n@desc Stream Likes Compliance Data\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Likes Compliance events will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Likes Compliance events will be provided.}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/likes/firehose/stream\n@desc Stream All Likes\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided., like_with_tweet_author.fields: [str] # A comma separated list of LikeWithTweetAuthor fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., user.fields: [str] # A comma separated list of User fields to display., tweet.fields: [str] # A comma separated list of Tweet fields to display.}\n@returns(200) {data: map{created_at: str(date-time), id: str, liked_tweet_id: str, timestamp_ms: int(int32), tweet_author_id: str}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/likes/sample10/stream\n@desc Stream Sampled Likes\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Likes will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided., like_with_tweet_author.fields: [str] # A comma separated list of LikeWithTweetAuthor fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., user.fields: [str] # A comma separated list of User fields to display., tweet.fields: [str] # A comma separated list of Tweet fields to display.}\n@returns(200) {data: map{created_at: str(date-time), id: str, liked_tweet_id: str, timestamp_ms: int(int32), tweet_author_id: str}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint POST /2/lists\n@desc Create List\n@required {name: str # Name of the List (1-25 characters).}\n@optional {description: str # Description of the List (up to 100 characters)., private: bool # Whether the List is private.}\n@returns(201) {data: map{id: str, name: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/lists/{id}\n@desc Delete List\n@required {id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/lists/{id}\n@desc Get List by ID\n@required {id: str}\n@optional {list.fields: [str] # A comma separated list of List fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: map{created_at: str, description: str, follower_count: int(int64), id: str, member_count: int(int64), name: str, owner_id: str, private: bool}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint PUT /2/lists/{id}\n@desc Update List\n@required {id: str}\n@optional {description: str # New description for the List (up to 100 characters)., name: str # New name for the List (1-25 characters)., private: bool # Whether the List is private.}\n@returns(200) {data: map{updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/lists/{id}/followers\n@desc Get List Followers\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A 64-bit signed integer., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/lists/{id}/members\n@desc Get List Members\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A 64-bit signed integer., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/lists/{id}/members\n@desc Add List Member\n@required {id: str, user_id: str}\n@returns(200) {data: map{is_member: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/lists/{id}/members/{user_id}\n@desc Remove List Member\n@required {id: str, user_id: str}\n@returns(200) {data: map{is_member: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/lists/{id}/tweets\n@desc Get List Posts\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/media\n@desc Get Media by Media Keys\n@required {media_keys: [str]}\n@optional {media.fields: [str] # A comma separated list of Media fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/amplify/posts\n@desc Add Post to Amplify Programs\n@required {post_id: str # The post to publish. It must belong to the user., program_ids: [str] # The programs to publish the post into.}\n@optional {blocked_advertiser_ids: [str] # Advertiser account ids whose pre-rolls may not run on this post., promotion_ends_at: str # When promotion of the post ends (ISO 8601).}\n@returns(200) {data: map{added: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/amplify/programs\n@desc Get Amplify Programs\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/amplify/programs/{program_id}\n@desc Get Amplify Program\n@required {program_id: str # Identifier of the program.}\n@returns(200) {data: map{advertiser_ids: [str], id: str, name: str, publisher_ids: [str], state: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/amplify/programs/{program_id}/posts\n@desc Get Amplify Program Posts\n@required {program_id: str # Identifier of the program.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/analytics\n@desc Get Media Analytics\n@required {media_keys: [str], start_time: str(date-time), end_time: str(date-time)}\n@optional {granularity: str(hourly/daily/total)=daily, media_analytics.fields: [str] # A comma separated list of MediaAnalytics fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/library\n@desc Add Media to Library\n@required {media_key: str # The media key of the uploaded image, GIF or video to add.}\n@optional {description: str # Description shown with the video in the player card., label: str # Label of the item in the library., monetization: map{allowed_countries: [str], blocked_advertiser_category_ids: [int], blocked_advertiser_ids: [str], enabled: bool, program_id: str, video_category_ids: [int]}, name: str # Name of the item in the library., title: str # Title shown with the video in the player card.}\n@returns(201) {data: map{media_key: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/library/categories\n@desc Get Media Library Categories\n@optional {lang: str # Language tag for category descriptions, e.g. `en` or `pt-BR`.}\n@returns(200) {data: map{advertiser_categories: [map], video_categories: [map]}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/media/library/{media_key}\n@desc Remove Media Library Item\n@required {media_key: str # The media key of the library item to remove.}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/media/library/{media_key}\n@desc Update Media Library Item\n@required {media_key: str # The media key of the library item to update.}\n@optional {description: str # Description shown with the video in the player card., label: str # Label of the item in the library., monetization: map{allowed_countries: [str], blocked_advertiser_category_ids: [int], blocked_advertiser_ids: [str], enabled: bool, program_id: str, video_category_ids: [int]}, name: str # Name of the item in the library., title: str # Title shown with the video in the player card.}\n@returns(200) {data: map{updated: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/metadata\n@desc Create Media Metadata\n@required {id: str # The media id the metadata is attached to., metadata: map{allow_download_status: map, alt_text: map, audience_policy: map, content_expiration: map, domain_restrictions: map, found_media_origin: map, geo_restrictions: map, management_info: map, preview_image: map, sensitive_media_warning: map, shared_info: map, sticker_info: map, upload_source: map}}\n@returns(200) {data: map{associated_metadata: map, id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/media/subtitles\n@desc Delete Media Subtitles\n@required {id: str # The media id of the video the subtitles belong to., language_code: str # The language code of the subtitles to delete., media_category: str # The media category of the target media.}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/subtitles\n@desc Create Media Subtitles\n@required {id: str # The media id of the video the subtitles belong to., media_category: str(AmplifyVideo/TweetVideo) # The media category of the target media., subtitles: map{display_name: str, id: str, language_code: str}}\n@returns(200) {data: map{associated_subtitles: map, id: str, media_category: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/upload\n@desc Get Media Upload Status\n@required {media_id: str # The media id from Initialize Media Upload.}\n@optional {command: str # Always STATUS; can be left out.}\n@returns(200) {data: map{expires_after_secs: int, id: str, image: map{h: int, image_type: str, w: int}, media_key: str, processing_info: map{check_after_secs: int, progress_percent: int, state: str}, size: int, video: map{video_type: str}}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/upload\n@desc Upload Media\n@required {media: any # The media file to upload: base64-encoded in JSON bodies, raw bytes in multipart bodies., media_category: str(tweet_image/tweet_video/tweet_gif/dm_image/dm_video/dm_gif/subtitles) # The category of the media being uploaded.}\n@optional {additional_owners: str # Comma-separated list of user IDs who can use this media.}\n@returns(200) {data: map{expires_after_secs: int, id: str, image: map{h: int, image_type: str, w: int}, media_key: str, processing_info: map{check_after_secs: int, progress_percent: int, state: str}, size: int, video: map{video_type: str}}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/upload/initialize\n@desc Initialize Media Upload\n@optional {additional_owners: [str] # User ids granted access to the uploaded media., media_category: str(amplify_video/tweet_gif/tweet_image/tweet_video/dm_gif/dm_image/dm_video/subtitles) # The media category of the upload., media_type: str(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) # The type of media., shared: bool # Whether this media is shared or not., total_bytes: int # The total size of the media upload in bytes.}\n@returns(200) {data: map{expires_after_secs: int, id: str, media_key: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/upload/{id}/append\n@desc Append Media Upload\n@required {id: str # The upload id from Initialize Media Upload., media: any # One segment of the file: base64-encoded in JSON bodies, raw bytes in multipart bodies., segment_index: int # The segment's position in the file, counting from 0.}\n@returns(200) {data: map{expires_at: int}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/media/upload/{id}/finalize\n@desc Finalize Media Upload\n@required {id: str # The upload id from Initialize Media Upload.}\n@returns(200) {data: map{expires_after_secs: int, id: str, image: map{h: int, image_type: str, w: int}, media_key: str, processing_info: map{check_after_secs: int, progress_percent: int, state: str}, size: int, video: map{video_type: str}}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/media/{media_key}\n@desc Get Media by Media Key\n@required {media_key: str}\n@optional {media.fields: [str] # A comma separated list of Media fields to display.}\n@returns(200) {data: map{alt_text: str, duration_ms: int, height: int, media_key: str, non_public_metrics: map{playback_0_count: int(int64)?, playback_100_count: int(int64)?, playback_25_count: int(int64)?, playback_50_count: int(int64)?, playback_75_count: int(int64)?}, organic_metrics: map{cta_url_click_count: int(int64)?, cta_watch_click_count: int(int64)?, playback_0_count: int(int64)?, playback_100_count: int(int64)?, playback_25_count: int(int64)?, playback_50_count: int(int64)?, playback_75_count: int(int64)?, view_count: int(int64)?, watch_time_ms: int(int64)?}, preview_image_url: str, promoted_metrics: map{playback_0_count: int(int64)?, playback_100_count: int(int64)?, playback_25_count: int(int64)?, playback_50_count: int(int64)?, playback_75_count: int(int64)?, view_count: int(int64)?}, public_metrics: map{view_count: int(int64)}, revenue: map{amount_micros: int(int64), currency_code: str}, type: str, url: str, variants: [map], width: int}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/news/search\n@desc Search News\n@required {query: str}\n@optional {max_results: int(int32)=10, max_age_hours: int(int32)=168, news.fields: [str] # A comma separated list of News fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/news/{id}\n@desc Get News Stories by ID\n@required {id: str}\n@optional {news.fields: [str] # A comma separated list of News fields to display.}\n@returns(200) {data: map{category: str, cluster_posts_results: [map], contexts: map, disclaimer: str, hook: str, id: str, keywords: map, name: str, summary: str, updated_at: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/notes\n@desc Create a Community Note\n@required {info: map{classification!: str, is_media_note: bool, misleading_tags!: [str], text!: str, trustworthy_sources!: bool}, post_id: str # ID of the Post the note is about., test_mode: bool # If true, the note is only for testing and is not publicly visible.}\n@returns(201) {data: map{id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/notes/evaluate\n@desc Evaluate a Community Note\n@required {note_text: str # Text of the community note to evaluate., post_id: str # ID of the Post the note evaluates.}\n@returns(200) {data: map{claim_opinion_score: num}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/notes/search/notes_written\n@desc Search for Community Notes Written\n@required {test_mode: bool}\n@optional {max_results: int(int32)=10, pagination_token: str, note.fields: [str] # A comma separated list of Note fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/notes/search/posts_eligible_for_notes\n@desc Search for Posts Eligible for Community Notes\n@required {test_mode: bool}\n@optional {max_results: int(int32)=10, pagination_token: str, post_selection: str, post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint DELETE /2/notes/{id}\n@desc Delete a Community Note\n@required {id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/openapi.json\n@desc Get OpenAPI Spec\n@returns(200) The request was successful\n\n@endpoint GET /2/region\n@desc Get the Ingest Region\n@returns(200) {region: str} # The request has succeeded.\n\n@endpoint GET /2/sources\n@desc List Stream Sources\n@returns(200) {data: [map], errors: [any], meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/sources\n@desc Create a Stream Source\n@required {name: str # Label for the source., region: str # Ingest region, as returned by GET /2/region. us-west-1 and us-west-2 ingest in US West; us-east-1, us-east-2, ca-central-1, sa-east-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, eu-north-1, ap-south-1, ap-northeast-1, ap-northeast-2, ap-southeast-1 and ap-southeast-2 ingest in US East. The response's `region` is the serving location (`us-east-1` or `us-west-2`).}\n@returns(201) {data: map{created_at_ms: str, id: str, is_stream_active: bool, name: str, region: str, rtmp_url: str, rtmps_url: str, stream_key: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/sources/{id}\n@desc Delete a Stream Source\n@required {id: str # Source id (19 digits), from GET /2/sources.}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/sources/{id}\n@desc Get a Stream Source\n@required {id: str # Source id (19 digits), from GET /2/sources.}\n@returns(200) {data: map{created_at_ms: str, id: str, is_stream_active: bool, name: str, region: str, rtmp_url: str, rtmps_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/sources/{id}\n@desc Rename a Stream Source\n@required {id: str # Source id (19 digits), from GET /2/sources., name: str # New label for the source.}\n@returns(200) {data: map{created_at_ms: str, id: str, is_stream_active: bool, name: str, region: str, rtmp_url: str, rtmps_url: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/sources/{id}/stream_key\n@desc Get a Stream Source's Stream Key\n@required {id: str # Source id (19 digits), from GET /2/sources.}\n@returns(200) {data: map{id: str, stream_key: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/spaces\n@desc Get Spaces by IDs\n@required {ids: [str]}\n@optional {space.fields: [str] # A comma separated list of Space fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., topic.fields: [str] # A comma separated list of Topic fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/spaces/by/creator_ids\n@desc Get Spaces by Creator IDs\n@required {user_ids: [str]}\n@optional {space.fields: [str] # A comma separated list of Space fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., topic.fields: [str] # A comma separated list of Topic fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/spaces/search\n@desc Search Spaces\n@required {query: str}\n@optional {state: str(live/scheduled/all)=all, max_results: int(int32)=100, space.fields: [str] # A comma separated list of Space fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., topic.fields: [str] # A comma separated list of Topic fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/spaces/{id}\n@desc Get Space by ID\n@required {id: str}\n@optional {space.fields: [str] # A comma separated list of Space fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., topic.fields: [str] # A comma separated list of Topic fields to display.}\n@returns(200) {data: map{created_at: str(date-time), creator_id: str, ended_at: str(date-time), host_ids: [str], id: str, invited_user_ids: [str], is_ticketed: bool, lang: str, participant_count: int, scheduled_start: str(date-time), speaker_ids: [str], started_at: str(date-time), state: str, subscriber_count: int, title: str, topic_ids: [str], updated_at: str(date-time)}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/spaces/{id}/buyers\n@desc Get Space Ticket Buyers\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/spaces/{id}/tweets\n@desc Get Space Posts\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/trends/by/woeid/{woeid}\n@desc Get Trends by WOEID\n@required {woeid: int(int32)}\n@optional {max_trends: int(int32)=20, trend.fields: [str] # A comma separated list of Trend fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{location: map}} # The request has succeeded.\n\n@endpoint GET /2/trends/locations\n@desc Get Trend Locations\n@optional {trend_location.fields: [str] # A comma separated list of TrendLocation fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/tweets\n@desc Get Posts by IDs\n@required {ids: [str]}\n@optional {post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/tweets\n@desc Create or Edit Post\n@optional {card_uri: str # Card URI parameter., clip: map{end_seconds!: int, post_id!: str, start_seconds!: int}, community_id: str # Community to post the tweet to., direct_message_deep_link: str # Direct message deep link., edit_options: map{previous_post_id!: str}, for_super_followers_only: bool # Restrict tweet to super followers., geo: map{place_id!: str}, made_with_ai: bool # Disclose that the tweet contains AI-generated media., media: map{call_to_actions: map, description: str, embeddable: bool, media_ids!: [str], preview_media_id: str, tagged_user_ids: [str], title: str}, nullcast: bool # If true, the tweet is not shown in the public timeline., paid_partnership: bool # Disclose that the tweet is a paid partnership., poll: map{duration_minutes!: int, options!: [str], reply_settings: str}, quote_tweet_id: str # Tweet ID to quote., reply: map{auto_populate_reply_metadata: bool, exclude_reply_user_ids: [str], in_reply_to_tweet_id!: str}, reply_settings: str(following/mentionedUsers/subscribers/verified) # Who can reply to this tweet., share_with_followers: bool # Share an exclusive (super-follower) tweet with all followers., text: str= # Text of the Post. Required unless media is provided. At most 280 characters unless the account has X Premium.}\n@returns(201) {data: map{edit_history_post_ids: [str], id: str, text: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/tweets/analytics\n@desc Get Post Analytics\n@required {ids: [str], start_time: str(date-time), end_time: str(date-time)}\n@optional {granularity: str(hourly/weekly/daily/total)=total, analytics.fields: [str] # A comma separated list of Analytics fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/tweets/compliance/stream\n@desc Stream Posts Compliance Data\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post Compliance events will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post Compliance events will be provided.}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/tweets/counts/all\n@desc Get Count of All Posts\n@required {query: str}\n@optional {start_time: str(date-time), end_time: str(date-time), since_id: str, until_id: str, next_token: str # A base32hex-encoded pagination token., pagination_token: str # A base32hex-encoded pagination token., granularity: str(minute/hour/day)=hour, search_count.fields: str}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, total_post_count: int(int64)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/counts/recent\n@desc Get Count of Recent Posts\n@required {query: str}\n@optional {start_time: str(date-time) # Must be within the last 7 days., end_time: str(date-time), since_id: str, until_id: str, next_token: str # A base32hex-encoded pagination token., pagination_token: str # A base32hex-encoded pagination token., granularity: str(minute/hour/day)=hour, search_count.fields: str}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, total_post_count: int(int64)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/firehose/stream\n@desc Stream All Posts\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/firehose/stream/lang/en\n@desc Stream English Posts\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/firehose/stream/lang/ja\n@desc Stream Japanese Posts\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/firehose/stream/lang/ko\n@desc Stream Korean Posts\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/firehose/stream/lang/pt\n@desc Stream Portuguese Posts\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/label/stream\n@desc Stream Post Labels\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Post labels will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the Post labels will be provided.}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/tweets/sample/stream\n@desc Stream Sampled Posts\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/sample10/stream\n@desc Stream 10% Sampled Posts\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/search/all\n@desc Search All Posts\n@required {query: str}\n@optional {start_time: str(date-time), end_time: str(date-time), since_id: str, until_id: str, max_results: int(int32)=10, next_token: str # A base32hex-encoded pagination token., pagination_token: str # A base32hex-encoded pagination token., sort_order: str(recency/relevancy), post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{newest_id: str, next_token: str, oldest_id: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/search/recent\n@desc Search Recent Posts\n@required {query: str}\n@optional {max_results: int(int32)=10, next_token: str # A base32hex-encoded pagination token., pagination_token: str # A base32hex-encoded pagination token., start_time: str(date-time) # Must be within the last 7 days., end_time: str(date-time), since_id: str, until_id: str, sort_order: str(recency/relevancy), post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{newest_id: str, next_token: str, oldest_id: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/search/stream\n@desc Stream Filtered Posts\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Posts will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Posts will be provided., tweet.fields: [str] # A comma separated list of Tweet fields to display., expansions: [str] # A comma separated list of fields to expand., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., user.fields: [str] # A comma separated list of User fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, matching_rules: [map]} # The request has succeeded.\n\n@endpoint GET /2/tweets/search/stream/rules\n@desc Get Stream Rules\n@optional {ids: [str], max_results: int(int32)=1000, pagination_token: str # A base32hex-encoded pagination token that decodes to 8 bytes.}\n@returns(200) {data: [map], errors: [any], meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/tweets/search/stream/rules\n@desc Update Stream Rules\n@optional {dry_run: bool, delete_all: bool, add: [map{tag: str, value!: str}] # Rules to add., delete: map{ids: [any], values: [str]}}\n@returns(200) {data: [map], errors: [any], meta: map{sent: str, summary: map}} # The request has succeeded.\n\n@endpoint GET /2/tweets/search/stream/rules/counts\n@desc Get Stream Rule Counts\n@optional {rules_count.fields: str}\n@returns(200) {data: map{all_project_client_apps: [map], cap_per_client_app: str, cap_per_project: str, client_app_rules_count: map{client_app_id: str, rule_count: int}, project_rules_count: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/tweets/search/webhooks\n@desc Get Stream Links\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/tweets/search/webhooks/{webhook_id}\n@desc Delete Stream Link\n@required {webhook_id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/tweets/search/webhooks/{webhook_id}\n@desc Create Stream Link\n@required {webhook_id: str}\n@returns(200) {data: map{provisioned: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/tweets/{id}\n@desc Delete Post\n@required {id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/tweets/{id}\n@desc Get Post by ID\n@required {id: str}\n@optional {post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: map{article: map, article_title: map, attachments: map{media_keys: [str]?, media_source_tweet_id: [str]?, poll_ids: [str]?}, author_id: str, card_uri: str, community_id: str, context_annotations: [map], conversation_id: str, created_at: str(date-time), display_text_range: [int(int64)], edit_controls: map{editable_until: str?, edits_remaining: int(int64)?, is_edit_eligible: bool?}, edit_history_post_ids: [str], entities: map{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, geo: map{coordinates: map?{coordinates: [num(double)], type: str}, place_id: str?}, id: str, in_reply_to_user_id: str, lang: str, matched_media_notes: [map], media_metadata: [map], non_public_metrics: map, note_post: map{entities: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, text: str}, note_request_suggestions: [map], organic_metrics: map, paid_partnership: bool, possibly_sensitive: bool, promoted_metrics: map, public_metrics: map{bookmark_count: int(int64), impression_count: int(int64), like_count: int(int64), quote_count: int(int64), reply_count: int(int64), repost_count: int(int64)}, referenced_posts: [map], reply_settings: str, scopes: map{followers: bool}, source: str, suggested_source_links: [str], suggested_source_links_with_counts: [map], text: str, username: str, withheld: map{copyright: bool, country_codes: [str], scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/tweets/{id}/liking_users\n@desc Get Liking Users\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/{id}/quote_tweets\n@desc Get Quoted Posts\n@required {id: str}\n@optional {max_results: int(int32)=10, pagination_token: str # A base32hex-encoded pagination token., exclude: [str], post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/{id}/retweeted_by\n@desc Get Reposted By\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/tweets/{id}/retweets\n@desc Get Reposts\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint PUT /2/tweets/{tweet_id}/hidden\n@desc Hide Reply\n@required {tweet_id: str, hidden: bool # Whether the reply should be hidden.}\n@returns(200) {data: map{hidden: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/usage/credits\n@desc Get Usage Credits\n@returns(200) {data: map{free_balance: num, free_grants: [map], prepaid_balance: num, total_balance: num}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/usage/tweets\n@desc Get Usage\n@optional {days: int(int32)=7, usage.fields: [str] # A comma separated list of Usage fields to display.}\n@returns(200) {data: map{cap_reset_day: int, daily_client_app_usage: [map], daily_project_usage: map{project_id: str?, usage: [map]?}, project_cap: str, project_id: str, project_usage: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users\n@desc Get Users by IDs\n@required {ids: [str]}\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/users/by\n@desc Get Users by Usernames\n@required {usernames: [str]}\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/users/by/username/{username}\n@desc Get User by Username\n@required {username: str}\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: map{active_follower_count: int, affiliation: map{badge_url: str?, description: str?, url: str?, user_id: [str]?}, confirmed_email: str, connection_status: [str], created_at: str(date-time), description: str, entities: map{description: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, url: map?{urls: [map]?}}, id: str, is_identity_verified: bool, location: str, most_recent_post_id: str, name: str, org_only: bool, parody: bool, pinned_post_id: str, profile_banner_url: str, profile_image_url: str, protected: bool, public_metrics: map{followers_count: int(int64), following_count: int(int64), like_count: int(int64)?, listed_count: int(int64), media_count: int(int64)?, post_count: int(int64)}, receives_your_chat: str, receives_your_dm: bool, subscriber_count: int, subscribes_to_you: bool, subscription: map{subscribes_to_you: bool}, subscription_type: str, url: str, username: str, verified: bool, verified_followers_count: int, verified_type: str, withheld: map{country_codes: [str]?, scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/users/compliance/stream\n@desc Stream Users Compliance Data\n@required {partition: int(int32) # The partition number.}\n@optional {backfill_minutes: int(int32) # The number of minutes of backfill requested., start_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the User Compliance events will be provided., end_time: str(date-time) # YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp from which the User Compliance events will be provided.}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/users/me\n@desc Get My User\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: map{active_follower_count: int, affiliation: map{badge_url: str?, description: str?, url: str?, user_id: [str]?}, confirmed_email: str, connection_status: [str], created_at: str(date-time), description: str, entities: map{description: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, url: map?{urls: [map]?}}, id: str, is_identity_verified: bool, location: str, most_recent_post_id: str, name: str, org_only: bool, parody: bool, pinned_post_id: str, profile_banner_url: str, profile_image_url: str, protected: bool, public_metrics: map{followers_count: int(int64), following_count: int(int64), like_count: int(int64)?, listed_count: int(int64), media_count: int(int64)?, post_count: int(int64)}, receives_your_chat: str, receives_your_dm: bool, subscriber_count: int, subscribes_to_you: bool, subscription: map{subscribes_to_you: bool}, subscription_type: str, url: str, username: str, verified: bool, verified_followers_count: int, verified_type: str, withheld: map{country_codes: [str]?, scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/users/me/followers\n@desc Get the Authenticated User's Followers\n@optional {max_results: int(int32) # The maximum number of users to return., pagination_token: str # The next_token or previous_token from a previous response, to fetch that page. A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/me/following\n@desc Get the Users the Authenticated User Follows\n@optional {max_results: int(int32) # The maximum number of users to return., pagination_token: str # The next_token or previous_token from a previous response, to fetch that page. A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/personalized_trends\n@desc Get Personalized Trends\n@optional {personalized_trend.fields: [str] # A comma separated list of PersonalizedTrend fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/public_keys\n@desc Get Public Keys for Multiple Users\n@required {ids: [str] # Comma-separated numeric user IDs (1-100), not @usernames.}\n@optional {public_key.fields: [str] # A comma separated list of PublicKey fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/reposts_of_me\n@desc Get Reposts of Me\n@optional {max_results: int(int32)=100, pagination_token: str # A base32hex-encoded pagination token., post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/search\n@desc Search Users\n@required {query: str # A name or @username (1-50 chars): letters and digits in any language, spaces, and _ ' . - @ & \"}\n@optional {max_results: int(int32)=100, next_token: str, user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}\n@desc Get User by ID\n@required {id: str}\n@optional {user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: map{active_follower_count: int, affiliation: map{badge_url: str?, description: str?, url: str?, user_id: [str]?}, confirmed_email: str, connection_status: [str], created_at: str(date-time), description: str, entities: map{description: map?{cashtags: [map]?, hashtags: [map]?, mentions: [map]?, urls: [map]?}, url: map?{urls: [map]?}}, id: str, is_identity_verified: bool, location: str, most_recent_post_id: str, name: str, org_only: bool, parody: bool, pinned_post_id: str, profile_banner_url: str, profile_image_url: str, protected: bool, public_metrics: map{followers_count: int(int64), following_count: int(int64), like_count: int(int64)?, listed_count: int(int64), media_count: int(int64)?, post_count: int(int64)}, receives_your_chat: str, receives_your_dm: bool, subscriber_count: int, subscribes_to_you: bool, subscription: map{subscribes_to_you: bool}, subscription_type: str, url: str, username: str, verified: bool, verified_followers_count: int, verified_type: str, withheld: map{country_codes: [str]?, scope: str?}}, errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/affiliates\n@desc Get Affiliates\n@required {id: str}\n@optional {max_results: int(int32), pagination_token: str # A 64-bit signed integer., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/blocking\n@desc Get Blocked Users\n@required {id: str}\n@optional {max_results: int(int32), pagination_token: str, user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/blocking\n@desc Block User\n@required {id: str, target_user_id: str}\n@returns(200) {data: map{blocking: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/bookmarks\n@desc Get Bookmarks\n@required {id: str # The authenticated user's numeric ID, not `me`: the `id` from Get My User (`GET /2/users/me`).}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token., post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/bookmarks\n@desc Create Bookmark\n@required {id: str # The authenticated user's numeric ID, not `me`: the `id` from Get My User (`GET /2/users/me`).}\n@optional {folder_id: str # Optional ID of the Bookmark folder to add the Post(s) to. When omitted, Posts are added to the user's top-level Bookmarks only. A bulk request uses this one folder for every ID., tweet_id: str # The ID of the Post to add to the user's Bookmarks. Mutually exclusive with `tweet_ids`., tweet_ids: [str] # Post IDs to add to the user's Bookmarks. At most 25. Mutually exclusive with `tweet_id`.}\n@returns(200) The request has succeeded.\n\n@endpoint GET /2/users/{id}/bookmarks/folders\n@desc Get Bookmark Folders\n@required {id: str # The authenticated user's numeric ID, not `me`: the `id` from Get My User (`GET /2/users/me`).}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/bookmarks/folders\n@desc Create Bookmark Folder\n@required {id: str # The authenticated user's numeric ID, not `me`: the `id` from Get My User (`GET /2/users/me`)., name: str # Name of the Bookmark folder (1-25 characters).}\n@returns(201) {data: map{id: str, name: str}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/bookmarks/folders/{folder_id}\n@desc Get Bookmarks by Folder ID\n@required {id: str # The authenticated user's numeric ID, not `me`: the `id` from Get My User (`GET /2/users/me`)., folder_id: str}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/bookmarks/{tweet_id}\n@desc Delete Bookmark\n@required {id: str # The authenticated user's numeric ID, not `me`: the `id` from Get My User (`GET /2/users/me`)., tweet_id: str}\n@returns(200) {data: map{bookmarked: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/broadcasts\n@desc List a User's Broadcasts\n@required {id: str}\n@optional {pagination_token: str # `next_token.offset` from the previous page. Empty reads the first page.}\n@returns(200) {data: map{broadcasts: [map], next_token: map{offset: str}}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/broadcasts\n@desc Create a Broadcast on a User's Source\n@required {id: str, source_id: str # The source's `rtmp_stream_key`.}\n@optional {is_low_latency: any # Ignored., region: str # Ignored: the source sets the region.}\n@returns(200) {data: map{broadcast: map{available_for_replay: bool, broadcast_id: str, chat_option: int, created_at_ms: str, end_ms: str, height: int, id: str, image_url: str, image_url_medium: str, image_url_small: str, is_high_latency: bool, language: str, media_id: str, media_key: str, scheduled_end_ms: str, scheduled_start_ms: str, start_ms: str, state: str, status: str, total_watched: str, total_watching: str, tweet_id: str, twitter_user_id: str, updated_at_ms: str, width: int}, share_url: str, video_access: map}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/broadcasts/{broadcast_id}\n@desc Delete a User's Broadcast\n@required {id: str, broadcast_id: str}\n@returns(200) {data: map{success: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/broadcasts/{broadcast_id}\n@desc Get a User's Broadcast\n@required {id: str, broadcast_id: str}\n@returns(200) {data: map{broadcast: map{available_for_replay: bool, broadcast_id: str, chat_option: int, created_at_ms: str, end_ms: str, height: int, id: str, image_url: str, image_url_medium: str, image_url_small: str, is_high_latency: bool, language: str, media_id: str, media_key: str, scheduled_end_ms: str, scheduled_start_ms: str, start_ms: str, state: str, status: str, total_watched: str, total_watching: str, tweet_id: str, twitter_user_id: str, updated_at_ms: str, width: int}}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/users/{id}/broadcasts/{broadcast_id}/state\n@desc Publish or End a User's Broadcast\n@required {id: str, broadcast_id: str, state: str # `PUBLISH` or `END`.}\n@optional {chat_option: any # Who can chat: 0 default, 1 chat off, 2 everyone, 3 verified accounts, 4 accounts the host follows, 5 the host's subscribers, 6 accounts followed by an account the host follows. A numeric string is also accepted. `PUBLISH` only., locale: str # Broadcast language. `PUBLISH` only., should_not_tweet: any # Skip the announcing Post. Unset keeps the broadcast's setting, which defaults to posting. `\"true\"`, `\"false\"`, `1` and `0` are also accepted. `PUBLISH` only., title: str # Broadcast title. `PUBLISH` only.}\n@returns(200) {data: map{broadcast: map{available_for_replay: bool, broadcast_id: str, chat_option: int, created_at_ms: str, end_ms: str, height: int, id: str, image_url: str, image_url_medium: str, image_url_small: str, is_high_latency: bool, language: str, media_id: str, media_key: str, scheduled_end_ms: str, scheduled_start_ms: str, start_ms: str, state: str, status: str, total_watched: str, total_watching: str, tweet_id: str, twitter_user_id: str, updated_at_ms: str, width: int}, success: bool, tweet_error: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/dm/block\n@desc Block DMs\n@required {id: str}\n@returns(200) {data: map{blocked: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/dm/unblock\n@desc Unblock DMs\n@required {id: str}\n@returns(200) {data: map{blocked: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/followed_lists\n@desc Get Followed Lists\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A 64-bit signed integer., list.fields: [str] # A comma separated list of List fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/followed_lists\n@desc Follow List\n@required {id: str, list_id: str}\n@returns(200) {data: map{following: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/followed_lists/{list_id}\n@desc Unfollow List\n@required {id: str, list_id: str}\n@returns(200) {data: map{following: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/followers\n@desc Get Followers\n@required {id: str}\n@optional {max_results: int(int32) # The maximum number of users to return., pagination_token: str # The next_token or previous_token from a previous response, to fetch that page. A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/following\n@desc Get Following\n@required {id: str}\n@optional {max_results: int(int32) # The maximum number of users to return., pagination_token: str # The next_token or previous_token from a previous response, to fetch that page. A base32hex-encoded pagination token., user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/following\n@desc Follow User\n@required {id: str, target_user_id: str}\n@returns(200) {data: map{following: bool, pending_follow: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/liked_tweets\n@desc Get Liked Posts\n@required {id: str}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token., post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/likes\n@desc Like Post\n@required {id: str, tweet_id: str}\n@returns(200) {data: map{liked: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/likes/{tweet_id}\n@desc Unlike Post\n@required {id: str, tweet_id: str}\n@returns(200) {data: map{liked: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/list_memberships\n@desc Get List Memberships\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str, list.fields: [str] # A comma separated list of List fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/mentions\n@desc Get Mentions\n@required {id: str}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token., start_time: str(date-time) # Must be on or after 2010-11-06., end_time: str(date-time) # Must be on or after 2010-11-06., since_id: str, until_id: str, post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{newest_id: str, next_token: str, oldest_id: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/muting\n@desc Get Muting\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str, user.fields: [str] # A comma separated list of User fields to display., expansions: [str] # A comma separated list of fields to expand., post.fields: [str] # A comma separated list of Post fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/muting\n@desc Mute User\n@required {id: str, target_user_id: str}\n@returns(200) {data: map{muting: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/owned_lists\n@desc Get Owned Lists\n@required {id: str}\n@optional {max_results: int(int32)=100, pagination_token: str # A 64-bit signed integer., list.fields: [str] # A comma separated list of List fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{next_token: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/pinned_lists\n@desc Get Pinned Lists\n@required {id: str}\n@optional {list.fields: [str] # A comma separated list of List fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/pinned_lists\n@desc Pin List\n@required {id: str, list_id: str}\n@returns(200) {data: map{pinned: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/pinned_lists/{list_id}\n@desc Unpin List\n@required {id: str, list_id: str}\n@returns(200) {data: map{pinned: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/public_keys\n@desc Get User Public Keys\n@required {id: str # Numeric user ID, not `me`. For your own keys, use the `id` from Get My User (`GET /2/users/me`).}\n@optional {public_key.fields: [str] # A comma separated list of PublicKey fields to display.}\n@returns(200) {data: [map], errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/public_keys\n@desc Add Public Key\n@required {id: str, public_key: map{identity_public_key_signature: str, public_key: str, public_key_fingerprint: str, registration_method: str, signing_public_key: str, signing_public_key_signature: str}}\n@returns(200) {data: map{juicebox_config: map, public_key_version: str}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/retweets\n@desc Repost Post\n@required {id: str, tweet_id: str}\n@returns(200) {data: map{rest_id: str, retweeted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/retweets/{source_tweet_id}\n@desc Unrepost Post\n@required {id: str, source_tweet_id: str}\n@returns(200) {data: map{retweeted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/sources\n@desc List a User's Stream Sources\n@required {id: str}\n@returns(200) {data: map{sources: [map]}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/users/{id}/sources\n@desc Create a Stream Source for a User\n@required {id: str, name: str # Label for the source.}\n@optional {region: str # Ingest data center, `atla` or `pdxa` (default). The AWS regions us-west-1 and us-west-2 map to `pdxa`; us-east-1, us-east-2, ca-central-1, sa-east-1, eu-west-1, eu-west-2, eu-west-3, eu-central-1, eu-north-1, ap-south-1, ap-northeast-1, ap-northeast-2, ap-southeast-1 and ap-southeast-2 map to `atla`.}\n@returns(200) {data: map{source: map{creation_origin: map{name: str, original_name: str, value: int}, creation_time: int, id: str, is360: bool, is_stream_active: bool, name: str, owner_id: int, rtmp_region: str, rtmp_stream_key: str, rtmp_url: str, rtmps_url: str, video_service: map{name: str, original_name: str, value: int}}}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{id}/sources/{source_id}\n@desc Delete a User's Stream Source\n@required {id: str, source_id: str}\n@returns(200) {data: map, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/sources/{source_id}\n@desc Get a User's Stream Source\n@required {id: str, source_id: str}\n@returns(200) {data: map{source: map{creation_origin: map{name: str, original_name: str, value: int}, creation_time: int, id: str, is360: bool, is_stream_active: bool, name: str, owner_id: int, rtmp_region: str, rtmp_stream_key: str, rtmp_url: str, rtmps_url: str, video_service: map{name: str, original_name: str, value: int}}}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/users/{id}/sources/{source_id}\n@desc Rename a User's Stream Source\n@required {id: str, source_id: str, name: str # New label for the source.}\n@returns(200) {data: map{source: map{creation_origin: map{name: str, original_name: str, value: int}, creation_time: int, id: str, is360: bool, is_stream_active: bool, name: str, owner_id: int, rtmp_region: str, rtmp_stream_key: str, rtmp_url: str, rtmps_url: str, video_service: map{name: str, original_name: str, value: int}}}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/timelines/reverse_chronological\n@desc Get Timeline\n@required {id: str}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token., start_time: str(date-time) # Must be on or after 2010-11-06., end_time: str(date-time) # Must be on or after 2010-11-06., since_id: str, until_id: str, exclude: [str], post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{newest_id: str, next_token: str, oldest_id: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint GET /2/users/{id}/tweets\n@desc Get Posts\n@required {id: str}\n@optional {max_results: int(int32), pagination_token: str # A base32hex-encoded pagination token., start_time: str(date-time) # Must be on or after 2010-11-06., end_time: str(date-time) # Must be on or after 2010-11-06., since_id: str, until_id: str, exclude: [str], post.fields: [str] # A comma separated list of Post fields to display., expansions: [str] # A comma separated list of fields to expand., user.fields: [str] # A comma separated list of User fields to display., media.fields: [str] # A comma separated list of Media fields to display., poll.fields: [str] # A comma separated list of Poll fields to display., place.fields: [str] # A comma separated list of Place fields to display.}\n@returns(200) {data: [map], errors: [any], includes: map{calls: [map], media: [map], places: [map], polls: [map], posts: [map], topics: [map], users: [map]}, meta: map{newest_id: str, next_token: str, oldest_id: str, previous_token: str, result_count: int(int32)}} # The request has succeeded.\n\n@endpoint DELETE /2/users/{source_user_id}/blocking/{target_user_id}\n@desc Unblock User\n@required {source_user_id: str, target_user_id: str}\n@returns(200) {data: map{blocking: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{source_user_id}/following/{target_user_id}\n@desc Unfollow User\n@required {source_user_id: str, target_user_id: str}\n@returns(200) {data: map{following: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/users/{source_user_id}/muting/{target_user_id}\n@desc Unmute User\n@required {source_user_id: str, target_user_id: str}\n@returns(200) {data: map{muting: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint GET /2/webhooks\n@desc Get Webhook\n@optional {webhook_config.fields: [str] # A comma separated list of WebhookConfig fields to display.}\n@returns(200) {data: [map], errors: [any], meta: map{result_count: int(int32)}} # The request has succeeded.\n\n@endpoint POST /2/webhooks\n@desc Create Webhook\n@required {url: str # The URL the webhook delivers events to.}\n@returns(200) {data: map{created_at: str, id: str, url: str, valid: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint POST /2/webhooks/replay\n@desc Create Replay Job for Webhook\n@required {from_date: str # The oldest (inclusive) UTC timestamp from which events are replayed, in yyyymmddhhmm format., to_date: str # The newest (inclusive) UTC timestamp up to which events are replayed, in yyyymmddhhmm format., webhook_id: str # The ID of the webhook to replay events to.}\n@returns(200) {data: map{created_at: str, job_id: str}, errors: [any]} # The request has succeeded.\n\n@endpoint DELETE /2/webhooks/{webhook_id}\n@desc Delete Webhook\n@required {webhook_id: str}\n@returns(200) {data: map{deleted: bool}, errors: [any]} # The request has succeeded.\n\n@endpoint PUT /2/webhooks/{webhook_id}\n@desc Validate Webhook\n@required {webhook_id: str}\n@returns(200) {data: map{valid: bool}, errors: [any]} # The request has succeeded.\n\n@end\n"}