Generate personas with AI

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "<string>",
  "tag": "<string>",
  "count": 3,
  "prompt": "<string>",
  "preview": false
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate"

payload = {
    "brand": "<string>",
    "tag": "<string>",
    "count": 3,
    "prompt": "<string>",
    "preview": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brand: '<string>',
    tag: '<string>',
    count: 3,
    prompt: '<string>',
    preview: false
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'brand' => '<string>',
    'tag' => '<string>',
    'count' => 3,
    'prompt' => '<string>',
    'preview' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate"

	payload := strings.NewReader("{\n  \"brand\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"count\": 3,\n  \"prompt\": \"<string>\",\n  \"preview\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"count\": 3,\n  \"prompt\": \"<string>\",\n  \"preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brand\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"count\": 3,\n  \"prompt\": \"<string>\",\n  \"preview\": false\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "picture": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_updated": "<string>",
    "profile": {
      "brand": "<string>",
      "archetype": "<string>",
      "tag": "<string>"
    },
    "demographic": {
      "age_from": 123,
      "age_to": 123,
      "gender": "<string>",
      "country": "<string>",
      "language": "<string>",
      "education_level": "<string>",
      "education_field": "<string>",
      "occupation": "<string>",
      "income_from": 123,
      "income_to": 123,
      "living_context": "<string>"
    },
    "internal_compass": {
      "job_to_be_done": "<string>",
      "values_and_personality_traits": "<string>",
      "motivations": "<string>",
      "strategic_goal": "<string>"
    },
    "behavioural_map": {
      "lifestyle_and_primary_tasks": "<string>",
      "media_consumption": "<string>",
      "typical_quote": "<string>"
    },
    "resistance": {
      "pain_points": "<string>",
      "purchase_barriers": "<string>",
      "core_questions": "<string>",
      "key_buying_triggers": "<string>"
    },
    "connection": {
      "product_need": "<string>",
      "why_loves_category": "<string>",
      "summary": "<string>"
    },
    "version": {
      "name": "<string>",
      "changes": "<string>",
      "source": "ai",
      "is_active": true,
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "google_segments_status": "empty"
    },
    "archived": true
  }
]

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "picture": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_updated": "<string>",
    "profile": {
      "brand": "<string>",
      "archetype": "<string>",
      "tag": "<string>"
    },
    "demographic": {
      "age_from": 123,
      "age_to": 123,
      "gender": "<string>",
      "country": "<string>",
      "language": "<string>",
      "education_level": "<string>",
      "education_field": "<string>",
      "occupation": "<string>",
      "income_from": 123,
      "income_to": 123,
      "living_context": "<string>"
    },
    "internal_compass": {
      "job_to_be_done": "<string>",
      "values_and_personality_traits": "<string>",
      "motivations": "<string>",
      "strategic_goal": "<string>"
    },
    "behavioural_map": {
      "lifestyle_and_primary_tasks": "<string>",
      "media_consumption": "<string>",
      "typical_quote": "<string>"
    },
    "resistance": {
      "pain_points": "<string>",
      "purchase_barriers": "<string>",
      "core_questions": "<string>",
      "key_buying_triggers": "<string>"
    },
    "connection": {
      "product_need": "<string>",
      "why_loves_category": "<string>",
      "summary": "<string>"
    },
    "version": {
      "name": "<string>",
      "changes": "<string>",
      "source": "ai",
      "is_active": true,
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "google_segments_status": "empty"
    },
    "archived": true
  }
]

Personas

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. By default the personas are saved in the library and returned with a 201. With preview set, they are returned with a 200 and id null, and nothing is saved; create the ones the user keeps with create_persona, mapping each section to its prefixed fields (demographic.age_from to demographic_age_from, and so on) and setting version_source to ai. Required permission: write:analysis.

POST

organizations

{organization_id}

workspaces

{workspace_id}

personas

generate

Generate personas with AI

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "<string>",
  "tag": "<string>",
  "count": 3,
  "prompt": "<string>",
  "preview": false
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate"

