← Tools Reference

The Cat API

The Cat API integration (Design & Media, Data). Imported from open-connector.

API key5 toolshttps://api.thecatapi.com/v1
GET
the_cat_api_search_images
Search for cat images with optional breed, category, type, size, and paging filters.

/images/search

11 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe number of images to return.
pageintegeroptionalThe zero-based result page number.
orderstringoptionalThe Cat API result order.
sizestringoptionalThe image size preset requested from The Cat API.
mimeTypesstringoptionalComma-separated MIME type filters accepted by The Cat API, such as jpg,png or g…
hasBreedsbooleanoptionalWhether to only return images that have breed information attached.
breedIdsstringoptionalComma-separated breed identifiers used to filter image results.
categoryIdsstringoptionalComma-separated category identifiers used to filter image results.
includeBreedsbooleanoptionalWhether The Cat API should include breed objects in image results.
includeCategoriesbooleanoptionalWhether The Cat API should include category objects in image results.
formatstringoptionalThe response format requested from The Cat API.
GET
the_cat_api_get_image
Get one cat image by its The Cat API image identifier.

/images/{imageId}

1 parameter
ParamTypeRequiredDescription
imageIdstringrequiredThe Cat API image identifier.
GET
the_cat_api_list_breeds
List cat breeds supported by The Cat API.

/breeds

2 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe number of breeds to return.
pageintegeroptionalThe zero-based result page number.
GET
the_cat_api_search_breeds
Search cat breeds by breed name.

/breeds/search

1 parameter
ParamTypeRequiredDescription
querystringoptionalThe breed name search query.
GET
the_cat_api_get_breed
Get one cat breed by its The Cat API breed identifier.

/breeds/{breedId}

1 parameter
ParamTypeRequiredDescription
breedIdstringrequiredThe Cat API breed identifier.