You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Intro.mdx
+71-47Lines changed: 71 additions & 47 deletions
Original file line number
Diff line number
Diff line change
@@ -3,50 +3,74 @@ showTOC: false
3
3
sidebar_label: Intro
4
4
---
5
5
6
-
7
-
8
-
# Welcome to the Discord Developer Platform
9
-
10
-
The Discord developer platform lets you develop apps to customize and extend Discord for millions of users. A toolkit of [APIs](#DOCS_REFERENCE) and [resources](#DOCS_DEVELOPER_TOOLS_COMMUNITY_RESOURCES) pair splendidly with a supportive community to help you build bots, integrate 3rd party services, and add Discord support to your game.
Add interactivity to your app with [commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS) and [message components](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS) to build engaging experiences in the place where users are already hanging out.
21
-
22
-
#### Customize Servers
23
-
24
-
Customize Discord servers by using apps to do things like [send messages](#DOCS_RESOURCES_MESSAGE/create-message), modify [channels](#DOCS_RESOURCES_CHANNEL) and [guilds](#DOCS_RESOURCES_GUILD), [integrate with AutoMod](#DOCS_RESOURCES_AUTO_MODERATION), or [connect to voice](#DOCS_TOPICS_VOICE_CONNECTIONS).
25
-
26
-
Plus, use the [Gateway API](#DOCS_TOPICS_GATEWAY) to respond to [real-time events](#DOCS_TOPICS_GATEWAY_EVENTS/receive-events) happening in a server, like when a reaction is added to a message.
27
-
28
-
#### Connect Metadata
29
-
30
-
Link and update metadata to enhance Discord for users. Add [Rich Presence](#DOCS_RICH_PRESENCE_OVERVIEW) to display live data on users' profiles, or [connection metadata](#DOCS_RESOURCES_APPLICATION_ROLE_CONNECTION_METADATA) to make it easy for admins to create roles using metadata associated with your app.
31
-
32
-
#### Build Interactive Activities and Games
33
-
34
-
Currently in Developer Preview, the [Embedded App SDK](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK) allows you to build [Activities](#DOCS_ACTIVITIES_OVERVIEW), such as multiplayer games or social experiences, that run inside Discord.
35
-
36
-
## Discover Developer Resources
37
-
38
-
#### Find Tools and Libraries
39
-
40
-
The Discord developer community has built and maintained a ton of different [libraries and tools](#DOCS_DEVELOPER_TOOLS_COMMUNITY_RESOURCES/libraries) over the years. No matter your experience level or language of choice, there are resources to speed up and simplify app development for you over on the [Community Resources](#DOCS_DEVELOPER_TOOLS_COMMUNITY_RESOURCES) page.
41
-
42
-
You can also check out our [Postman collections](https://www.postman.com/discord-api) to try and test API endpoints.
43
-
44
-
#### Connect with Support
45
-
46
-
- Join the [Discord Developers server](https://discord.gg/discord-developers) for support, discussion, and events about the Discord developer platform.
47
-
- Explore the [Developer Help Center](https://support-dev.discord.com/hc) to find articles about common topics and questions, or to reach directly out to our developer support team.
48
-
- Use our [GitHub](https://github.com/discord/discord-api-docs) to report API bugs, start a discussion about a developer feature request, or suggest an edit to our open source developer documentation.
49
-
50
-
So go ahead and [build an app](https://discord.com/developers/applications)! We can’t wait to see what you make.
51
-
52
-
— Discord
6
+
<Herotitle="Build Where the World Plays"subheading="Build social games, experiences, and integrations for millions of users on Discord" />
7
+
8
+
## Get Started
9
+
10
+
Learn more about what apps can do on Discord or jump right into building your own.
11
+
12
+
<Container>
13
+
<Cardtitle="Overview of Apps"link="#DOCS_QUICK_START_OVERVIEW_OF_APPS"icon="AppsIcon">
14
+
Learn more about the different types of apps you can build on Discord and how users can interact with them
15
+
</Card>
16
+
<Cardtitle="Build your First Discord App"link="#DOCS_QUICK_START_GETTING_STARTED"icon="RobotIcon">
17
+
Follow the guide to build a Discord app with interactive features like commands and message components.
18
+
</Card>
19
+
<Cardtitle="Build a Discord Activity"link="#DOCS_ACTIVITIES_BUILDING_AN_ACTIVITY"icon="GameControllerIcon">
20
+
Follow the guide to build an Activity in Discord using the Embedded App SDK.
21
+
</Card>
22
+
</Container>
23
+
24
+
## Discover Platform Features
25
+
26
+
Learn about different features and explore their reference documentation to bring your idea to life.
Copy file name to clipboardExpand all lines: docs/Reference.mdx
+8-4Lines changed: 8 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -126,7 +126,7 @@ All HTTP-layer services and protocols (e.g. HTTP, WebSocket) within the Discord
126
126
127
127
## Snowflakes
128
128
129
-
Discord utilizes Twitter's [snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) format for uniquely identifiable descriptors (IDs). These IDs are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parent's ID. Because Snowflake IDs are up to 64 bits in size (e.g. a uint64), they are always returned as strings in the HTTP API to prevent integer overflows in some languages. See [Gateway ETF/JSON](#DOCS_TOPICS_GATEWAY/encoding-and-compression) for more information regarding Gateway encoding.
129
+
Discord utilizes Twitter's [snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) format for uniquely identifiable descriptors (IDs). These IDs are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parent's ID. Because Snowflake IDs are up to 64 bits in size (e.g. a uint64), they are always returned as strings in the HTTP API to prevent integer overflows in some languages. See [Gateway ETF/JSON](#DOCS_EVENTS_GATEWAY/encoding-and-compression) for more information regarding Gateway encoding.
130
130
131
131
###### Snowflake ID Broken Down in Binary
132
132
@@ -235,6 +235,10 @@ Clients may append more information and metadata to the _end_ of this string as
235
235
> warn
236
236
> Client requests that do not have a valid User Agent specified may be blocked and return a [Cloudflare error](https://support.cloudflare.com/hc/en-us/articles/360029779472-Troubleshooting-Cloudflare-1XXX-errors).
237
237
238
+
### Content Type
239
+
240
+
Clients using the HTTP API must provide a valid `Content-Type` header, either `application/json`, `application/x-www-form-urlencoded`, or `multipart/form-data`, except where specified. Failing to do so will result in a `50035` "Invalid form body" error.
241
+
238
242
### Rate Limiting
239
243
240
244
The HTTP API implements a process for limiting and preventing excessive requests in accordance with [RFC 6585](https://tools.ietf.org/html/rfc6585#section-4). API users that regularly hit and ignore rate limits will have their API keys revoked, and be blocked from the platform. For more information on rate limiting of requests, please see the [Rate Limits](#DOCS_TOPICS_RATE_LIMITS/rate-limits) section.
@@ -245,7 +249,7 @@ Certain endpoints in the API are documented to accept booleans for their query s
245
249
246
250
## Gateway (WebSocket) API
247
251
248
-
Discord's Gateway API is used for maintaining persistent, stateful websocket connections between your client and our servers. These connections are used for sending and receiving real-time events your client can use to track and update local state. The Gateway API uses secure websocket connections as specified in [RFC 6455](https://tools.ietf.org/html/rfc6455). For information on opening Gateway connections, please see the [Gateway API](#DOCS_TOPICS_GATEWAY/connections) section.
252
+
Discord's Gateway API is used for maintaining persistent, stateful websocket connections between your client and our servers. These connections are used for sending and receiving real-time events your client can use to track and update local state. The Gateway API uses secure websocket connections as specified in [RFC 6455](https://tools.ietf.org/html/rfc6455). For information on opening Gateway connections, please see the [Gateway API](#DOCS_EVENTS_GATEWAY/connections) section.
249
253
250
254
## Message Formatting
251
255
@@ -337,7 +341,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
> A file upload size limit applies to *all* files in a request (rather than each individual file). While the limit depends on the [**Boost Tier**](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-FAQ-#h_419c3bd5-addd-4989-b7cf-c7957ef92583) of a guild, it is `25 MiB` by default.
400
+
> A file upload size limit applies to *all* files in a request (rather than each individual file). While the limit depends on the [**Boost Tier**](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-FAQ-#h_419c3bd5-addd-4989-b7cf-c7957ef92583) of a guild, it is `10 MiB` by default.
397
401
398
402
Some endpoints support file attachments, indicated by the `files[n]` parameter. To add file(s), the standard `application/json` body must be replaced by a `multipart/form-data` body. The JSON message body can optionally be provided using the `payload_json` parameter.
0 commit comments