Skip to main content
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"
}
'
{
  "_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"
        ],
        "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>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_key
string
header
required

Body

application/json

Persona generation input with source materials

​
personas
object[]
required

Array of persona generation requests - each object generates one persona

Minimum array length: 1
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"
      }
    ]
  }
]
​
primaryOfferingOId
string

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"

​
linkingStrategy
object

Strategy for linking generated personas to offerings (products/services)

​
playbookOId
string

Optional playbook ID to link the generated personas to

Example:

"pb_456"

​
brandVoiceOId
string

Optional brand voice ID to apply to generated personas

Example:

"bv_789"

​
async
boolean
default:false

If true, the persona generation will be processed asynchronously

Example:

false

​
callbackUrl
string<uri>

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"

Response

Personas generated successfully

​
_metadata
object
required
​
data
object[] | null