Python API client for dc-rest

Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.

• API version: 10
• Package version: 10
• Build date: 2025-07-05T02:42:22.742560433Z[Etc/UTC]

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/dc-api/dc-rest-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/dc-api/dc-rest-python.git)

Then import the package:

import dc_rest

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import dc_rest

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import dc_rest
from dc_rest.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://discord.com/api/v10
# See configuration.py for a list of all supported configuration parameters.
configuration = dc_rest.Configuration(
    host = "https://discord.com/api/v10"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: BotToken
configuration.api_key['BotToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['BotToken'] = 'Bearer'


# Enter a context with an instance of the API client
async with dc_rest.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dc_rest.DefaultApi(api_client)
    channel_id = 'channel_id_example' # str | 
    user_id = 'user_id_example' # str | 
    add_group_dm_user_request = dc_rest.AddGroupDmUserRequest() # AddGroupDmUserRequest | 

    try:
        api_response = await api_instance.add_group_dm_user(channel_id, user_id, add_group_dm_user_request)
        print("The response of DefaultApi->add_group_dm_user:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->add_group_dm_user: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://discord.com/api/v10

Class	Method	HTTP request	Description
DefaultApi	add_group_dm_user	PUT /channels/{channel_id}/recipients/{user_id}
DefaultApi	add_guild_member	PUT /guilds/{guild_id}/members/{user_id}
DefaultApi	add_guild_member_role	PUT /guilds/{guild_id}/members/{user_id}/roles/{role_id}
DefaultApi	add_lobby_member	PUT /lobbies/{lobby_id}/members/{user_id}
DefaultApi	add_my_message_reaction	PUT /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/@me
DefaultApi	add_thread_member	PUT /channels/{channel_id}/thread-members/{user_id}
DefaultApi	applications_get_activity_instance	GET /applications/{application_id}/activity-instances/{instance_id}
DefaultApi	ban_user_from_guild	PUT /guilds/{guild_id}/bans/{user_id}
DefaultApi	bulk_ban_users_from_guild	POST /guilds/{guild_id}/bulk-ban
DefaultApi	bulk_delete_messages	POST /channels/{channel_id}/messages/bulk-delete
DefaultApi	bulk_set_application_commands	PUT /applications/{application_id}/commands
DefaultApi	bulk_set_guild_application_commands	PUT /applications/{application_id}/guilds/{guild_id}/commands
DefaultApi	bulk_update_guild_channels	PATCH /guilds/{guild_id}/channels
DefaultApi	bulk_update_guild_roles	PATCH /guilds/{guild_id}/roles
DefaultApi	bulk_update_lobby_members	POST /lobbies/{lobby_id}/members/bulk
DefaultApi	consume_entitlement	POST /applications/{application_id}/entitlements/{entitlement_id}/consume
DefaultApi	create_application_command	POST /applications/{application_id}/commands
DefaultApi	create_application_emoji	POST /applications/{application_id}/emojis
DefaultApi	create_auto_moderation_rule	POST /guilds/{guild_id}/auto-moderation/rules
DefaultApi	create_channel_invite	POST /channels/{channel_id}/invites
DefaultApi	create_dm	POST /users/@me/channels
DefaultApi	create_entitlement	POST /applications/{application_id}/entitlements
DefaultApi	create_guild	POST /guilds
DefaultApi	create_guild_application_command	POST /applications/{application_id}/guilds/{guild_id}/commands
DefaultApi	create_guild_channel	POST /guilds/{guild_id}/channels
DefaultApi	create_guild_emoji	POST /guilds/{guild_id}/emojis
DefaultApi	create_guild_from_template	POST /guilds/templates/{code}
DefaultApi	create_guild_role	POST /guilds/{guild_id}/roles
DefaultApi	create_guild_scheduled_event	POST /guilds/{guild_id}/scheduled-events
DefaultApi	create_guild_soundboard_sound	POST /guilds/{guild_id}/soundboard-sounds
DefaultApi	create_guild_sticker	POST /guilds/{guild_id}/stickers
DefaultApi	create_guild_template	POST /guilds/{guild_id}/templates
DefaultApi	create_interaction_response	POST /interactions/{interaction_id}/{interaction_token}/callback
DefaultApi	create_lobby	POST /lobbies
DefaultApi	create_lobby_message	POST /lobbies/{lobby_id}/messages
DefaultApi	create_message	POST /channels/{channel_id}/messages
DefaultApi	create_or_join_lobby	PUT /lobbies
DefaultApi	create_pin	PUT /channels/{channel_id}/messages/pins/{message_id}
DefaultApi	create_stage_instance	POST /stage-instances
DefaultApi	create_thread	POST /channels/{channel_id}/threads
DefaultApi	create_thread_from_message	POST /channels/{channel_id}/messages/{message_id}/threads
DefaultApi	create_webhook	POST /channels/{channel_id}/webhooks
DefaultApi	crosspost_message	POST /channels/{channel_id}/messages/{message_id}/crosspost
DefaultApi	delete_all_message_reactions	DELETE /channels/{channel_id}/messages/{message_id}/reactions
DefaultApi	delete_all_message_reactions_by_emoji	DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}
DefaultApi	delete_application_command	DELETE /applications/{application_id}/commands/{command_id}
DefaultApi	delete_application_emoji	DELETE /applications/{application_id}/emojis/{emoji_id}
DefaultApi	delete_application_user_role_connection	DELETE /users/@me/applications/{application_id}/role-connection
DefaultApi	delete_auto_moderation_rule	DELETE /guilds/{guild_id}/auto-moderation/rules/{rule_id}
DefaultApi	delete_channel	DELETE /channels/{channel_id}
DefaultApi	delete_channel_permission_overwrite	DELETE /channels/{channel_id}/permissions/{overwrite_id}
DefaultApi	delete_entitlement	DELETE /applications/{application_id}/entitlements/{entitlement_id}
DefaultApi	delete_group_dm_user	DELETE /channels/{channel_id}/recipients/{user_id}
DefaultApi	delete_guild	DELETE /guilds/{guild_id}
DefaultApi	delete_guild_application_command	DELETE /applications/{application_id}/guilds/{guild_id}/commands/{command_id}
DefaultApi	delete_guild_emoji	DELETE /guilds/{guild_id}/emojis/{emoji_id}
DefaultApi	delete_guild_integration	DELETE /guilds/{guild_id}/integrations/{integration_id}
DefaultApi	delete_guild_member	DELETE /guilds/{guild_id}/members/{user_id}
DefaultApi	delete_guild_member_role	DELETE /guilds/{guild_id}/members/{user_id}/roles/{role_id}
DefaultApi	delete_guild_role	DELETE /guilds/{guild_id}/roles/{role_id}
DefaultApi	delete_guild_scheduled_event	DELETE /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}
DefaultApi	delete_guild_soundboard_sound	DELETE /guilds/{guild_id}/soundboard-sounds/{sound_id}
DefaultApi	delete_guild_sticker	DELETE /guilds/{guild_id}/stickers/{sticker_id}
DefaultApi	delete_guild_template	DELETE /guilds/{guild_id}/templates/{code}
DefaultApi	delete_lobby_member	DELETE /lobbies/{lobby_id}/members/{user_id}
DefaultApi	delete_message	DELETE /channels/{channel_id}/messages/{message_id}
DefaultApi	delete_my_message_reaction	DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/@me
DefaultApi	delete_original_webhook_message	DELETE /webhooks/{webhook_id}/{webhook_token}/messages/@original
DefaultApi	delete_pin	DELETE /channels/{channel_id}/messages/pins/{message_id}
DefaultApi	delete_stage_instance	DELETE /stage-instances/{channel_id}
DefaultApi	delete_thread_member	DELETE /channels/{channel_id}/thread-members/{user_id}
DefaultApi	delete_user_message_reaction	DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/{user_id}
DefaultApi	delete_webhook	DELETE /webhooks/{webhook_id}
DefaultApi	delete_webhook_by_token	DELETE /webhooks/{webhook_id}/{webhook_token}
DefaultApi	delete_webhook_message	DELETE /webhooks/{webhook_id}/{webhook_token}/messages/{message_id}
DefaultApi	deprecated_create_pin	PUT /channels/{channel_id}/pins/{message_id}
DefaultApi	deprecated_delete_pin	DELETE /channels/{channel_id}/pins/{message_id}
DefaultApi	deprecated_list_pins	GET /channels/{channel_id}/pins
DefaultApi	edit_lobby	PATCH /lobbies/{lobby_id}
DefaultApi	edit_lobby_channel_link	PATCH /lobbies/{lobby_id}/channel-linking
DefaultApi	execute_github_compatible_webhook	POST /webhooks/{webhook_id}/{webhook_token}/github
DefaultApi	execute_slack_compatible_webhook	POST /webhooks/{webhook_id}/{webhook_token}/slack
DefaultApi	execute_webhook	POST /webhooks/{webhook_id}/{webhook_token}
DefaultApi	follow_channel	POST /channels/{channel_id}/followers
DefaultApi	get_active_guild_threads	GET /guilds/{guild_id}/threads/active
DefaultApi	get_answer_voters	GET /channels/{channel_id}/polls/{message_id}/answers/{answer_id}
DefaultApi	get_application	GET /applications/{application_id}
DefaultApi	get_application_command	GET /applications/{application_id}/commands/{command_id}
DefaultApi	get_application_emoji	GET /applications/{application_id}/emojis/{emoji_id}
DefaultApi	get_application_role_connections_metadata	GET /applications/{application_id}/role-connections/metadata
DefaultApi	get_application_user_role_connection	GET /users/@me/applications/{application_id}/role-connection
DefaultApi	get_auto_moderation_rule	GET /guilds/{guild_id}/auto-moderation/rules/{rule_id}
DefaultApi	get_bot_gateway	GET /gateway/bot
DefaultApi	get_channel	GET /channels/{channel_id}
DefaultApi	get_entitlement	GET /applications/{application_id}/entitlements/{entitlement_id}
DefaultApi	get_entitlements	GET /applications/{application_id}/entitlements
DefaultApi	get_gateway	GET /gateway
DefaultApi	get_guild	GET /guilds/{guild_id}
DefaultApi	get_guild_application_command	GET /applications/{application_id}/guilds/{guild_id}/commands/{command_id}
DefaultApi	get_guild_application_command_permissions	GET /applications/{application_id}/guilds/{guild_id}/commands/{command_id}/permissions
DefaultApi	get_guild_ban	GET /guilds/{guild_id}/bans/{user_id}
DefaultApi	get_guild_emoji	GET /guilds/{guild_id}/emojis/{emoji_id}
DefaultApi	get_guild_member	GET /guilds/{guild_id}/members/{user_id}
DefaultApi	get_guild_new_member_welcome	GET /guilds/{guild_id}/new-member-welcome
DefaultApi	get_guild_preview	GET /guilds/{guild_id}/preview
DefaultApi	get_guild_role	GET /guilds/{guild_id}/roles/{role_id}
DefaultApi	get_guild_scheduled_event	GET /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}
DefaultApi	get_guild_soundboard_sound	GET /guilds/{guild_id}/soundboard-sounds/{sound_id}
DefaultApi	get_guild_sticker	GET /guilds/{guild_id}/stickers/{sticker_id}
DefaultApi	get_guild_template	GET /guilds/templates/{code}
DefaultApi	get_guild_vanity_url	GET /guilds/{guild_id}/vanity-url
DefaultApi	get_guild_webhooks	GET /guilds/{guild_id}/webhooks
DefaultApi	get_guild_welcome_screen	GET /guilds/{guild_id}/welcome-screen
DefaultApi	get_guild_widget	GET /guilds/{guild_id}/widget.json
DefaultApi	get_guild_widget_png	GET /guilds/{guild_id}/widget.png
DefaultApi	get_guild_widget_settings	GET /guilds/{guild_id}/widget
DefaultApi	get_guilds_onboarding	GET /guilds/{guild_id}/onboarding
DefaultApi	get_lobby	GET /lobbies/{lobby_id}
DefaultApi	get_lobby_messages	GET /lobbies/{lobby_id}/messages
DefaultApi	get_message	GET /channels/{channel_id}/messages/{message_id}
DefaultApi	get_my_application	GET /applications/@me
DefaultApi	get_my_guild_member	GET /users/@me/guilds/{guild_id}/member
DefaultApi	get_my_oauth2_application	GET /oauth2/applications/@me
DefaultApi	get_my_oauth2_authorization	GET /oauth2/@me
DefaultApi	get_my_user	GET /users/@me
DefaultApi	get_openid_connect_userinfo	GET /oauth2/userinfo
DefaultApi	get_original_webhook_message	GET /webhooks/{webhook_id}/{webhook_token}/messages/@original
DefaultApi	get_public_keys	GET /oauth2/keys
DefaultApi	get_self_voice_state	GET /guilds/{guild_id}/voice-states/@me
DefaultApi	get_soundboard_default_sounds	GET /soundboard-default-sounds
DefaultApi	get_stage_instance	GET /stage-instances/{channel_id}
DefaultApi	get_sticker	GET /stickers/{sticker_id}
DefaultApi	get_sticker_pack	GET /sticker-packs/{pack_id}
DefaultApi	get_thread_member	GET /channels/{channel_id}/thread-members/{user_id}
DefaultApi	get_user	GET /users/{user_id}
DefaultApi	get_voice_state	GET /guilds/{guild_id}/voice-states/{user_id}
DefaultApi	get_webhook	GET /webhooks/{webhook_id}
DefaultApi	get_webhook_by_token	GET /webhooks/{webhook_id}/{webhook_token}
DefaultApi	get_webhook_message	GET /webhooks/{webhook_id}/{webhook_token}/messages/{message_id}
DefaultApi	invite_resolve	GET /invites/{code}
DefaultApi	invite_revoke	DELETE /invites/{code}
DefaultApi	join_thread	PUT /channels/{channel_id}/thread-members/@me
DefaultApi	leave_guild	DELETE /users/@me/guilds/{guild_id}
DefaultApi	leave_lobby	DELETE /lobbies/{lobby_id}/members/@me
DefaultApi	leave_thread	DELETE /channels/{channel_id}/thread-members/@me
DefaultApi	list_application_commands	GET /applications/{application_id}/commands
DefaultApi	list_application_emojis	GET /applications/{application_id}/emojis
DefaultApi	list_auto_moderation_rules	GET /guilds/{guild_id}/auto-moderation/rules
DefaultApi	list_channel_invites	GET /channels/{channel_id}/invites
DefaultApi	list_channel_webhooks	GET /channels/{channel_id}/webhooks
DefaultApi	list_guild_application_command_permissions	GET /applications/{application_id}/guilds/{guild_id}/commands/permissions
DefaultApi	list_guild_application_commands	GET /applications/{application_id}/guilds/{guild_id}/commands
DefaultApi	list_guild_audit_log_entries	GET /guilds/{guild_id}/audit-logs
DefaultApi	list_guild_bans	GET /guilds/{guild_id}/bans
DefaultApi	list_guild_channels	GET /guilds/{guild_id}/channels
DefaultApi	list_guild_emojis	GET /guilds/{guild_id}/emojis
DefaultApi	list_guild_integrations	GET /guilds/{guild_id}/integrations
DefaultApi	list_guild_invites	GET /guilds/{guild_id}/invites
DefaultApi	list_guild_members	GET /guilds/{guild_id}/members
DefaultApi	list_guild_roles	GET /guilds/{guild_id}/roles
DefaultApi	list_guild_scheduled_event_users	GET /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}/users
DefaultApi	list_guild_scheduled_events	GET /guilds/{guild_id}/scheduled-events
DefaultApi	list_guild_soundboard_sounds	GET /guilds/{guild_id}/soundboard-sounds
DefaultApi	list_guild_stickers	GET /guilds/{guild_id}/stickers
DefaultApi	list_guild_templates	GET /guilds/{guild_id}/templates
DefaultApi	list_guild_voice_regions	GET /guilds/{guild_id}/regions
DefaultApi	list_message_reactions_by_emoji	GET /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}
DefaultApi	list_messages	GET /channels/{channel_id}/messages
DefaultApi	list_my_connections	GET /users/@me/connections
DefaultApi	list_my_guilds	GET /users/@me/guilds
DefaultApi	list_my_private_archived_threads	GET /channels/{channel_id}/users/@me/threads/archived/private
DefaultApi	list_pins	GET /channels/{channel_id}/messages/pins
DefaultApi	list_private_archived_threads	GET /channels/{channel_id}/threads/archived/private
DefaultApi	list_public_archived_threads	GET /channels/{channel_id}/threads/archived/public
DefaultApi	list_sticker_packs	GET /sticker-packs
DefaultApi	list_thread_members	GET /channels/{channel_id}/thread-members
DefaultApi	list_voice_regions	GET /voice/regions
DefaultApi	partner_sdk_token	POST /partner-sdk/token
DefaultApi	partner_sdk_unmerge_provisional_account	POST /partner-sdk/provisional-accounts/unmerge
DefaultApi	poll_expire	POST /channels/{channel_id}/polls/{message_id}/expire
DefaultApi	preview_prune_guild	GET /guilds/{guild_id}/prune
DefaultApi	prune_guild	POST /guilds/{guild_id}/prune
DefaultApi	put_guilds_onboarding	PUT /guilds/{guild_id}/onboarding
DefaultApi	search_guild_members	GET /guilds/{guild_id}/members/search
DefaultApi	send_soundboard_sound	POST /channels/{channel_id}/send-soundboard-sound
DefaultApi	set_channel_permission_overwrite	PUT /channels/{channel_id}/permissions/{overwrite_id}
DefaultApi	set_guild_application_command_permissions	PUT /applications/{application_id}/guilds/{guild_id}/commands/{command_id}/permissions
DefaultApi	set_guild_mfa_level	POST /guilds/{guild_id}/mfa
DefaultApi	sync_guild_template	PUT /guilds/{guild_id}/templates/{code}
DefaultApi	thread_search	GET /channels/{channel_id}/threads/search
DefaultApi	trigger_typing_indicator	POST /channels/{channel_id}/typing
DefaultApi	unban_user_from_guild	DELETE /guilds/{guild_id}/bans/{user_id}
DefaultApi	update_application	PATCH /applications/{application_id}
DefaultApi	update_application_command	PATCH /applications/{application_id}/commands/{command_id}
DefaultApi	update_application_emoji	PATCH /applications/{application_id}/emojis/{emoji_id}
DefaultApi	update_application_role_connections_metadata	PUT /applications/{application_id}/role-connections/metadata
DefaultApi	update_application_user_role_connection	PUT /users/@me/applications/{application_id}/role-connection
DefaultApi	update_auto_moderation_rule	PATCH /guilds/{guild_id}/auto-moderation/rules/{rule_id}
DefaultApi	update_channel	PATCH /channels/{channel_id}
DefaultApi	update_guild	PATCH /guilds/{guild_id}
DefaultApi	update_guild_application_command	PATCH /applications/{application_id}/guilds/{guild_id}/commands/{command_id}
DefaultApi	update_guild_emoji	PATCH /guilds/{guild_id}/emojis/{emoji_id}
DefaultApi	update_guild_member	PATCH /guilds/{guild_id}/members/{user_id}
DefaultApi	update_guild_role	PATCH /guilds/{guild_id}/roles/{role_id}
DefaultApi	update_guild_scheduled_event	PATCH /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}
DefaultApi	update_guild_soundboard_sound	PATCH /guilds/{guild_id}/soundboard-sounds/{sound_id}
DefaultApi	update_guild_sticker	PATCH /guilds/{guild_id}/stickers/{sticker_id}
DefaultApi	update_guild_template	PATCH /guilds/{guild_id}/templates/{code}
DefaultApi	update_guild_welcome_screen	PATCH /guilds/{guild_id}/welcome-screen
DefaultApi	update_guild_widget_settings	PATCH /guilds/{guild_id}/widget
DefaultApi	update_message	PATCH /channels/{channel_id}/messages/{message_id}
DefaultApi	update_my_application	PATCH /applications/@me
DefaultApi	update_my_guild_member	PATCH /guilds/{guild_id}/members/@me
DefaultApi	update_my_user	PATCH /users/@me
DefaultApi	update_original_webhook_message	PATCH /webhooks/{webhook_id}/{webhook_token}/messages/@original
DefaultApi	update_self_voice_state	PATCH /guilds/{guild_id}/voice-states/@me
DefaultApi	update_stage_instance	PATCH /stage-instances/{channel_id}
DefaultApi	update_voice_state	PATCH /guilds/{guild_id}/voice-states/{user_id}
DefaultApi	update_webhook	PATCH /webhooks/{webhook_id}
DefaultApi	update_webhook_by_token	PATCH /webhooks/{webhook_id}/{webhook_token}
DefaultApi	update_webhook_message	PATCH /webhooks/{webhook_id}/{webhook_token}/messages/{message_id}
DefaultApi	upload_application_attachment	POST /applications/{application_id}/attachment

