Cats

These are the Cats actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• 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.

• 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.

• Get Cat Breed by ID

  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.

• Get Cat Image by ID

  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.

• Get Favourite by ID

  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.

• Get Vote by ID

  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.

• 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.

• List Image 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.

• 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.

• 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.

• Search Cat 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.

• Search Cat 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.

• 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.

• 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.

• 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.

• Get Cat Breeds

  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.

• 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.

• 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.