curl --request POST \
--url https://app.octavehq.com/api/v2/playbook/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"description": "<string>",
"keyInsight": "<string>",
"productOId": "<string>",
"name": "<string>",
"type": "LEGACY",
"context": "<string>",
"personaOIds": [
"<string>"
],
"useCaseOIds": [
"<string>"
],
"competitorOId": "<string>",
"segmentOId": "<string>",
"proofPointOIds": [
"<string>"
],
"referenceOIds": [
"<string>"
],
"createTemplates": true,
"brandVoiceOId": "bv_123456",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"additionalContextSources": [
{
"type": "URL",
"value": "https://example.com/market-research"
},
{
"type": "TEXT",
"value": "Additional market insights about the target segment."
}
]
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "LEGACY",
"keyInsight": [
"<string>"
]
},
"personas": [
{
"oId": "p_1234",
"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>"
]
}
]
},
"valueProps": [
{
"title": "<string>",
"details": "<string>",
"evidence": [
"<string>"
]
}
],
"name": "VP of Sales",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"active": true,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
]
}Create Playbook
curl --request POST \
--url https://app.octavehq.com/api/v2/playbook/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"description": "<string>",
"keyInsight": "<string>",
"productOId": "<string>",
"name": "<string>",
"type": "LEGACY",
"context": "<string>",
"personaOIds": [
"<string>"
],
"useCaseOIds": [
"<string>"
],
"competitorOId": "<string>",
"segmentOId": "<string>",
"proofPointOIds": [
"<string>"
],
"referenceOIds": [
"<string>"
],
"createTemplates": true,
"brandVoiceOId": "bv_123456",
"status": "active",
"referenceMode": "specific",
"proofPointMode": "none",
"additionalContextSources": [
{
"type": "URL",
"value": "https://example.com/market-research"
},
{
"type": "TEXT",
"value": "Additional market insights about the target segment."
}
]
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "LEGACY",
"keyInsight": [
"<string>"
]
},
"personas": [
{
"oId": "p_1234",
"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>"
]
}
]
},
"valueProps": [
{
"title": "<string>",
"details": "<string>",
"evidence": [
"<string>"
]
}
],
"name": "VP of Sales",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"active": true,
"generationMetadata": {
"userSources": [],
"resourceCenterSources": [],
"ragConfig": {
"enabled": false,
"topK": 3,
"collections": [
"WEBSITE"
],
"minRelevance": 0.3
},
"generatedAt": "2023-11-07T05:31:56Z",
"generatedByUserOId": "<string>"
},
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
]
}
]
}Playbook creation input
Description of the playbook
Key insight of the playbook
Product OId of the playbook
Name of the playbook
Type of the playbook. Legacy types are automatically mapped: SEGMENT→SECTOR, SIGNAL→MILESTONE, SPECIALIST→PRACTITIONER.
LEGACY, SECTOR, SOLUTION, MILESTONE, PRACTITIONER, COMPETITIVE, ACCOUNT, CUSTOM Context of the playbook - used to help select Personas and Use Cases if none are provided
Persona OIds of the playbook
Use case OIds of the playbook
Competitor OId for competitive playbooks
Segment OId of the playbook
Proof point OIds of the playbook
Reference OIds of the playbook
Create templates of the playbook
Brand voice oId to apply to generated playbook
"bv_123456"
Status of the playbook
active, draft, archived "active"
Reference mode of the playbook
specific, none "specific"
Proof point mode of the playbook
specific, none "none"
Additional context sources for the playbook. URL and TEXT source types are supported.
Show child attributes
TEXT, URL, GOOGLE_DRIVE_FILE_ID, GENERATIVE_NAME, OID, COMPANY_NAME, FIELDWISE_DOCUMENT_ID [
{
"type": "URL",
"value": "https://example.com/market-research"
},
{
"type": "TEXT",
"value": "Additional market insights about the target segment."
}
]Playbook data
Show child attributes
The ID of the persona
1"p_1234"
Show child attributes
The internal name of the persona
The primary responsibilities of the persona
["Responsibility 1", "Responsibility 2"]The pain points of the persona
["Pain Point 1", "Pain Point 2"]The key concerns of the persona
["Concern 1", "Concern 2"]The key objectives of the persona
["Objective 1", "Objective 2"]The common job titles of the persona
["Job Title 1", "Job Title 2"]The reasons why the persona matters to us
["Reason 1", "Reason 2"]The reasons why we matter to this type of persona
["Reason 1", "Reason 2"]The name of the persona
"VP of Sales"
The internal name of the persona
"Sally the Sales Leader"
The description of the persona
Whether the persona is active and can be used
true
Show child attributes
Show child attributes
TEXT, URL, GOOGLE_DRIVE_FILE_ID, GENERATIVE_NAME, OID, COMPANY_NAME, FIELDWISE_DOCUMENT_ID Show child attributes
1 <= x <= 20WEBSITE, WEBSITE_SCREENSHOT, REFERENCE_SCAN_WEBSITE, REFERENCE_SCAN_SCREENSHOT, FILE, TEXT, WORKSPACE_COMPANY, PRODUCT, PERSONA, USE_CASE, REFERENCE, PLAYBOOK, HYPOTHESIS, COMPETITOR, PROOF_POINT, TOPIC_CLUSTER, SEGMENT, FEATURE, FEATURE_SET, FEATURE_SET_REQUEST, TESTING, GLOBAL_RESOURCE 0 <= x <= 1Show child attributes
The question to ask to qualify the entity
The rationale for the question as to why it helps qualify
The fit type of the question
GOOD, BAD "GOOD"
The weight of the question
LOW, MEDIUM, HIGH, INSTANT_QUALIFIER, INSTANT_DISQUALIFIER "MEDIUM"
The date and time the question was archived