Documentation For Models

• AccountResponse
• ActionRowComponentForMessageRequest
• ActionRowComponentForMessageRequestComponentsInner
• ActionRowComponentForModalRequest
• ActionRowComponentResponse
• ActionRowComponentResponseComponentsInner
• ActivitiesAttachmentResponse
• AddGroupDmUser201Response
• AddGroupDmUserRequest
• AddGuildMemberRequest
• AddLobbyMemberRequest
• ApplicationCommandAttachmentOption
• ApplicationCommandAttachmentOptionResponse
• ApplicationCommandAutocompleteCallbackRequest
• ApplicationCommandAutocompleteCallbackRequestData
• ApplicationCommandBooleanOption
• ApplicationCommandBooleanOptionResponse
• ApplicationCommandChannelOption
• ApplicationCommandChannelOptionResponse
• ApplicationCommandCreateRequest
• ApplicationCommandCreateRequestOptionsInner
• ApplicationCommandIntegerOption
• ApplicationCommandIntegerOptionResponse
• ApplicationCommandInteractionMetadataResponse
• ApplicationCommandMentionableOption
• ApplicationCommandMentionableOptionResponse
• ApplicationCommandNumberOption
• ApplicationCommandNumberOptionResponse
• ApplicationCommandOptionIntegerChoice
• ApplicationCommandOptionIntegerChoiceResponse
• ApplicationCommandOptionNumberChoice
• ApplicationCommandOptionNumberChoiceResponse
• ApplicationCommandOptionStringChoice
• ApplicationCommandOptionStringChoiceResponse
• ApplicationCommandPatchRequestPartial
• ApplicationCommandPermission
• ApplicationCommandResponse
• ApplicationCommandResponseOptionsInner
• ApplicationCommandRoleOption
• ApplicationCommandRoleOptionResponse
• ApplicationCommandStringOption
• ApplicationCommandStringOptionResponse
• ApplicationCommandSubcommandGroupOption
• ApplicationCommandSubcommandGroupOptionResponse
• ApplicationCommandSubcommandOption
• ApplicationCommandSubcommandOptionOptionsInner
• ApplicationCommandSubcommandOptionResponse
• ApplicationCommandSubcommandOptionResponseOptionsInner
• ApplicationCommandUpdateRequest
• ApplicationCommandUserOption
• ApplicationCommandUserOptionResponse
• ApplicationFormPartial
• ApplicationFormPartialDescription
• ApplicationFormPartialIntegrationTypesConfigValue
• ApplicationIncomingWebhookResponse
• ApplicationIntegrationTypeConfiguration
• ApplicationIntegrationTypeConfigurationResponse
• ApplicationOAuth2InstallParams
• ApplicationOAuth2InstallParamsResponse
• ApplicationResponse
• ApplicationRoleConnectionsMetadataItemRequest
• ApplicationRoleConnectionsMetadataItemResponse
• ApplicationUserRoleConnectionResponse
• AttachmentResponse
• AuditLogEntryResponse
• AuditLogObjectChangeResponse
• BanUserFromGuildRequest
• BaseCreateMessageCreateRequest
• BaseCreateMessageCreateRequestComponentsInner
• BasicApplicationResponse
• BasicMessageResponse
• BasicMessageResponseComponentsInner
• BasicMessageResponseInteractionMetadata
• BasicMessageResponseNonce
• BlockMessageAction
• BlockMessageActionMetadata
• BlockMessageActionMetadataResponse
• BlockMessageActionResponse
• BotAccountPatchRequest
• BulkBanUsersFromGuildRequest
• BulkBanUsersResponse
• BulkDeleteMessagesRequest
• BulkLobbyMemberRequest
• BulkUpdateGuildChannelsRequestInner
• BulkUpdateGuildRolesRequestInner
• ButtonComponentForMessageRequest
• ButtonComponentResponse
• ChannelFollowerResponse
• ChannelFollowerWebhookResponse
• ChannelPermissionOverwriteRequest
• ChannelPermissionOverwriteResponse
• ChannelSelectComponentForMessageRequest
• ChannelSelectComponentResponse
• ChannelSelectDefaultValue
• ChannelSelectDefaultValueResponse
• CommandPermissionResponse
• CommandPermissionsResponse
• ComponentEmojiForMessageRequest
• ComponentEmojiResponse
• ConnectedAccountGuildResponse
• ConnectedAccountIntegrationResponse
• ConnectedAccountResponse
• ContainerComponentForMessageRequest
• ContainerComponentForMessageRequestComponentsInner
• ContainerComponentResponse
• ContainerComponentResponseComponentsInner
• CreateApplicationEmojiRequest
• CreateAutoModerationRule200Response
• CreateAutoModerationRuleRequest
• CreateChannelInviteRequest
• CreateEntitlementRequestData
• CreateForumThreadRequest
• CreateGroupDMInviteRequest
• CreateGuildChannelRequest
• CreateGuildEmojiRequest
• CreateGuildFromTemplateRequest
• CreateGuildInviteRequest
• CreateGuildRequestChannelItem
• CreateGuildRequestRoleItem
• CreateGuildRoleRequest
• CreateGuildScheduledEventRequest
• CreateGuildTemplateRequest
• CreateInteractionResponseRequest
• CreateLobbyRequest
• CreateMessageInteractionCallbackRequest
• CreateMessageInteractionCallbackResponse
• CreateOrJoinLobbyRequest
• CreateOrUpdateThreadTagRequest
• CreatePrivateChannelRequest
• CreateStageInstanceRequest
• CreateTextThreadWithMessageRequest
• CreateTextThreadWithoutMessageRequest
• CreateThreadRequest
• CreateWebhookRequest
• CreatedThreadResponse
• DefaultKeywordListTriggerMetadata
• DefaultKeywordListTriggerMetadataResponse
• DefaultKeywordListUpsertRequest
• DefaultKeywordListUpsertRequestActionsInner
• DefaultKeywordListUpsertRequestPartial
• DefaultKeywordRuleResponse
• DefaultKeywordRuleResponseActionsInner
• DefaultReactionEmojiResponse
• DiscordIntegrationResponse
• EditLobbyChannelLinkRequest
• EmbeddedActivityInstance
• EmbeddedActivityInstanceLocation
• EmojiResponse
• EntitlementResponse
• EntityMetadataExternal
• EntityMetadataExternalResponse
• Error
• ErrorDetails
• ErrorResponse
• ExecuteWebhookRequest
• ExternalConnectionIntegrationResponse
• ExternalScheduledEventCreateRequest
• ExternalScheduledEventPatchRequestPartial
• ExternalScheduledEventResponse
• FileComponentForMessageRequest
• FileComponentResponse
• FlagToChannelAction
• FlagToChannelActionMetadata
• FlagToChannelActionMetadataResponse
• FlagToChannelActionResponse
• FollowChannelRequest
• ForumTagResponse
• FriendInviteResponse
• GatewayBotResponse
• GatewayBotSessionStartLimitResponse
• GatewayResponse
• GetChannel200Response
• GetEntitlementsSkuIdsParameter
• GetSticker200Response
• GithubAuthor
• GithubCheckApp
• GithubCheckPullRequest
• GithubCheckRun
• GithubCheckRunOutput
• GithubCheckSuite
• GithubComment
• GithubCommit
• GithubDiscussion
• GithubIssue
• GithubRelease
• GithubRepository
• GithubReview
• GithubUser
• GithubWebhook
• GroupDMInviteResponse
• GuildAuditLogResponse
• GuildAuditLogResponseIntegrationsInner
• GuildBanResponse
• GuildChannelLocation
• GuildChannelResponse
• GuildCreateRequest
• GuildHomeSettingsResponse
• GuildIncomingWebhookResponse
• GuildInviteResponse
• GuildMFALevelResponse
• GuildMemberResponse
• GuildOnboardingResponse
• GuildPatchRequestPartial
• GuildPreviewResponse
• GuildProductPurchaseResponse
• GuildPruneResponse
• GuildResponse
• GuildRoleColorsResponse
• GuildRoleResponse
• GuildRoleTagsResponse
• GuildStickerResponse
• GuildSubscriptionIntegrationResponse
• GuildTemplateChannelResponse
• GuildTemplateChannelTags
• GuildTemplateResponse
• GuildTemplateRoleResponse
• GuildTemplateSnapshotResponse
• GuildWelcomeChannel
• GuildWelcomeScreenChannelResponse
• GuildWelcomeScreenResponse
• GuildWithCountsResponse
• IncomingWebhookInteractionRequest
• IncomingWebhookRequestPartial
• IncomingWebhookUpdateForInteractionCallbackRequestPartial
• IncomingWebhookUpdateRequestPartial
• InnerErrors
• IntegrationApplicationResponse
• InteractionApplicationCommandAutocompleteCallbackIntegerData
• InteractionApplicationCommandAutocompleteCallbackNumberData
• InteractionApplicationCommandAutocompleteCallbackStringData
• InteractionCallbackResponse
• InteractionCallbackResponseResource
• InteractionResponse
• InviteApplicationResponse
• InviteChannelRecipientResponse
• InviteChannelResponse
• InviteGuildResponse
• KeywordRuleResponse
• KeywordTriggerMetadata
• KeywordTriggerMetadataResponse
• KeywordUpsertRequest
• KeywordUpsertRequestPartial
• LaunchActivityInteractionCallbackRequest
• LaunchActivityInteractionCallbackResponse
• ListApplicationEmojisResponse
• ListAutoModerationRules200ResponseInner
• ListChannelInvites200ResponseInner
• ListChannelWebhooks200ResponseInner
• ListGuildIntegrations200ResponseInner
• ListGuildScheduledEvents200ResponseInner
• ListGuildSoundboardSoundsResponse
• LobbyMemberRequest
• LobbyMemberResponse
• LobbyMessageResponse
• LobbyResponse
• MLSpamRuleResponse
• MLSpamUpsertRequest
• MLSpamUpsertRequestPartial
• MediaGalleryComponentForMessageRequest
• MediaGalleryComponentResponse
• MediaGalleryItemRequest
• MediaGalleryItemResponse
• MentionSpamRuleResponse
• MentionSpamTriggerMetadata
• MentionSpamTriggerMetadataResponse
• MentionSpamUpsertRequest
• MentionSpamUpsertRequestPartial
• MentionableSelectComponentForMessageRequest
• MentionableSelectComponentForMessageRequestDefaultValuesInner
• MentionableSelectComponentResponse
• MentionableSelectComponentResponseDefaultValuesInner
• MessageAllowedMentionsRequest
• MessageAttachmentRequest
• MessageAttachmentResponse
• MessageCallResponse
• MessageComponentInteractionMetadataResponse
• MessageCreateRequest
• MessageEditRequestPartial
• MessageEmbedAuthorResponse
• MessageEmbedFieldResponse
• MessageEmbedFooterResponse
• MessageEmbedImageResponse
• MessageEmbedProviderResponse
• MessageEmbedResponse
• MessageEmbedVideoResponse
• MessageInteractionResponse
• MessageMentionChannelResponse
• MessageReactionCountDetailsResponse
• MessageReactionEmojiResponse
• MessageReactionResponse
• MessageReferenceRequest
• MessageReferenceResponse
• MessageResponse
• MessageRoleSubscriptionDataResponse
• MessageSnapshotResponse
• MessageStickerItemResponse
• MinimalContentMessageResponse
• ModalInteractionCallbackRequest
• ModalInteractionCallbackRequestData
• ModalSubmitInteractionMetadataResponse
• ModalSubmitInteractionMetadataResponseTriggeringInteractionMetadata
• MyGuildResponse
• NewMemberActionResponse
• OAuth2GetAuthorizationResponse
• OAuth2GetKeys
• OAuth2GetOpenIDConnectUserInfoResponse
• OAuth2Key
• OnboardingPromptOptionRequest
• OnboardingPromptOptionResponse
• OnboardingPromptResponse
• PartialDiscordIntegrationResponse
• PartialExternalConnectionIntegrationResponse
• PartialGuildSubscriptionIntegrationResponse
• PartnerSdkUnmergeProvisionalAccountRequest
• PinnedMessageResponse
• PinnedMessagesResponse
• PollAnswerCreateRequest
• PollAnswerDetailsResponse
• PollAnswerResponse
• PollCreateRequest
• PollEmoji
• PollEmojiCreateRequest
• PollMedia
• PollMediaCreateRequest
• PollMediaResponse
• PollResponse
• PollResultsEntryResponse
• PollResultsResponse
• PongInteractionCallbackRequest
• PrivateApplicationResponse
• PrivateChannelLocation
• PrivateChannelResponse
• PrivateGroupChannelResponse
• PrivateGuildMemberResponse
• ProvisionalTokenResponse
• PruneGuildRequest
• PruneGuildRequestIncludeRoles
• PurchaseNotificationResponse
• QuarantineUserAction
• QuarantineUserActionResponse
• ResolvedObjectsResponse
• ResourceChannelResponse
• RichEmbed
• RichEmbedAuthor
• RichEmbedField
• RichEmbedFooter
• RichEmbedImage
• RichEmbedProvider
• RichEmbedThumbnail
• RichEmbedVideo
• RoleSelectComponentForMessageRequest
• RoleSelectComponentResponse
• RoleSelectDefaultValue
• RoleSelectDefaultValueResponse
• SDKMessageRequest
• ScheduledEventResponse
• ScheduledEventUserResponse
• SectionComponentForMessageRequest
• SectionComponentForMessageRequestAccessory
• SectionComponentResponse
• SectionComponentResponseAccessory
• SeparatorComponentForMessageRequest
• SeparatorComponentResponse
• SetChannelPermissionOverwriteRequest
• SetGuildApplicationCommandPermissionsRequest
• SetGuildMfaLevelRequest
• SettingsEmojiResponse
• SlackWebhook
• SoundboardCreateRequest
• SoundboardPatchRequestPartial
• SoundboardSoundResponse
• SoundboardSoundSendRequest
• SpamLinkRuleResponse
• StageInstanceResponse
• StageScheduledEventCreateRequest
• StageScheduledEventPatchRequestPartial
• StageScheduledEventResponse
• StandardStickerResponse
• StickerPackCollectionResponse
• StickerPackResponse
• StringSelectComponentForMessageRequest
• StringSelectComponentResponse
• StringSelectOptionForMessageRequest
• StringSelectOptionResponse
• TeamMemberResponse
• TeamResponse
• TextDisplayComponentForMessageRequest
• TextDisplayComponentResponse
• TextInputComponentForModalRequest
• TextInputComponentResponse
• ThreadMemberResponse
• ThreadMetadataResponse
• ThreadResponse
• ThreadSearchResponse
• ThreadSearchTagParameter
• ThreadsResponse
• ThumbnailComponentForMessageRequest
• ThumbnailComponentResponse
• UnfurledMediaRequest
• UnfurledMediaRequestWithAttachmentReferenceRequired
• UnfurledMediaResponse
• UpdateApplicationEmojiRequest
• UpdateApplicationUserRoleConnectionRequest
• UpdateAutoModerationRuleRequest
• UpdateChannelRequest
• UpdateDMRequestPartial
• UpdateDefaultReactionEmojiRequest
• UpdateGroupDMRequestPartial
• UpdateGuildChannelRequestPartial
• UpdateGuildEmojiRequest
• UpdateGuildMemberRequest
• UpdateGuildOnboardingRequest
• UpdateGuildScheduledEventRequest
• UpdateGuildStickerRequest
• UpdateGuildTemplateRequest
• UpdateGuildWidgetSettingsRequest
• UpdateMessageInteractionCallbackRequest
• UpdateMessageInteractionCallbackResponse
• UpdateMyGuildMemberRequest
• UpdateOnboardingPromptRequest
• UpdateSelfVoiceStateRequest
• UpdateStageInstanceRequest
• UpdateThreadRequestPartial
• UpdateThreadTagRequest
• UpdateVoiceStateRequest
• UpdateWebhookByTokenRequest
• UpdateWebhookRequest
• UserAvatarDecorationResponse
• UserCollectiblesResponse
• UserCommunicationDisabledAction
• UserCommunicationDisabledActionMetadata
• UserCommunicationDisabledActionMetadataResponse
• UserCommunicationDisabledActionResponse
• UserGuildOnboardingResponse
• UserNameplateResponse
• UserPIIResponse
• UserPrimaryGuildResponse
• UserResponse
• UserSelectComponentForMessageRequest
• UserSelectComponentResponse
• UserSelectDefaultValue
• UserSelectDefaultValueResponse
• VanityURLErrorResponse
• VanityURLResponse
• VoiceRegionResponse
• VoiceScheduledEventCreateRequest
• VoiceScheduledEventPatchRequestPartial
• VoiceScheduledEventResponse
• VoiceStateResponse
• WebhookSlackEmbed
• WebhookSlackEmbedField
• WebhookSourceChannelResponse
• WebhookSourceGuildResponse
• WelcomeMessageResponse
• WelcomeScreenPatchRequestPartial
• WidgetActivity
• WidgetChannel
• WidgetMember
• WidgetResponse
• WidgetSettingsResponse

