Copy a Smart Audience to the persona library

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience"

payload = {
    "analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    segment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience', 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/from-smart-audience",
  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([
    'analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'segment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/from-smart-audience"

	payload := strings.NewReader("{\n  \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/from-smart-audience")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "deleted": true,
  "picture": "<string>",
  "smart_audience_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "smart_audience_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "deleted": true,
  "picture": "<string>",
  "smart_audience_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "smart_audience_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Personas

Copy a Smart Audience to the persona library

Create a persona from a Smart Audience of an analysis of the workspace. The audience’s name, socio-demo, challenges, decision making, purchase influences, media channels and Google Audiences are copied, the analysis gives the brand, category, country and language, and AI completes the rest of the profile without changing the copied values. The persona’s version source is smart_audience. Nothing is created when the AI fails: the call returns 503 and can be retried. When the workspace already has an active persona copied from this Smart Audience for the same country, it is returned with a 200 and nothing is created. Required permission: write:analysis.

POST

organizations

{organization_id}

workspaces

{workspace_id}

personas

from-smart-audience

Copy a Smart Audience to the persona library

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience"

payload = {
    "analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    segment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience', 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/from-smart-audience",
  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([
    'analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'segment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/from-smart-audience"

	payload := strings.NewReader("{\n  \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/from-smart-audience")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"segment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "deleted": true,
  "picture": "<string>",
  "smart_audience_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "smart_audience_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived": true,
  "deleted": true,
  "picture": "<string>",
  "smart_audience_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "smart_audience_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

analysis_id

string<uuid>

required

The analysis the Smart Audience belongs to.

segment_id

string<uuid>

required

The Smart Audience, as segment_id in its target audience segments.

country

enum<string>

One of the analysis's countries, for the persona. Defaults to the analysis's first country.

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

Response

Already copied: the existing persona.

string<uuid>

required

read-only

organization_id

string<uuid>

required

workspace_id

string<uuid>

required

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

archived

boolean

deleted

boolean

picture

string

Maximum string length: 500

smart_audience_analysis_id

string<uuid> | null

smart_audience_segment_id

string<uuid> | null

Overview

Core API

Search API

Copy a Smart Audience to the persona library

Authorizations

Path Parameters

Body

Response