curl --request POST \
--url https://app.octavehq.com/api/v2/agents/personalize-template/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"email": "john.doe@example.com",
"jobTitle": "<string>",
"companyDomain": "<string>",
"companyName": "<string>",
"firstName": "<string>",
"linkedInProfile": "<string>",
"lang": "<string>",
"outputFormat": "text",
"runtimeContext": {},
"runtimeInstructions": {},
"agentOId": "agent_123"
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"found": true,
"message": "Additional information",
"data": {
"emails": [
{
"email": "<string>",
"subject": "<string>",
"coreValueProp": "",
"sections": {
"greeting": "",
"opening": "",
"body": "",
"closing": "",
"cta": "",
"ps": "",
"signature": ""
}
}
],
"product": {
"oId": "<string>",
"name": "<string>",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"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>"
]
}
]
},
"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": {
"oId": "<string>",
"name": "<string>",
"internalName": "Sally the Sales Leader",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"activeSequences": 123,
"sentEmails": 123,
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"outputType": "SCOPED_PLAYBOOK",
"originalTemplateEmails": [
{
"email": "<string>",
"subject": "<string>",
"coreValueProp": "",
"sections": {
"greeting": "",
"opening": "",
"body": "",
"closing": "",
"cta": "",
"ps": "",
"signature": ""
}
}
]
}
}
Template Personalization Agent
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/personalize-template/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"email": "john.doe@example.com",
"jobTitle": "<string>",
"companyDomain": "<string>",
"companyName": "<string>",
"firstName": "<string>",
"linkedInProfile": "<string>",
"lang": "<string>",
"outputFormat": "text",
"runtimeContext": {},
"runtimeInstructions": {},
"agentOId": "agent_123"
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"found": true,
"message": "Additional information",
"data": {
"emails": [
{
"email": "<string>",
"subject": "<string>",
"coreValueProp": "",
"sections": {
"greeting": "",
"opening": "",
"body": "",
"closing": "",
"cta": "",
"ps": "",
"signature": ""
}
}
],
"product": {
"oId": "<string>",
"name": "<string>",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"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>"
]
}
]
},
"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": {
"oId": "<string>",
"name": "<string>",
"internalName": "Sally the Sales Leader",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"activeSequences": 123,
"sentEmails": 123,
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"outputType": "SCOPED_PLAYBOOK",
"originalTemplateEmails": [
{
"email": "<string>",
"subject": "<string>",
"coreValueProp": "",
"sections": {
"greeting": "",
"opening": "",
"body": "",
"closing": "",
"cta": "",
"ps": "",
"signature": ""
}
}
]
}
}
Template Personalization input
The body is of type object
.
Template Personalization successful
The response is of type object
.