Files
animethemes-api-docs/docs/jsonapi/reference/reference.md
T
2025-07-29 00:56:10 +02:00

5.4 KiB

title
title
API Reference

API Reference

Wiki


Wiki API resources comprise the repository of anime opening and ending themes and their contextual relations.

Resources

Anime

An anime API resource represents a production with at least one opening or ending sequence.

Anime Image

An anime image API resource represents the association between an anime and an image.

Anime Resource

An anime resource API resource represents the association between an anime and an external resource.

Anime Series

An anime series API resource represents the association between an anime and a series.

Anime Studio

An anime studio API resource represents the association between an anime and a studio.

Anime Synonym

An anime synonym API resource represents an alternate title or common abbreviation for an anime.

Anime Theme

An anime theme API resource represents an OP or ED sequence for an anime.

Anime Theme Entry

An anime theme entry API resource represents a version of an anime theme.

Anime Theme Entry Video

An anime theme entry video API resource represents the association between an anime theme entry and a video.

Artist

An artist API resource represents a musical performer of anime sequences.

Artist Image

An artist image API resource represents the association between an artist and an image.

Artist Member

An artist member API resource represents the association of an artist and a group/unit.

Artist Resource

An artist resource API resource represents the association between an artist and an external resource.

Artist Song

An artist song API resource represents the association between an artist and a song.

Audio

An audio API resource represents the audio track of a video.

Group

A group API resource represents the group that accompanies an AnimeTheme.

Image

An image API resource represents a visual component for another resource such as an anime or artist.

Resource

An external API resource represents a site with supplementary information for another resource such as an anime or artist.

Series

A series API resource represents a collection of related anime.

Song

A song API resource represents the composition that accompanies an AnimeTheme.

Song Resource

An song resource API resource represents the association between an song and an external resource.

Studio

A studio API resource represents a company that produces anime.

Studio Image

A studio image API resource represents the association between a studio and an image.

Studio Resource

A studio resource API resource represents the association between a studio and an external resource.

Video

A video API resource represents a WebM of an anime theme.

Video Script

A video script API resource represents an encoding script used to produce a video.


Global Search Endpoint

The global search endpoint returns a listing of resources that match a given search term.

Admin


Admin API resources pertain to the administration of the site by the moderation team.

Resources

Announcement

An announcement API resource represents a site-wide message to be broadcasted on the homepage.

Dump

A dump API resource represents a database dump of selected tables at a given point in time.

Feature

A feature API resource represents a feature flag that enable/disable site functionalities.

Featured Theme

A featured theme API resource represents a video to be featured on the homepage of the site for a specified amount of time.

Auth


Auth API resources pertain to the authorization of actions on the site.

Resources

Me

The "Me" namespace is a collection of endpoints that pertain to the currently authenticated user.

Permission

A permission API resource represents an assignable label for users and roles that authorizes a particular action in AnimeThemes.

Role

A role API resource represents an assignable label for users that provides a configured group of permissions.

User

A user API resource represents an AnimeThemes account.

Document


Document API resources pertain to site documentation.

Resources

Page

A page API resource represents a static markdown page used for guides and other documentation.

List


List API resources pertain to user playlists.

Resources

Playlist

A playlist API resource represents a list of ordered tracks intended for continuous playback.

Playlist Image

A playlist image API resource represents the association between a playlist and an image.

Playlist Track

A playlist track API resource represents an entry in a playlist.