payload = {
    "brand": "<string>",
    "tag": "<string>",
    "count": 3,
    "prompt": "<string>",
    "preview": False
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brand: '<string>',
    tag: '<string>',
    count: 3,
    prompt: '<string>',
    preview: false
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'brand' => '<string>',
    'tag' => '<string>',
    'count' => 3,
    'prompt' => '<string>',
    'preview' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate"

	payload := strings.NewReader("{\n  \"brand\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"count\": 3,\n  \"prompt\": \"<string>\",\n  \"preview\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"count\": 3,\n  \"prompt\": \"<string>\",\n  \"preview\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brand\": \"<string>\",\n  \"tag\": \"<string>\",\n  \"count\": 3,\n  \"prompt\": \"<string>\",\n  \"preview\": false\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "picture": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_updated": "<string>",
    "profile": {
      "brand": "<string>",
      "archetype": "<string>",
      "tag": "<string>"
    },
    "demographic": {
      "age_from": 123,
      "age_to": 123,
      "gender": "<string>",
      "country": "<string>",
      "language": "<string>",
      "education_level": "<string>",
      "education_field": "<string>",
      "occupation": "<string>",
      "income_from": 123,
      "income_to": 123,
      "living_context": "<string>"
    },
    "internal_compass": {
      "job_to_be_done": "<string>",
      "values_and_personality_traits": "<string>",
      "motivations": "<string>",
      "strategic_goal": "<string>"
    },
    "behavioural_map": {
      "lifestyle_and_primary_tasks": "<string>",
      "media_consumption": "<string>",
      "typical_quote": "<string>"
    },
    "resistance": {
      "pain_points": "<string>",
      "purchase_barriers": "<string>",
      "core_questions": "<string>",
      "key_buying_triggers": "<string>"
    },
    "connection": {
      "product_need": "<string>",
      "why_loves_category": "<string>",
      "summary": "<string>"
    },
    "version": {
      "name": "<string>",
      "changes": "<string>",
      "source": "ai",
      "is_active": true,
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "google_segments_status": "empty"
    },
    "archived": true
  }
]

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "picture": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_updated": "<string>",
    "profile": {
      "brand": "<string>",
      "archetype": "<string>",
      "tag": "<string>"
    },
    "demographic": {
      "age_from": 123,
      "age_to": 123,
      "gender": "<string>",
      "country": "<string>",
      "language": "<string>",
      "education_level": "<string>",
      "education_field": "<string>",
      "occupation": "<string>",
      "income_from": 123,
      "income_to": 123,
      "living_context": "<string>"
    },
    "internal_compass": {
      "job_to_be_done": "<string>",
      "values_and_personality_traits": "<string>",
      "motivations": "<string>",
      "strategic_goal": "<string>"
    },
    "behavioural_map": {
      "lifestyle_and_primary_tasks": "<string>",
      "media_consumption": "<string>",
      "typical_quote": "<string>"
    },
    "resistance": {
      "pain_points": "<string>",
      "purchase_barriers": "<string>",
      "core_questions": "<string>",
      "key_buying_triggers": "<string>"
    },
    "connection": {
      "product_need": "<string>",
      "why_loves_category": "<string>",
      "summary": "<string>"
    },
    "version": {
      "name": "<string>",
      "changes": "<string>",
      "source": "ai",
      "is_active": true,
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "google_segments_status": "empty"
    },
    "archived": true
  }
]

Authorizations

Authorization

string

header

required

Path Parameters

organization_id

string<uuid>

required

A UUID string identifying the organization.

workspace_id

string<uuid>

required

A UUID string identifying the workspace.

Body

brand

string

required

Maximum string length: 255

tag

string

required

Maximum string length: 255

count

integer

required

Required range: 1 <= x <= 6

prompt

string

required

country

enum<string>

required

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

Available options:

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

language

enum<string>

required

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
no - no
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

Available options:

ar,

da,

de,

en,

es,

eu,

fi,

fil,

fr,

he,

hi,

hu,

id,

it,

ja,

ko,

nl,

no,

pl,

pt,

ro,

sv,

th,

tr,

ur,

vi,

zh,

zh-TW,

zh-HK

preview

boolean

default:false

Return the generated personas without saving them. Create the ones the user keeps with create_persona, with version_source set to ai.

Response

Preview: generated, nothing saved.

string

required

read-only

organization_id

string<uuid>

required

workspace_id

string<uuid>

required

picture

string | null

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

last_updated

string

required

read-only

profile

object

required

Show child attributes

demographic

object

required

Show child attributes

internal_compass

object

required

Show child attributes

behavioural_map

object

required

Show child attributes

resistance

object

required

Show child attributes

connection

object

required

Show child attributes

version

object

required

Show child attributes

archived

boolean

Overview

Core API

Search API

Generate personas with AI

Authorizations

Path Parameters

Body

Response