Discord Soundboard Default Sounds API

openapi: 3.2.0
info:
  title: Discord HTTP API (Preview) Soundboard Default Sounds API
  description: Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.
  termsOfService: https://discord.com/developers/docs/policies-and-agreements/developer-terms-of-service
  license:
    name: MIT
    identifier: MIT
  version: '10'
servers:
- url: https://discord.com/api/v10
tags:
- name: Soundboard Default Sounds
paths:
  /soundboard-default-sounds:
    get:
      operationId: get_soundboard_default_sounds
      responses:
        '200':
          description: 200 response for get_soundboard_default_sounds
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Reset-After:
              $ref: '#/components/headers/X-RateLimit-Reset-After'
            X-RateLimit-Bucket:
              $ref: '#/components/headers/X-RateLimit-Bucket'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SoundboardSoundResponse'
        '429':
          $ref: '#/components/responses/ClientRatelimitedResponse'
        4XX:
          $ref: '#/components/responses/ClientErrorResponse'
      security:
      - BotToken: []
      tags:
      - Soundboard Default Sounds
      summary: Get soundboard default sounds
      x-summary-source: derived
components:
  headers:
    X-RateLimit-Limit:
      schema:
        type: integer
      description: The maximum number of requests that can be made in the current ratelimit window
    X-RateLimit-Bucket:
      schema:
        type: string
      description: The bucket that the request belongs to
    X-RateLimit-Reset:
      schema:
        type: number
      description: A unix timestamp in seconds at which the current ratelimit window resets
    X-RateLimit-Reset-After:
      schema:
        type: number
      description: The duration in seconds until the current ratelimit window resets
    X-RateLimit-Remaining:
      schema:
        type: integer
      description: The number of requests remaining in the current ratelimit window
  responses:
    ClientErrorResponse:
      description: Client error response
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-RateLimit-Reset-After:
          $ref: '#/components/headers/X-RateLimit-Reset-After'
        X-RateLimit-Bucket:
          $ref: '#/components/headers/X-RateLimit-Bucket'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ClientRatelimitedResponse:
      description: Client ratelimited response
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-RateLimit-Reset-After:
          $ref: '#/components/headers/X-RateLimit-Reset-After'
        X-RateLimit-Bucket:
          $ref: '#/components/headers/X-RateLimit-Bucket'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RatelimitedResponse'
  schemas:
    Error:
      type: object
      description: A single error, either for an API response or a specific field.
      properties:
        code:
          type: integer
          description: Discord internal error code. See error code reference
        message:
          type: string
          description: Human-readable error message
      required:
      - code
      - message
    UserPrimaryGuildResponse:
      type: object
      properties:
        identity_guild_id:
          description: the id of the user's primary guild
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/SnowflakeType'
        identity_enabled:
          type:
          - boolean
          - 'null'
          description: whether the user is displaying the primary guild's server tag
        tag:
          type:
          - string
          - 'null'
          description: the text of the user's server tag, limited to 4 characters
        badge:
          type:
          - string
          - 'null'
          description: the server tag badge hash
      required:
      - identity_guild_id
      - identity_enabled
      - tag
      - badge
    UserAvatarDecorationResponse:
      type: object
      properties:
        asset:
          type: string
          description: the avatar decoration hash
        sku_id:
          description: id of the avatar decoration's SKU
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/SnowflakeType'
      required:
      - asset
      - sku_id
    UserResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/SnowflakeType'
          description: the user's id
        username:
          type: string
          description: the user's username, not unique across the platform
        avatar:
          type:
          - string
          - 'null'
          description: the user's avatar hash
        discriminator:
          type: string
          description: the user's Discord-tag
        public_flags:
          type: integer
          description: the public flags on a user's account
          format: int32
        flags:
          $ref: '#/components/schemas/Int53Type'
          description: the flags on a user's account
        bot:
          type: boolean
          description: whether the user belongs to an OAuth2 application
        system:
          type: boolean
          description: whether the user is an Official Discord System user (part of the urgent message system)
        banner:
          type:
          - string
          - 'null'
          description: the user's banner hash
        accent_color:
          type:
          - integer
          - 'null'
          description: the user's banner color encoded as an integer representation of hexadecimal color code
          format: int32
        global_name:
          type:
          - string
          - 'null'
          description: the user's display name, if it is set
        avatar_decoration_data:
          description: data for the user's avatar decoration
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/UserAvatarDecorationResponse'
        collectibles:
          description: data for the user's collectibles
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/UserCollectiblesResponse'
        primary_guild:
          description: the user's primary guild
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/UserPrimaryGuildResponse'
      required:
      - id
      - username
      - avatar
      - discriminator
      - public_flags
      - flags
      - global_name
      - primary_guild
    UserCollectiblesResponse:
      type: object
      properties:
        nameplate:
          description: Object mapping of nameplate data
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/UserNameplateResponse'
      required:
      - nameplate
    InnerErrors:
      type: object
      properties:
        _errors:
          type: array
          description: The list of errors for this field
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
      required:
      - _errors
    UserNameplateResponse:
      type: object
      properties:
        sku_id:
          description: ID of the nameplate SKU
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/SnowflakeType'
        asset:
          type: string
          description: Path to the nameplate asset
        label:
          type: string
          description: The label of this nameplate. Currently unused
        palette:
          $ref: '#/components/schemas/NameplatePalette'
          description: Background color of the nameplate
      required:
      - sku_id
      - asset
      - label
      - palette
    ErrorResponse:
      type: object
      description: Errors object returned by the Discord API
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          errors:
            $ref: '#/components/schemas/ErrorDetails'
    SnowflakeType:
      type: string
      pattern: ^(0|[1-9][0-9]*)$
      format: snowflake
    Int53Type:
      type: integer
      minimum: -9007199254740991
      maximum: 9007199254740991
      format: int64
    NameplatePalette:
      type: string
      oneOf:
      - title: CRIMSON
        description: Crimson color palette
        const: crimson
      - title: BERRY
        description: Berry color palette
        const: berry
      - title: SKY
        description: Sky color palette
        const: sky
      - title: TEAL
        description: Teal color palette
        const: teal
      - title: FOREST
        description: Forest color palette
        const: forest
      - title: BUBBLE_GUM
        description: Bubble gum color palette
        const: bubble_gum
      - title: VIOLET
        description: Violet color palette
        const: violet
      - title: COBALT
        description: Cobalt color palette
        const: cobalt
      - title: CLOVER
        description: Clover color palette
        const: clover
      - title: LEMON
        description: Lemon color palette
        const: lemon
      - title: WHITE
        description: White color palette
        const: white
      - title: BLACK
        description: Black color palette
        const: black
    ErrorDetails:
      oneOf:
      - type: object
        additionalProperties:
          $ref: '#/components/schemas/ErrorDetails'
      - $ref: '#/components/schemas/InnerErrors'
    RatelimitedResponse:
      type: object
      description: Ratelimit error object returned by the Discord API
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          retry_after:
            type: number
            description: The number of seconds to wait before retrying your request
          global:
            type: boolean
            description: Whether you are being ratelimited by the global ratelimit or a per-endpoint ratelimit
        required:
        - retry_after
        - global
    SoundboardSoundResponse:
      type: object
      properties:
        name:
          type: string
        sound_id:
          $ref: '#/components/schemas/SnowflakeType'
        volume:
          type: number
          format: double
        emoji_id:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/SnowflakeType'
        emoji_name:
          type:
          - string
          - 'null'
        guild_id:
          $ref: '#/components/schemas/SnowflakeType'
        available:
          type: boolean
        user:
          $ref: '#/components/schemas/UserResponse'
      required:
      - name
      - sound_id
      - volume
      - emoji_id
      - emoji_name
      - available
  securitySchemes:
    BotToken:
      type: apiKey
      description: Discord bot token
      name: Authorization
      in: header
    OAuth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://discord.com/api/oauth2/authorize
          refreshUrl: https://discord.com/api/oauth2/token
          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
        clientCredentials:
          tokenUrl: https://discord.com/api/oauth2/token
          refreshUrl: https://discord.com/api/oauth2/token
          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
        authorizationCode:
          authorizationUrl: https://discord.com/api/oauth2/authorize
          tokenUrl: https://discord.com/api/oauth2/token
          refreshUrl: https://discord.com/api/oauth2/token
          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
externalDocs:
  url: https://discord.com/developers/docs
  description: Discord Developer Documentation
x-provenance:
  method: harvested
  publisher: Discord
  source: https://raw.githubusercontent.com/discord/discord-api-spec/HEAD/specs/openapi_preview.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)