curl --request POST \
--url https://app.octavehq.com/api/v2/agents/generate-content/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"email": "[email protected]",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"firstName": "<string>",
"linkedInProfile": "<string>",
"runtimeContext": "<unknown>",
"url": "<string>",
"customContext": {
"playbook": {
"oId": "<string>"
},
"product": {
"oId": "<string>"
},
"service": {
"oId": "<string>"
}
},
"outputFormat": "JSON",
"agentOId": "agent_123",
"experimentOId": "experiment_123"
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"found": true,
"message": "Additional information",
"data": {
"content": "<string>",
"jsonContent": {},
"product": {
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "LEGACY",
"keyInsight": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"persona": {
"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>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"businessImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"referenceCustomers": [
{
"name": "",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>",
"howTheyUseProduct": "",
"howTheyBenefitFromProduct": "",
"howWeImpactedTheirBusiness": [],
"keyStats": []
}
],
"valueProps": [
{
"oId": "<string>",
"name": "<string>",
"details": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"evidence": [
"<string>"
]
}
],
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": "<unknown>",
"description": "<string>",
"url": "<string>"
}
],
"metadata": "<unknown>"
}
}
}Provide either agentOId or experimentOId depending on what you want to run.
agentOId to run a specific agent.experimentOId to run a specific experiment.Only one of them should be set at a time.
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/generate-content/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"email": "[email protected]",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"firstName": "<string>",
"linkedInProfile": "<string>",
"runtimeContext": "<unknown>",
"url": "<string>",
"customContext": {
"playbook": {
"oId": "<string>"
},
"product": {
"oId": "<string>"
},
"service": {
"oId": "<string>"
}
},
"outputFormat": "JSON",
"agentOId": "agent_123",
"experimentOId": "experiment_123"
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"found": true,
"message": "Additional information",
"data": {
"content": "<string>",
"jsonContent": {},
"product": {
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "LEGACY",
"keyInsight": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"persona": {
"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>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"useCases": [
{
"oId": "<string>",
"name": "<string>",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"businessImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"referenceCustomers": [
{
"name": "",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>",
"howTheyUseProduct": "",
"howTheyBenefitFromProduct": "",
"howWeImpactedTheirBusiness": [],
"keyStats": []
}
],
"valueProps": [
{
"oId": "<string>",
"name": "<string>",
"details": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"evidence": [
"<string>"
]
}
],
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": "<unknown>",
"description": "<string>",
"url": "<string>"
}
],
"metadata": "<unknown>"
}
}
}Generate content input
Email of the person to generate content for
Job title of the person to generate content for
Company domain to generate content for
"example.com"
Company name to generate content for
First name of the person to generate content for
LinkedIn profile of the person to generate content for
Runtime context
URL to generate content for
Show child attributes
JSON, TEXT, HTML, MARKDOWN AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.
"agent_123"
ExperimentOId is required when running an experiment
"experiment_123"