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 Images API

Search, upload, retrieve, and delete cat images.

The Cat API Images 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 Images. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 5 operations across 4 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.

5 operations 4 paths 4 schemas 1 DELETE3 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 Images 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 5

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

Images 5

Search, upload, retrieve, and delete cat images.

GET
/images/search
Search Cat Images
searchImages 8 params → 200400401
POST
/images/upload
Upload Cat Image
uploadImage body → 201400401
GET
/images
Get Uploaded Images
getUploadedImages 3 params → 200
GET
/images/{image_id}
Get Image
getImage 1 param → 200404
DELETE
/images/{image_id}
Delete Image
deleteImage 1 param → 204404

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), Error (2 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
Image
object
A cat image with metadata.
6 properties 2 required
Error
object
2 properties
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-images-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 Favourites API
The Cat API Votes API