Skip to content
On this page

Image


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

For example, the Bakemonogatari anime has two images to represent small and large cover images.

Fields

NameTypeNullableDefaultDescription
idIntegerNoYesThe primary key of the resource
pathStringNoYesThe path of the file in storage
sizeIntegerNoYesThe size of the file in storage in Bytes
mimetypeStringNoNoThe media type of the file in storage
facetEnumYesYesThe component that the resource is intended for [Small Cover, Large Cover, Grill]
linkStringNoYesThe URL to stream the file from storage
created_atDateNoNoThe date that the resource was created
updated_atDateNoNoThe date that the resource was last modified
deleted_atDateYesNoThe date that the resource was deleted

Allowed Include Paths

  • anime
  • artists
  • studios

Endpoints

Image Destroy

The image destroy endpoint soft deletes an image and returns the deleted image resource.

Image Force Delete

The image force delete endpoint hard deletes an image and returns a confirmation message.

Image Index

The image index endpoint displays a listing of image resources.

Image Restore

The image restore endpoint restores a soft deleted image and returns the restored image resource.

Image Show

The image show endpoint returns an image resource.

Image Store

The image store endpoint creates a new image and returns the new image resource.

Image Update

The image update endpoint updates an image and returns the updated image resource.

Released under the MIT License.