Generate Personas
curl --request POST \
--url https://app.octavehq.com/api/v2/persona/generate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"personas": [
{
"name": "Enterprise Sales Leader",
"sources": [
{
"type": "TEXT",
"value": "VP of Sales professionals who manage enterprise deals and drive revenue growth"
}
]
},
{
"sources": [
{
"type": "URL",
"value": "https://example.com/target-customer-profile"
}
]
}
],
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
},
"playbookOId": "pb_456",
"brandVoiceOId": "bv_789",
"async": false,
"callbackUrl": "https://example.com/webhook/persona"
}
'import requests
url = "https://app.octavehq.com/api/v2/persona/generate"
payload = {
"personas": [{
"name": "Enterprise Sales Leader",
"sources": [
{
"type": "TEXT",
"value": "VP of Sales professionals who manage enterprise deals and drive revenue growth"
}
]
}, { "sources": [
{
"type": "URL",
"value": "https://example.com/target-customer-profile"
}
] }],
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" },
"playbookOId": "pb_456",
"brandVoiceOId": "bv_789",
"async": False,
"callbackUrl": "https://example.com/webhook/persona"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
personas: [
{
name: 'Enterprise Sales Leader',
sources: [
{
type: 'TEXT',
value: 'VP of Sales professionals who manage enterprise deals and drive revenue growth'
}
]
},
{sources: [{type: 'URL', value: 'https://example.com/target-customer-profile'}]}
],
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'},
playbookOId: 'pb_456',
brandVoiceOId: 'bv_789',
async: false,
callbackUrl: 'https://example.com/webhook/persona'
})
};
fetch('https://app.octavehq.com/api/v2/persona/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://app.octavehq.com/api/v2/persona/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([
'personas' => [
[
'name' => 'Enterprise Sales Leader',
'sources' => [
[
'type' => 'TEXT',
'value' => 'VP of Sales professionals who manage enterprise deals and drive revenue growth'
]
]
],
[
'sources' => [
[
'type' => 'URL',
'value' => 'https://example.com/target-customer-profile'
]
]
]
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
],
'playbookOId' => 'pb_456',
'brandVoiceOId' => 'bv_789',
'async' => false,
'callbackUrl' => 'https://example.com/webhook/persona'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/persona/generate"
payload := strings.NewReader("{\n \"personas\": [\n {\n \"name\": \"Enterprise Sales Leader\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"VP of Sales professionals who manage enterprise deals and drive revenue growth\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"type\": \"URL\",\n \"value\": \"https://example.com/target-customer-profile\"\n }\n ]\n }\n ],\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n },\n \"playbookOId\": \"pb_456\",\n \"brandVoiceOId\": \"bv_789\",\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/persona\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<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://app.octavehq.com/api/v2/persona/generate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"personas\": [\n {\n \"name\": \"Enterprise Sales Leader\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"VP of Sales professionals who manage enterprise deals and drive revenue growth\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"type\": \"URL\",\n \"value\": \"https://example.com/target-customer-profile\"\n }\n ]\n }\n ],\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n },\n \"playbookOId\": \"pb_456\",\n \"brandVoiceOId\": \"bv_789\",\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/persona\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/persona/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"personas\": [\n {\n \"name\": \"Enterprise Sales Leader\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"VP of Sales professionals who manage enterprise deals and drive revenue growth\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"type\": \"URL\",\n \"value\": \"https://example.com/target-customer-profile\"\n }\n ]\n }\n ],\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n },\n \"playbookOId\": \"pb_456\",\n \"brandVoiceOId\": \"bv_789\",\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/persona\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": [
{
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"name": "VP of Sales",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"updatedAt": "2021-01-01",
"unrecognized": false,
"rejected": false,
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
]
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Persona
Generate Personas
Generate personas from source materials using AI. Each input array generates one persona. Supports text, URLs, and generative names as sources.
POST
/
api
/
v2
/
persona
/
generate
Generate Personas
curl --request POST \
--url https://app.octavehq.com/api/v2/persona/generate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"personas": [
{
"name": "Enterprise Sales Leader",
"sources": [
{
"type": "TEXT",
"value": "VP of Sales professionals who manage enterprise deals and drive revenue growth"
}
]
},
{
"sources": [
{
"type": "URL",
"value": "https://example.com/target-customer-profile"
}
]
}
],
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
},
"playbookOId": "pb_456",
"brandVoiceOId": "bv_789",
"async": false,
"callbackUrl": "https://example.com/webhook/persona"
}
'import requests
url = "https://app.octavehq.com/api/v2/persona/generate"
payload = {
"personas": [{
"name": "Enterprise Sales Leader",
"sources": [
{
"type": "TEXT",
"value": "VP of Sales professionals who manage enterprise deals and drive revenue growth"
}
]
}, { "sources": [
{
"type": "URL",
"value": "https://example.com/target-customer-profile"
}
] }],
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" },
"playbookOId": "pb_456",
"brandVoiceOId": "bv_789",
"async": False,
"callbackUrl": "https://example.com/webhook/persona"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
personas: [
{
name: 'Enterprise Sales Leader',
sources: [
{
type: 'TEXT',
value: 'VP of Sales professionals who manage enterprise deals and drive revenue growth'
}
]
},
{sources: [{type: 'URL', value: 'https://example.com/target-customer-profile'}]}
],
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'},
playbookOId: 'pb_456',
brandVoiceOId: 'bv_789',
async: false,
callbackUrl: 'https://example.com/webhook/persona'
})
};
fetch('https://app.octavehq.com/api/v2/persona/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://app.octavehq.com/api/v2/persona/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([
'personas' => [
[
'name' => 'Enterprise Sales Leader',
'sources' => [
[
'type' => 'TEXT',
'value' => 'VP of Sales professionals who manage enterprise deals and drive revenue growth'
]
]
],
[
'sources' => [
[
'type' => 'URL',
'value' => 'https://example.com/target-customer-profile'
]
]
]
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
],
'playbookOId' => 'pb_456',
'brandVoiceOId' => 'bv_789',
'async' => false,
'callbackUrl' => 'https://example.com/webhook/persona'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/persona/generate"
payload := strings.NewReader("{\n \"personas\": [\n {\n \"name\": \"Enterprise Sales Leader\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"VP of Sales professionals who manage enterprise deals and drive revenue growth\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"type\": \"URL\",\n \"value\": \"https://example.com/target-customer-profile\"\n }\n ]\n }\n ],\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n },\n \"playbookOId\": \"pb_456\",\n \"brandVoiceOId\": \"bv_789\",\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/persona\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<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://app.octavehq.com/api/v2/persona/generate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"personas\": [\n {\n \"name\": \"Enterprise Sales Leader\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"VP of Sales professionals who manage enterprise deals and drive revenue growth\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"type\": \"URL\",\n \"value\": \"https://example.com/target-customer-profile\"\n }\n ]\n }\n ],\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n },\n \"playbookOId\": \"pb_456\",\n \"brandVoiceOId\": \"bv_789\",\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/persona\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/persona/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"personas\": [\n {\n \"name\": \"Enterprise Sales Leader\",\n \"sources\": [\n {\n \"type\": \"TEXT\",\n \"value\": \"VP of Sales professionals who manage enterprise deals and drive revenue growth\"\n }\n ]\n },\n {\n \"sources\": [\n {\n \"type\": \"URL\",\n \"value\": \"https://example.com/target-customer-profile\"\n }\n ]\n }\n ],\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n },\n \"playbookOId\": \"pb_456\",\n \"brandVoiceOId\": \"bv_789\",\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/persona\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": [
{
"oId": "p_1234",
"createdAt": "2021-01-01",
"data": {
"internalName": "<string>",
"primaryResponsibilities": [
"Responsibility 1",
"Responsibility 2"
],
"painPoints": [
"Pain Point 1",
"Pain Point 2"
],
"keyConcerns": [
"Concern 1",
"Concern 2"
],
"keyObjectives": [
"Objective 1",
"Objective 2"
],
"commonJobTitles": [
"Job Title 1",
"Job Title 2"
],
"whyTheyMatterToUs": [
"Reason 1",
"Reason 2"
],
"whyWeMatterToThem": [
"Reason 1",
"Reason 2"
],
"buyingRole": [
"Economic buyer with budget authority over the GTM stack.",
"Experienced operator who has evaluated similar tooling before."
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "wa_1234"
},
"name": "VP of Sales",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"updatedAt": "2021-01-01",
"unrecognized": false,
"rejected": false,
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
]
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Persona generation input with source materials
Array of persona generation requests - each object generates one persona
Minimum array length:
1Show child attributes
Show child attributes
Example:
[
{
"name": "Enterprise Sales Leader",
"sources": [
{
"type": "TEXT",
"value": "VP of Sales professionals who manage enterprise deals and drive revenue growth"
}
]
},
{
"sources": [
{
"type": "URL",
"value": "https://example.com/target-customer-profile"
}
]
}
]
Primary Offering to use as context when generating personas. If not provided, the primary company attached to the Workspace will be used.
Example:
"o_123456"
Strategy for linking generated personas to offerings (products/services)
- Option 1
- Option 2
Show child attributes
Show child attributes
Optional playbook ID to link the generated personas to
Example:
"pb_456"
Optional brand voice ID to apply to generated personas
Example:
"bv_789"
If true, the persona generation will be processed asynchronously
Example:
false
Optional callback URL. When provided with async: true, the API will POST the result to this URL once processing completes.
Example:
"https://example.com/webhook/persona"
⌘I