guild_get_widget_image_url
guild_get_widget_image_url
Section titled “guild_get_widget_image_url”Category: guild
Synthesize a public widget PNG URL. No REST call is performed — the agent decides whether to fetch.
When to use
Section titled “When to use”- Embed a guild widget image on a webpage or in markdown.
When NOT to use
Section titled “When NOT to use”- Want JSON data → use
guild_get_widget. Want admin settings → useguild_get_widget_settings.
| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to render |
style | string | no | Widget style: ‘shield’ (default, compact) or ‘banner1’..‘banner4’ (large banner variants) |
Returns
Section titled “Returns”\{url, style\}. The URL is https://discord.com/api/guilds/\{id\}/widget.png?style=\{style\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
url | string | yes | |
style | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | no |
| Confirmation required | no |