AI

API & MCP 接口文档

将 AI 用户画像生成器集成到您的应用程序和智能体中。

获取 API Key

要使用 API 和 MCP 服务器，您需要一个 API Key。您可以在您的个人资料页面中生成它。

基础 URL

https://aipersonagen.com

鉴权 (Authentication)

在请求头或查询参数中包含您的 API Key：

Authorization: Bearer YOUR_API_KEY

接口列表

POST/api/v1/personas

生成用户画像 (Persona)

根据您的配置生成虚拟用户画像。

请求体

{
  "personaCount": 5,                             // [必填] 生成用户画像的数量
  "format": "json",                              // [必填] 输出格式：json, sql, csv, excel
  "projectDescription": "An AI fitness app...",  // [必填] 项目背景描述
  "outputLanguage": "english",                   // [必填] 输出语言 (例如：english, zh-CN)
  "schemaMode": "hybrid",                        // [选填] 字段生成模式："ai", "hybrid", "strict"
  "aiRecommendCount": 3,                         // [选填] AI推荐字段数量
  "personalPrompt": true,                        // [必填] 是否生成AI用户画像提示词
  "customFields": true,                          // [必填] 是否包含自定义字段配置
  "enableAvatar": true,                          // [必填] 是否启用AI头像生成
  "fields": [                                    // [必填] 自定义字段定义列表
    {
      "id": "123e4567-e89b-12d3-a456-426...0",   // [必填] 唯一标识符 (UUID)
      "name": "mbti",                            // [必填] 字段名称
      "type": "MBTI Type",                       // [必填] 字段类型
      "description": "Myers-Briggs Type...",     // [必填] 字段描述
      "values": ["INTJ", "ENFP"],                // [选填] 该字段的可选值列表
      "valueWeightPercent": [70, 30],            // [选填] 该字段的值权重分布列表
      "multi": false                             // [选填] 是否允许多选
    }
  ]
}

响应结果

{
  "success": true,
  "data": "[{\"mbti\": [\"INTJ\"]}, ...]",       // 按输出格式生成的原始数据字符串
  "format": "json",
  "personaCount": 5,
  "taskId": "123e4567-e89b-12d3-a456-426...0"
}
GET/api/v1/personas

获取生成任务

根据任务 ID 获取之前生成的数据。

查询参数

  • taskId (required): 生成的任务的 UUID。