> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate personas with AI

> Generate one or more personas using AI based on a brand, tag, country, language, and free-form prompt. Maximum 6 personas per request. Required permission: `write:analysis`.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate
openapi: 3.0.3
info:
  title: Share Of Model API
  version: v1
  description: >-
    ## Model Context Protocol (MCP)


    In addition to this REST API, Share of Model exposes a **Model Context
    Protocol** server that lets AI assistants (Claude Desktop, Claude Code, MCP
    Inspector, custom agents…) call our endpoints directly as tools. Any
    MCP-compatible client can interact with Share of Model without writing
    custom integration code — connect once with your usual login and start
    asking the assistant to query the data for you.


    ### Connecting from Claude Desktop


    Open **Settings → Connectors**, scroll to the bottom and click **Add custom
    connector**, then paste `https://mcp.shareofmodel.ai/mcp/`. A browser window
    opens for you to log in with your Share of Model account (same login as the
    web app), and the assistant gains access to the tools.


    ### Connecting from Claude Code


    ```bash

    claude mcp add --transport http share-of-model
    https://mcp.shareofmodel.ai/mcp/

    ```


    The first time you call a tool, Claude Code opens your browser to complete
    the login.


    ### Connecting from MCP Inspector


    ```bash

    npx @modelcontextprotocol/inspector

    ```


    In the Inspector UI, pick **Streamable HTTP** as transport, paste
    `https://mcp.shareofmodel.ai/mcp/`, and click **Connect**. The first
    connection prompts you to log in.


    ### Available tools


    Only endpoints tagged `mcp` in this OpenAPI spec are exposed as MCP tools,
    and only read-only (`GET`) routes are exposed. Everything tagged `mcp` below
    is callable from any compliant MCP client.


    ### Example prompts


    Once connected, try asking your assistant things like:


    - _"List the workspaces I have access to."_

    - _"Show me the latest searches in workspace X."_

    - _"Compare the share of model between brand A and brand B over the last 30
    days."_


    For more details on the protocol itself, see the [Model Context Protocol
    specification](https://modelcontextprotocol.io/).
servers:
  - description: Production API
    url: https://api.shareofmodel.ai/
  - description: Development API
    url: https://api.dev.shareofmodel.ai/
security: []
tags:
  - name: Auth
    description: Endpoints needed for API authentication.
  - name: Organizations
    description: Endpoints related to organizations, to list all available organizations.
  - name: Workspaces
    description: Endpoints related to workspaces, to list all available workspaces.
  - name: Analyses
    description: Endpoints related to analyses and analyses management.
  - name: Asset Evaluations
    description: Endpoints related to assets and asset evaluations.
  - name: Brand Catalog
    description: Endpoints related to general brand information.
  - name: Content Briefs
    description: Endpoints related to content briefs generation and optimisation.
  - name: Metrics
    description: >+
      Endpoints related to brand metrics.


      **LEXICON**



      **Brand Awareness**: What opinion the LLMs have concerning specific
      brands, related to certain categories.



      **Brand Perception**: The general sentiment of the LLMs towards a brand,

      based on the pros and cons they mention.

paths:
  /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate:
    post:
      tags:
        - Personas
      summary: Generate personas with AI
      description: >-
        Generate one or more personas using AI based on a brand, tag, country,
        language, and free-form prompt. Maximum 6 personas per request. Required
        permission: `write:analysis`.
      operationId: generate_personas
      parameters:
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the organization.
          required: true
        - in: path
          name: workspace_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the workspace.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonaGenerate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PersonaGenerate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PersonaGenerate'
          '*/*':
            schema:
              $ref: '#/components/schemas/PersonaGenerate'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PersonaList'
          description: ''
        '400':
          description: Validation error.
        '403':
          description: Insufficient permissions.
        '503':
          description: AI generation failed. Please try again.
      security:
        - Bearer: []
components:
  schemas:
    PersonaGenerate:
      type: object
      properties:
        brand:
          type: string
          maxLength: 255
        tag:
          type: string
          maxLength: 255
        count:
          type: integer
          maximum: 6
          minimum: 1
        prompt:
          type: string
        country:
          enum:
            - AE
            - AR
            - AT
            - AU
            - BE
            - BH
            - BO
            - BR
            - CA
            - CH
            - CL
            - CN
            - CO
            - CR
            - CZ
            - DE
            - DK
            - DO
            - EC
            - EG
            - ES
            - FI
            - FR
            - GB
            - GQ
            - GR
            - GT
            - HK
            - HU
            - IE
            - ID
            - IL
            - IN
            - IQ
            - IT
            - JP
            - KR
            - KW
            - LU
            - MA
            - MX
            - MY
            - NG
            - NL
            - 'NO'
            - NZ
            - PA
            - PE
            - PH
            - PK
            - PL
            - PT
            - QA
            - RO
            - RU
            - SA
            - SE
            - SG
            - TH
            - TR
            - TW
            - VN
            - US
            - ZA
            - EU
            - NA
            - WW
          type: string
          description: |-
            * `AE` - AE
            * `AR` - AR
            * `AT` - AT
            * `AU` - AU
            * `BE` - BE
            * `BH` - BH
            * `BO` - BO
            * `BR` - BR
            * `CA` - CA
            * `CH` - CH
            * `CL` - CL
            * `CN` - CN
            * `CO` - CO
            * `CR` - CR
            * `CZ` - CZ
            * `DE` - DE
            * `DK` - DK
            * `DO` - DO
            * `EC` - EC
            * `EG` - EG
            * `ES` - ES
            * `FI` - FI
            * `FR` - FR
            * `GB` - GB
            * `GQ` - GQ
            * `GR` - GR
            * `GT` - GT
            * `HK` - HK
            * `HU` - HU
            * `IE` - IE
            * `ID` - ID
            * `IL` - IL
            * `IN` - IN
            * `IQ` - IQ
            * `IT` - IT
            * `JP` - JP
            * `KR` - KR
            * `KW` - KW
            * `LU` - LU
            * `MA` - MA
            * `MX` - MX
            * `MY` - MY
            * `NG` - NG
            * `NL` - NL
            * `NO` - NO
            * `NZ` - NZ
            * `PA` - PA
            * `PE` - PE
            * `PH` - PH
            * `PK` - PK
            * `PL` - PL
            * `PT` - PT
            * `QA` - QA
            * `RO` - RO
            * `RU` - RU
            * `SA` - SA
            * `SE` - SE
            * `SG` - SG
            * `TH` - TH
            * `TR` - TR
            * `TW` - TW
            * `VN` - VN
            * `US` - US
            * `ZA` - ZA
            * `EU` - EU
            * `NA` - NA
            * `WW` - WW
          x-spec-enum-id: 8d89072a93365767
        language:
          enum:
            - ar
            - da
            - de
            - en
            - es
            - eu
            - fi
            - fil
            - fr
            - he
            - hi
            - hu
            - id
            - it
            - ja
            - ko
            - nl
            - pl
            - pt
            - ro
            - sv
            - th
            - tr
            - ur
            - vi
            - zh
            - zh-TW
            - zh-HK
          type: string
          description: |-
            * `ar` - ar
            * `da` - da
            * `de` - de
            * `en` - en
            * `es` - es
            * `eu` - eu
            * `fi` - fi
            * `fil` - fil
            * `fr` - fr
            * `he` - he
            * `hi` - hi
            * `hu` - hu
            * `id` - id
            * `it` - it
            * `ja` - ja
            * `ko` - ko
            * `nl` - nl
            * `pl` - pl
            * `pt` - pt
            * `ro` - ro
            * `sv` - sv
            * `th` - th
            * `tr` - tr
            * `ur` - ur
            * `vi` - vi
            * `zh` - zh
            * `zh-TW` - zh TW
            * `zh-HK` - zh HK
          x-spec-enum-id: 247b474aa2169ae7
      required:
        - brand
        - count
        - country
        - language
        - prompt
        - tag
    PersonaList:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        organization_id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        archived:
          type: boolean
        picture:
          type: string
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Created
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Modified
        profile:
          allOf:
            - $ref: '#/components/schemas/PersonaProfile'
          readOnly: true
        demographic:
          allOf:
            - $ref: '#/components/schemas/PersonaDemographic'
          readOnly: true
        internal_compass:
          allOf:
            - $ref: '#/components/schemas/PersonaInternalCompass'
          readOnly: true
        behavioural_map:
          allOf:
            - $ref: '#/components/schemas/PersonaBehaviouralMap'
          readOnly: true
        resistance:
          allOf:
            - $ref: '#/components/schemas/PersonaResistance'
          readOnly: true
        connection:
          allOf:
            - $ref: '#/components/schemas/PersonaConnection'
          readOnly: true
        version:
          allOf:
            - $ref: '#/components/schemas/PersonaVersion'
          readOnly: true
      required:
        - behavioural_map
        - connection
        - created_at
        - demographic
        - id
        - internal_compass
        - organization_id
        - picture
        - profile
        - resistance
        - updated_at
        - version
        - workspace_id
    PersonaProfile:
      type: object
      properties:
        brand:
          type: string
        archetype:
          type: string
        tag:
          type: string
      required:
        - archetype
        - brand
        - tag
    PersonaDemographic:
      type: object
      properties:
        age_from:
          type: integer
        age_to:
          type: integer
        gender:
          type: string
        country:
          type: string
        language:
          type: string
        education_level:
          type: string
        education_field:
          type: string
        occupation:
          type: string
        income_from:
          type: integer
          nullable: true
        income_to:
          type: integer
          nullable: true
        living_context:
          type: string
      required:
        - age_from
        - age_to
        - country
        - education_field
        - education_level
        - gender
        - income_from
        - income_to
        - language
        - living_context
        - occupation
    PersonaInternalCompass:
      type: object
      properties:
        job_to_be_done:
          type: string
        values_and_personality_traits:
          type: string
        motivations:
          type: string
        strategic_goal:
          type: string
      required:
        - job_to_be_done
        - motivations
        - strategic_goal
        - values_and_personality_traits
    PersonaBehaviouralMap:
      type: object
      properties:
        lifestyle_and_primary_tasks:
          type: string
        media_consumption:
          type: string
        typical_quote:
          type: string
      required:
        - lifestyle_and_primary_tasks
        - media_consumption
        - typical_quote
    PersonaResistance:
      type: object
      properties:
        pain_points:
          type: string
        purchase_barriers:
          type: string
        core_questions:
          type: string
        key_buying_triggers:
          type: string
      required:
        - core_questions
        - key_buying_triggers
        - pain_points
        - purchase_barriers
    PersonaConnection:
      type: object
      properties:
        product_need:
          type: string
        why_loves_category:
          type: string
        summary:
          type: string
      required:
        - product_need
        - summary
        - why_loves_category
    PersonaVersion:
      type: object
      properties:
        name:
          type: string
        changes:
          type: string
        source:
          enum:
            - ai
            - manual
            - csv
          type: string
          description: |-
            * `ai` - ai
            * `manual` - manual
            * `csv` - csv
          x-spec-enum-id: 8c72147099fc9df7
        is_active:
          type: boolean
        created_by:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
      required:
        - changes
        - created_at
        - created_by
        - is_active
        - name
        - source
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````