# Cats

An API providing access to a vast collection of cat images, breeds, and facts.

- **Category:** images & design
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 18
- **Triggers:** 0
- **Slug:** `CATS`
- **Version:** 20260227_00

## Tools

### Create Favourite

**Slug:** `CATS_CREATE_FAVOURITE`

Tool to save an image as a favourite to your account. Use when you want to mark a cat image as a favourite for later retrieval or filtering by user ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sub_id` | string | No | Optional user identifier to segment and filter favourites by user or source. |
| `image_id` | string | Yes | The ID of the image to save as a favourite. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Vote

**Slug:** `CATS_CREATE_VOTE`

Tool to vote on a cat image. Send image_id and value (1 for upvote, 0 for downvote) to register your vote. Optionally include sub_id for user tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | integer | Yes | Vote value: 1 for upvote, 0 for downvote. |
| `sub_id` | string | No | Optional custom identifier to segment votes (e.g., user tracking ID). |
| `image_id` | string | Yes | The identifier of the cat image to vote on. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Favourite

**Slug:** `CATS_DELETE_FAVOURITE`

Tool to delete a favourite from your account by its ID. Use when you need to remove a previously saved favourite image from your Cat API account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `favourite_id` | string | Yes | The ID of the favourite to delete. Must be a favourite that belongs to your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Image

**Slug:** `CATS_DELETE_IMAGE`

Delete an uploaded image from your account by its ID. Use this when you need to remove an image you previously uploaded to The Cat API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_id` | string | Yes | Unique identifier of the image to delete. This must be an image you uploaded to your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Vote

**Slug:** `CATS_DELETE_VOTE`

Tool to delete a vote from your account by its ID. Use when you need to remove a previously submitted vote for a cat image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vote_id` | string | Yes | The unique identifier of the vote to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cat Breed by ID

**Slug:** `CATS_GET_BREED`

Tool to get detailed information about a specific cat breed by its ID. Use when you need comprehensive details about a particular breed including temperament, origin, characteristics, and URLs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `breed_id` | string | Yes | Unique breed identifier (e.g., 'pers' for Persian, 'beng' for Bengal, 'siam' for Siamese). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Favourite by ID

**Slug:** `CATS_GET_FAVOURITE`

Tool to retrieve a specific favourite by its unique ID. Returns full favourite details including user ID, image ID, creation timestamp, and associated image data. Use when you need to fetch a particular favourite's information or verify favourite existence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `favourite_id` | string | Yes | Unique identifier of the favourite to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cat Image by ID

**Slug:** `CATS_GET_IMAGE`

Tool to retrieve a specific cat image by its unique ID. Returns full image details including URL, dimensions, and breed information if available. Use when you need to fetch a particular image's data or verify image existence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_id` | string | Yes | Unique identifier of the cat image to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image Analysis

**Slug:** `CATS_GET_IMAGE_ANALYSIS`

Get machine learning analysis results for an uploaded image. Returns labels with confidence scores, bounding boxes for detected objects, and content moderation results from ML vendors. Note: GIF images are not supported for analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_id` | string | Yes | The unique identifier of the uploaded image to analyze. This is the ID returned when you upload an image to The Cat API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image Breeds

**Slug:** `CATS_GET_IMAGE_BREEDS`

Tool to retrieve breed information associated with a specific cat image. Use when you need to identify which breed(s) are shown in a particular image from The Cat API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `image_id` | string | Yes | Unique identifier of the image to retrieve breed information for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cat Breeds

**Slug:** `CATS_GET_PORTALS`

Retrieves a paginated list of cat breeds from The Cat API. Returns comprehensive breed information including name, description, temperament, origin, life span, and weight. Use this to browse available cat breeds or search for specific breed information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 0). |
| `limit` | integer | No | Number of breeds to return per page (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vote by ID

**Slug:** `CATS_GET_VOTE`

Retrieves a specific vote by its unique ID from The Cat API. Returns detailed vote information including the image ID, vote value, timestamp, and optional metadata like sub_id and country code. Use this when you need to fetch details about a specific vote.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vote_id` | string | Yes | The unique identifier of the vote to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Image Categories

**Slug:** `CATS_LIST_CATEGORIES`

Retrieves a list of all active image categories from The Cat API. Categories include hats, sunglasses, boxes, sinks, and more. Use category IDs when searching or filtering images by category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 0). |
| `limit` | integer | No | Number of categories to return. If not specified, returns all categories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Favourites

**Slug:** `CATS_LIST_FAVOURITES`

Tool to get all favourites belonging to your account. Use when you need to retrieve saved cat images, optionally filtered by sub_id. Supports pagination to browse through large collections of favourites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (zero-indexed, starts at 0). |
| `limit` | integer | No | Number of favourites to return per page (1-100). |
| `order` | string ("ASC" | "DESC") | No | Sort order for the results by creation date. DESC returns newest first, ASC returns oldest first. |
| `sub_id` | string | No | Filter favourites by sub_id value used when creating them. Use this to retrieve favourites for a specific user or context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Uploaded Images

**Slug:** `CATS_LIST_UPLOADED_IMAGES`

Tool to get all images uploaded to your account via /images/upload. Supports pagination and filtering by sub_id or original filename. Use this to retrieve your uploaded images, check if a file already exists, or filter by user identifiers. The API returns images in order of upload date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 0). Only works with authenticated requests to page through your uploads. |
| `limit` | integer | No | Number of images to return (1-10, default: 10). |
| `order` | string ("ASC" | "DESC") | No | Sort order options for results. |
| `sub_id` | string | No | Optional identifier to filter images by sub_id (e.g., user ID or session ID). Only returns images uploaded with this sub_id. |
| `original_filename` | string | No | Optional filter to search for images by their original filename. Use this to check if a specific file has already been uploaded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Votes

**Slug:** `CATS_LIST_VOTES`

Tool to retrieve all votes you have created. Returns a paginated list of votes with image IDs, vote values, and metadata. Use this to view voting history, filter by user segment (sub_id), or analyze vote patterns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 0). |
| `limit` | integer | No | Number of votes to return per page (1-100). |
| `order` | string ("DESC" | "ASC" | "RANDOM") | No | Sort order for votes. |
| `sub_id` | string | No | Filter votes by sub_id to get votes for a specific user segment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Cat Breeds

**Slug:** `CATS_SEARCH_BREEDS`

Search for cat breeds by name. Use the 'q' parameter with part or all of the breed name to find matching breeds. Returns breed details including temperament, origin, and characteristics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search term for breed name. Use part or all of the breed name to find matching breeds (e.g., 'persian', 'sia', 'main'). |
| `attach_image` | integer | No | Whether to attach the reference image in the response. Use 0 for no image, 1 to include image. If omitted, no image is attached. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Cat Images

**Slug:** `CATS_SEARCH_IMAGES`

Search for random cat images with optional filters. Filter by breed availability, size, and file type. Returns an array of image objects with URLs and metadata. Use this to find cat images for display, testing, or content generation. The default behavior returns 1 random cat image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 0). |
| `size` | string ("thumb" | "small" | "med" | "full") | No | Available image sizes for cat images. |
| `limit` | integer | No | Number of images to return (1-25, requires valid API key for values > 10). |
| `order` | string ("RANDOM" | "ASC" | "DESC") | No | Sort order options for results. |
| `format` | string ("json" | "src") | No | Response format options. |
| `has_breeds` | boolean | No | If true, only return images that have breed information attached. |
| `mime_types` | string | No | Comma-separated MIME types to filter by (e.g., 'jpg,png' for static images, 'gif' for animated). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |