NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Cats connects to a Nagent workspace with an API key. Once it is connected, agents can call 18 Cats actions, such as "Create Favourite", "Create Vote" and "Get Cat Breed by ID". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Cats, with input parameters and output schema.
CATS_CREATE_FAVOURITETool 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
Optional user identifier to segment and filter favourites by user or source.
The ID of the image to save as a favourite.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_CREATE_VOTETool 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
Vote value: 1 for upvote, 0 for downvote.
Optional custom identifier to segment votes (e.g., user tracking ID).
The identifier of the cat image to vote on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_DELETE_FAVOURITETool 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
The ID of the favourite to delete. Must be a favourite that belongs to your account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_DELETE_IMAGEDelete 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
Unique identifier of the image to delete. This must be an image you uploaded to your account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_DELETE_VOTETool 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
The unique identifier of the vote to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_BREEDTool 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
Unique breed identifier (e.g., 'pers' for Persian, 'beng' for Bengal, 'siam' for Siamese).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_FAVOURITETool 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
Unique identifier of the favourite to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_IMAGETool 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
Unique identifier of the cat image to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_IMAGE_ANALYSISGet 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
The unique identifier of the uploaded image to analyze. This is the ID returned when you upload an image to The Cat API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_IMAGE_BREEDSTool 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
Unique identifier of the image to retrieve breed information for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_PORTALSRetrieves 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
Page number for pagination (starts at 0).
Number of breeds to return per page (1-100).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_GET_VOTERetrieves 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
The unique identifier of the vote to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_LIST_CATEGORIESRetrieves 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
Page number for pagination (starts at 0).
Number of categories to return. If not specified, returns all categories.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_LIST_FAVOURITESTool 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
Page number for pagination (zero-indexed, starts at 0).
Number of favourites to return per page (1-100).
Sort order for the results by creation date. DESC returns newest first, ASC returns oldest first.
Filter favourites by sub_id value used when creating them. Use this to retrieve favourites for a specific user or context.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_LIST_UPLOADED_IMAGESTool 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
Page number for pagination (starts at 0). Only works with authenticated requests to page through your uploads.
Number of images to return (1-10, default: 10).
Sort order options for results.
Optional identifier to filter images by sub_id (e.g., user ID or session ID). Only returns images uploaded with this sub_id.
Optional filter to search for images by their original filename. Use this to check if a specific file has already been uploaded.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_LIST_VOTESTool 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
Page number for pagination (starts at 0).
Number of votes to return per page (1-100).
Sort order for votes.
Filter votes by sub_id to get votes for a specific user segment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_SEARCH_BREEDSSearch 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
Search term for breed name. Use part or all of the breed name to find matching breeds (e.g., 'persian', 'sia', 'main').
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CATS_SEARCH_IMAGESSearch 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
Page number for pagination (starts at 0).
Available image sizes for cat images.
Number of images to return (1-25, requires valid API key for values > 10).
Sort order options for results.
Response format options.
If true, only return images that have breed information attached.
Comma-separated MIME types to filter by (e.g., 'jpg,png' for static images, 'gif' for animated).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 18 Cats actions on Nagent, including "Create Favourite", "Create Vote" and "Get Cat Breed by ID". Create Favourite: Save an image as a favourite to your account. Each action is listed on this page with its input parameters and its output.
Cats connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Favourite takes 1 required input: image_id. It also takes 1 optional input: sub_id. It returns data, error and successful.