Chatfai connects to a Nagent workspace with an API key. Once it is connected, agents can call 3 Chatfai actions: "Get Public Character By ID", "List Conversations" and "Search Characters". 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 Chatfai, with input parameters and output schema.
CHATFAI_GET_PUBLIC_CHARACTER_BY_IDTool to retrieve a public character by its ID. Use when you need to fetch details of a single public character by providing its unique ID.
Input parameters
Unique identifier of the public character to retrieve. You can obtain character IDs by searching for characters using CHATFAI_SEARCH_PUBLIC_CHARACTERS.
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
CHATFAI_LIST_CHATFAI_CONVERSATIONSTool to list conversations for the authenticated user. Use when you need to retrieve the user's chat conversations or verify authentication status.
Input parameters
Maximum number of conversations to return per page. Use this to control pagination.
Pagination cursor from the previous response's nextCursor field. Use this to fetch the next page of conversations.
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
CHATFAI_SEARCH_CHARACTERSTool to search for public characters on ChatFAI by name or keyword. Use when you need to find characters matching a specific search query.
Input parameters
Search query string to find characters by name or keyword. Enter the character name or relevant terms to discover matching public characters.
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 3 Chatfai actions on Nagent: "Get Public Character By ID", "List Conversations" and "Search Characters". Get Public Character By ID: Retrieve a public character by its ID. Each action is listed on this page with its input parameters and its output.
Chatfai 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.
Get Public Character By ID takes 1 required input: id. It returns data, error and successful.