API & MCP Documentation

Integrate AI Persona Generator into your applications and agents.

Getting your API Key

To use the API and MCP server, you need an API key. You can generate one from your Profile page.

Base URL

https://aipersonagen.com

Authentication

Include your API Key in the request header or query parameter:

Authorization: Bearer YOUR_API_KEY

Endpoints

POST/api/v1/personas

Generate Personas

Generate synthetic user personas based on your configuration.

Request Body

{
  "personaCount": 5,                             // [Required] Number of personas to generate
  "format": "json",                              // [Required] Output format: json, sql, csv, excel
  "projectDescription": "An AI fitness app...",  // [Required] Project background description
  "outputLanguage": "english",                   // [Required] Output language (e.g., english, zh-CN)
  "schemaMode": "hybrid",                        // [Optional] Field generation mode: "ai", "hybrid", "strict"
  "aiRecommendCount": 3,                         // [Optional] Number of AI recommended fields
  "personalPrompt": true,                        // [Required] Generate personal prompt for AI
  "customFields": true,                          // [Required] Has custom fields configuration
  "enableAvatar": true,                          // [Required] Enable AI avatar generation
  "fields": [                                    // [Required] Custom field definitions list
    {
      "id": "123e4567-e89b-12d3-a456-426...0",   // [Required] Unique ID (UUID)
      "name": "mbti",                            // [Required] Field name
      "type": "MBTI Type",                       // [Required] Field type
      "description": "Myers-Briggs Type...",     // [Required] Field description
      "values": ["INTJ", "ENFP"],                // [Optional] Optional values list for this field
      "valueWeightPercent": [70, 30],            // [Optional] Value weight distribution list
      "multi": false                             // [Optional] Allow multi-select
    }
  ]
}

Response

{
  "success": true,
  "data": "[{\"mbti\": [\"INTJ\"]}, ...]",       // Generated raw data string in output format
  "format": "json",
  "personaCount": 5,
  "taskId": "123e4567-e89b-12d3-a456-426...0"
}

GET/api/v1/personas

Get Generation Task

Retrieve the data from a previously generated task.

Query Parameters

taskId (required): The UUID of the generated task.