v26

latestOpenAPI 3.1.0raw.githubusercontent.com2026-01-285194311.8 KB

agents

characters

android_app

web_app

evaluation

Get public agent by ID

Get public agent by ID, include pre-generated agents and user-created public agents

get/api/v1/ai/agents/{agent_id}

Path parameters

agent_idstring required

Response

Successful Response

namestring required

genderstring required

avatarstring nullable

backgroundstring nullable

background_imagesstring[] nullable

background_animatedstring nullable

voice_idstring nullable

settingsobject nullable

introstring nullable

openingstring nullable

opening_audio_urlstring nullable

visibility'PUBLIC' | 'PRIVATE'

AI 角色可见性

source'USER_CREATED' | 'AUTO_GENERATED'

AI 角色来源

photosstring[] nullable

categorystring nullable

promptstring nullable

已废弃 - 请使用personality字段代替

main_promptstring nullable

主提示词 - 作为第一个system message，覆盖全局默认主提示词。可以是预设 ID 或自定义文本

mode_promptstring nullable

模式提示词 - 放在角色卡提示词后面，覆盖全局默认模式提示词。可以是预设 ID 或自定义文本

character_card_specstring nullable

personalitystring nullable

角色性格特点 (推荐)

scenariostring nullable

背景设定 (推荐)

message_examplestring nullable

对话示例

creator_notesstring nullable

创作者备注

post_history_instructionsstring nullable

alternate_greetingsstring[] nullable

character_bookobject nullable

tagsstring[] nullable

character_versionstring nullable

extensionsobject nullable

idstring required

readable_idstring required

status'PENDING' | 'APPROVED' | 'REJECTED' required

AI角色状态

creator_idstring nullable

created_atinteger required

updated_atinteger nullable

deleted_atinteger nullable

versioninteger required

energy_pointsinteger

Agent 当前能量点数，对应数据库 points 列

is_followedboolean

follower_countinteger

connector_countinteger