Preview environment

interface CDNRoutesDeclarations

external
export interface CDNRoutesDeclarations

external
achievementIcon<

Format extends AchievementIconFormat

>(
applicationId: Snowflake
achievementId: Snowflake
achievementIconHash: string
format: Format
) : `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`

Route for: - GET /app-assets/{application.id}/achievements/{achievement.id}/icons/{achievement.icon}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
applicationAsset<

Format extends ApplicationAssetFormat

>(
applicationId: Snowflake
applicationAssetId: string
format: Format
) : `/app-assets/${string}/${string}.${Format}`

Route for: - GET /app-assets/{application.id}/{application.asset_id}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
applicationCover<

Format extends ApplicationCoverFormat

>(
applicationId: Snowflake
applicationCoverImage: string
format: Format
) : `/app-icons/${string}/${string}.${Format}`

Route for: - GET /app-icons/{application.id}/{application.cover_image}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
applicationIcon<

Format extends ApplicationIconFormat

>(
applicationId: Snowflake
applicationIcon: string
format: Format
) : `/app-icons/${string}/${string}.${Format}`

Route for: - GET /app-icons/{application.id}/{application.icon}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
avatarDecoration(
avatarDecorationDataAsset: string
) : `/avatar-decoration-presets/${string}.png`

Route for: - GET /avatar-decoration-presets/{avatar_decoration_data_asset}.pngThis route supports the extension: PNG

external
defaultUserAvatar<

Index extends DefaultUserAvatarAssets

>(
index: Index
) : `/embed/avatars/${Index}.png`

Route for: - GET /embed/avatars/{index}.pngThe value for index parameter depends on whether the user is migrated to the new username system. For users on the new username system, index will be (user.id >> 22) % 6. For users on the legacy username system, index will be user.discriminator % 5.This route supports the extension: PNG

external
emoji<

Format extends EmojiFormat

>(
emojiId: Snowflake
format: Format
) : `/emojis/${string}.${Format}`

Route for: - GET /emojis/{emoji.id}.{png|jpeg|webp|gif}As this route supports GIFs, the hash will begin with a_ if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF

external
guildBanner<

Format extends GuildBannerFormat

>(
guildId: Snowflake
guildBanner: string
format: Format
) : `/banners/${string}/${string}.${Format}`

Route for: - GET /banners/{guild.id}/{guild.banner}.{png|jpeg|webp|gif}As this route supports GIFs, the hash will begin with a_ if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF

external
guildDiscoverySplash<

Format extends GuildDiscoverySplashFormat

>(
guildId: Snowflake
guildDiscoverySplash: string
format: Format
) : `/discovery-splashes/${string}/${string}.${Format}`

Route for: - GET /discovery-splashes/{guild.id}/{guild.discovery_splash}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
guildIcon<

Format extends GuildIconFormat

>(
guildId: Snowflake
guildIcon: string
format: Format
) : `/icons/${string}/${string}.${Format}`

Route for: - GET /icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}As this route supports GIFs, the hash will begin with a_ if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF

external
guildMemberAvatar<

Format extends GuildMemberAvatarFormat

>(
guildId: Snowflake
userId: Snowflake
memberAvatar: string
format: Format
) : `/guilds/${string}/users/${string}/avatars/${string}.${Format}`

Route for: - GET /guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}As this route supports GIFs, the hash will begin with a_ if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF

external
guildMemberBanner<

Format extends GuildMemberBannerFormat

>(
guildId: Snowflake
userId: Snowflake
guildMemberBanner: string
format: Format
) : `/guilds/${string}/users/${string}/banners/${string}.${Format}`

Route for: - GET /guilds/${guild.id}/users/${user.id}/banners/${guild_member.banner}.{png|jpeg|webp|gif}This route supports the extensions: PNG, JPEG, WebP, GIF

external
guildScheduledEventCover<

Format extends GuildScheduledEventCoverFormat

>(
guildScheduledEventId: Snowflake
guildScheduledEventCoverImage: string
format: Format
) : `/guild-events/${string}/${string}.${Format}`

Route for: - GET /guild-events/{guild_scheduled_event.id}/{guild_scheduled_event.image}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
guildSplash<

Format extends GuildSplashFormat

>(
guildId: Snowflake
guildSplash: string
format: Format
) : `/splashes/${string}/${string}.${Format}`

Route for: - GET /splashes/{guild.id}/{guild.splash}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
guildTagBadge<

Format extends GuildTagBadgeFormat

>(
guildId: Snowflake
guildTagBadge: string
format: Format
) : `/guild-tag-badges/${string}/${string}.${Format}`

Route for: - GET /guild-tag-badges/{guild.id}/{badge}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
roleIcon<

Format extends RoleIconFormat

>(
roleId: Snowflake
roleIcon: string
format: Format
) : `/role-icons/${string}/${string}.${Format}`

Route for: - GET /role-icons/{role.id}/{role.icon}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
soundboardSound(
soundId: Snowflake
) : `/soundboard-sounds/${string}`

Route for: - GET /soundboard-sounds/${sound.id}

external
sticker<

Format extends StickerFormat

>(
stickerId: Snowflake
format: Format
) : `/stickers/${string}.${Format}`

Route for: - GET /stickers/{sticker.id}.{png|json}This route supports the extensions: PNG, Lottie, GIF

external
stickerPackBanner<

Format extends StickerPackBannerFormat

>(
stickerPackBannerAssetId: Snowflake
format: Format
) : `/app-assets/710982414301790216/store/${string}.${Format}`

Route for: - GET /app-assets/710982414301790216/store/{sticker_pack.banner.asset_id}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
storePageAsset<

Format? extends StorePageAssetFormat = ImageFormat.PNG

>(
applicationId: Snowflake
assetId: string
format?: Format
) : `/app-assets/${string}/store/${string}.${Format}`

Route for: - GET /app-assets/${application.id}/store/${asset.id}.{png|jpeg|webp}}This route supports the extensions: PNG, JPEG, WebP

external
teamIcon<

Format extends TeamIconFormat

>(
teamId: Snowflake
teamIcon: string
format: Format
) : `/team-icons/${string}/${string}.${Format}`

Route for: - GET /team-icons/{team.id}/{team.icon}.{png|jpeg|webp}This route supports the extensions: PNG, JPEG, WebP

external
userAvatar<

Format extends UserAvatarFormat

>(
userId: Snowflake
userAvatar: string
format: Format
) : `/avatars/${string}/${string}.${Format}`

Route for: - GET /avatars/{user.id}/{user.avatar}.{png|jpeg|webp|gif}As this route supports GIFs, the hash will begin with a_ if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF

deprecatedexternal
userAvatarDecoration(
userId: Snowflake
userAvatarDecoration: string
) : `/avatar-decorations/${string}/${string}.png`

Route for: - GET /avatar-decorations/{user.id}/{user.avatar_decoration}.pngThis route supports the extension: PNG

external
userBanner<

Format extends UserBannerFormat

>(
userId: Snowflake
userBanner: string
format: Format
) : `/banners/${string}/${string}.${Format}`

Route for: - GET /banners/{user.id}/{user.banner}.{png|jpeg|webp|gif}As this route supports GIFs, the hash will begin with a_ if it is available in GIF formatThis route supports the extensions: PNG, JPEG, WebP, GIF