API

Every chatfai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Characters

get

characters.get Get a public ChatFAI character by ID (GET /v1/characters/) Risk: read

await corsair.chatfai.api.characters.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Public character ID

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`uid`	`string`	Yes	—
`name`	`string`	Yes	—
`nickname`	`string`	No	—
`publicDescription`	`string`	No	—
`image`	`string`	No	—
`visibility`	`string`	No	—
`categories`	`string[]`	No	—
`featured`	`boolean`	No	—
`firstMessage`	`string`	No	—
`voiceEnabled`	`boolean`	No	—
`likes`	`number`	No	—
`installs`	`number`	No	—
`followers`	`number`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

search

characters.search Search public ChatFAI characters by name or keyword (GET /v1/characters/search) Risk: read

await corsair.chatfai.api.characters.search({});

Input

Name	Type	Required	Description
`q`	`string`	Yes	Search query for public characters by name or keyword

Output

Name	Type	Required	Description
`characters`	`object[]`	Yes	—

characters full type

{
  id: string,
  uid: string,
  name: string,
  nickname?: string | null,
  publicDescription?: string | null,
  image?: string | null,
  visibility?: string,
  categories?: string[],
  featured?: boolean,
  firstMessage?: string | null,
  voiceEnabled?: boolean,
  likes?: number,
  installs?: number,
  followers?: number,
  createdAt?: string,
  updatedAt?: string
}[]

Conversations

list

conversations.list List conversations for the authenticated user (GET /v1/conversations) Risk: read

await corsair.chatfai.api.conversations.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`conversations`	`object[]`	Yes	—
`nextCursor`	`string`	No	—

conversations full type

{
  id: string,
  character_id?: string,
  characterId?: string,
  title?: string,
  createdAt?: string,
  updatedAt?: string
}[]

Overview

Plugins

Characters

get

search

Conversations

list

​Characters

​get

​search

​Conversations

​list

Characters

get

search

Conversations

list