Documentation For Authorization

Authentication schemes defined for the API:

BotToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: implicit
• Authorization URL: https://discord.com/api/oauth2/authorize
• Scopes:
• activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
• activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
• activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
• applications.builds.read: allows your app to read build data for a user's applications
• applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
• applications.commands: allows your app to use commands in a guild
• applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
• applications.entitlements: allows your app to read entitlements for a user's applications
• applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
• bot: for oauth2 bots, this puts the bot in the user's selected guild by default
• connections: allows /users/@me/connections to return linked third-party accounts
• dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
• email: enables /users/@me to return an email
• gdm.join: allows your app to join users to a group dm
• guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
• guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
• guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
• identify: allows /users/@me without email
• messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
• openid: for OpenID Connect, this allows your app to receive user id and basic profile information
• relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
• rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
• rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
• rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
• rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
• rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
• rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
• rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
• rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
• rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
• voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
• webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants

OAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
• activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
• activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
• applications.builds.read: allows your app to read build data for a user's applications
• applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
• applications.commands: allows your app to use commands in a guild
• applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
• applications.commands.update: allows your app to update its commands using a Bearer token - client credentials grant only
• applications.entitlements: allows your app to read entitlements for a user's applications
• applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
• bot: for oauth2 bots, this puts the bot in the user's selected guild by default
• connections: allows /users/@me/connections to return linked third-party accounts
• dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
• email: enables /users/@me to return an email
• gdm.join: allows your app to join users to a group dm
• guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
• guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
• guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
• identify: allows /users/@me without email
• messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
• openid: for OpenID Connect, this allows your app to receive user id and basic profile information
• relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
• rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
• rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
• rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
• rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
• rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
• rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
• rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
• rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
• rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
• voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
• webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://discord.com/api/oauth2/authorize
• Scopes:
• activities.invites.write: allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
• activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
• activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
• applications.builds.read: allows your app to read build data for a user's applications
• applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
• applications.commands: allows your app to use commands in a guild
• applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
• applications.entitlements: allows your app to read entitlements for a user's applications
• applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
• bot: for oauth2 bots, this puts the bot in the user's selected guild by default
• connections: allows /users/@me/connections to return linked third-party accounts
• dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
• email: enables /users/@me to return an email
• gdm.join: allows your app to join users to a group dm
• guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
• guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
• guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
• identify: allows /users/@me without email
• messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
• openid: for OpenID Connect, this allows your app to receive user id and basic profile information
• relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
• role_connections.write: allows your app to update a user's connection and metadata for the app
• rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
• rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
• rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
• rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
• rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
• rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
• rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
• rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
• rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
• voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
• webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants

Author