Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Cat API Favourites API

Manage user favourite cat images.

The Cat API Favourites API is one of 5 APIs that The Cat API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Favourites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 4 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.thecatapi.com/v1.

4 operations 2 paths 4 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.thecatapi.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

The Cat API Favourites API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyHeader). By default, every request must be authenticated.

  • ApiKeyHeader — API key obtained by registering at https://thecatapi.com/signup

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Favourites 4

Manage user favourite cat images.

GET
/favourites
List Favourites
listFavourites 3 params → 200
POST
/favourites
Save Favourite
saveFavourite body → 200400
GET
/favourites/{favourite_id}
Get Favourite
getFavourite 1 param → 200
DELETE
/favourites/{favourite_id}
Delete Favourite
deleteFavourite 1 param → 200400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Breed (26 properties), Image (6 properties), Favourite (6 properties), Category (2 properties). Each schema is shown below with its type and property counts.

Category
object
An image category tag.
2 properties 2 required
Favourite
object
A favourite image saved by a user.
6 properties 2 required
Image
object
A cat image with metadata.
6 properties 2 required
Breed
object
Information about a cat breed.
26 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-cat-api-favourites-api-openapi.yml Raw ↑

Other APIs The Cat API publishes across the network.

The Cat API Breeds API
The Cat API Categories API
The Cat API Images API
The Cat API Votes API