← Back to catalog

Other

D&D 5e

auto-generated
swirls add dnd5eapi
actionGETv1.0.0

Get a background by index.

# Background Every story has a beginning. Your character's background reveals where you came from, how you became an adventurer, and your place in the world. Choosing a background provides you with important story cues about your character's identity. [[SRD p60](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=60)] _Note:_ acolyte is the only background included in the SRD.

Source
actionGETv1.0.0

Get a class by index.

# Class A character class is a fundamental part of the identity and nature of characters in the Dungeons & Dragons role-playing game. A character's capabilities, strengths, and weaknesses are largely defined by its class. A character's class affects a character's available skills and abilities. [[SRD p8-55](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=8)]

Source
actionGETv1.0.0

Get a condition by index.

# Condition A condition alters a creature’s capabilities in a variety of ways and can arise as a result of a spell, a class feature, a monster’s attack, or other effect. Most conditions, such as blinded, are impairments, but a few, such as invisible, can be advantageous.

Source
actionGETv1.0.0

Get a damage type by index.

# Damage type Different attacks, damaging spells, and other harmful effects deal different types of damage. Damage types have no rules of their own, but other rules, such as damage resistance, rely on the types.

Source
actionGETv1.0.0

Get a feat by index.

# Feat A feat is a boon a character can receive at level up instead of an ability score increase.

Source
actionGETv1.0.0

Get a feature by index.

# Feature When you gain a new level in a class, you get its features for that level. You don’t, however, receive the class’s starting Equipment, and a few features have additional rules when you’re multiclassing: Channel Divinity, Extra Attack, Unarmored Defense, and Spellcasting.

Source
actionGETv1.0.0

Get a language by index.

# Language Your race indicates the languages your character can speak by default, and your background might give you access to one or more additional languages of your choice. [[SRD p59](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=59)]

Source
actionGETv1.0.0

Get a magic school by index.

# Magic School Academies of magic group spells into eight categories called schools of magic. Scholars, particularly wizards, apply these categories to all spells, believing that all magic functions in essentially the same way, whether it derives from rigorous study or is bestowed by a deity.

Source
actionGETv1.0.0

Get a proficiency by index.

# Proficiency By virtue of race, class, and background a character is proficient at using certain skills, weapons, and equipment. Characters can also gain additional proficiencies at higher levels or by multiclassing. A characters starting proficiencies are determined during character creation.

Source
actionGETv1.0.0

Get a race by index.

Each race grants your character ability and skill bonuses as well as racial traits.

Source
actionGETv1.0.0

Get a rule by index.

# Rule Rules are pages in the SRD that document the mechanics of Dungeons and Dragons. Rules have descriptions which is the text directly underneath the rule heading in the SRD. Rules also have subsections for each heading underneath the rule in the SRD.

Source
actionGETv1.0.0

Get a rule section by index.

Rule sections represent a sub-heading and text that can be found underneath a rule heading in the SRD.

Source
actionGETv1.0.0

Get a skill by index.

# Skill Each ability covers a broad range of capabilities, including skills that a character or a monster can be proficient in. A skill represents a specific aspect of an ability score, and an individual's proficiency in a skill demonstrates a focus on that aspect. [[SRD p77](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=77)]

Source
actionGETv1.0.0

Get a subclass by index.

Subclasses reflect the different paths a class may take as levels are gained.

Source
actionGETv1.0.0

Get a subrace by index.

Subraces reflect the different varieties of a certain parent race.

Source
actionGETv1.0.0

Get all resource URLs.

Making a request to the API's base URL returns an object containing available endpoints.

Source
actionGETv1.0.0

Get an ability score by index.

# Ability Score Represents one of the six abilities that describes a creature's physical and mental characteristics. The three main rolls of the game - the ability check, the saving throw, and the attack roll - rely on the ability scores. [[SRD p76](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=76)]

Source
actionGETv1.0.0

Get an alignment by index.

# Alignment A typical creature in the game world has an alignment, which broadly describes its moral and personal attitudes. Alignment is a combination of two factors: one identifies morality (good, evil, or neutral), and the other describes attitudes toward society and order (lawful, chaotic, or neutral). Thus, nine distinct alignments define the possible combinations.[[SRD p58](https://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf#page=58)]

Source
actionGETv1.0.0

Get an equipment item by index.

# Equipment Opportunities abound to find treasure, equipment, weapons, armor, and more in the dungeons you explore. Normally, you can sell your treasures and trinkets when you return to a town or other settlement, provided that you can find buyers and merchants interested in your loot.

Source
actionGETv1.0.0

Get list of all available resources for an endpoint.

Currently only the [`/spells`](#get-/api/spells) and [`/monsters`](#get-/api/monsters) endpoints support filtering with query parameters. Use of these query parameters is documented under the respective [Spells](#tag--Spells) and [Monsters](#tag--Monsters) sections.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec