curl --request POST \
--url https://app.octavehq.com/api/v2/agents/call-prep/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"email": "john@example.com",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"firstName": "<string>",
"linkedInProfile": "<string>",
"runtimeContext": "<any>",
"agentOId": "agent_123"
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"found": true,
"message": "Additional information",
"data": {
"discoveryQuestions": [],
"callScript": "<string>",
"personBrief": "<string>",
"companyBrief": "<string>",
"objectionHandling": "<string>",
"relevantCaseStudies": [
{
"whyIsThisRelevant": [
"<string>"
],
"keyPointsToFocusOn": [
"<string>"
],
"keyDifferences": [
"<string>"
],
"snippet": "<string>",
"referenceCustomerName": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"product": {
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"persona": {
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"useCases": [
{
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"referenceCustomers": [
{
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"resultUrl": "<string>"
}
}
Generate call prep content including discovery questions, call scripts, and objection handling
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/call-prep/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"email": "john@example.com",
"jobTitle": "<string>",
"companyDomain": "example.com",
"companyName": "<string>",
"firstName": "<string>",
"linkedInProfile": "<string>",
"runtimeContext": "<any>",
"agentOId": "agent_123"
}'
{
"_metadata": {
"usage": 0,
"requestId": "requestId",
"message": "message",
"timestamp": "2021-01-01T00:00:00.000Z"
},
"found": true,
"message": "Additional information",
"data": {
"discoveryQuestions": [],
"callScript": "<string>",
"personBrief": "<string>",
"companyBrief": "<string>",
"objectionHandling": "<string>",
"relevantCaseStudies": [
{
"whyIsThisRelevant": [
"<string>"
],
"keyPointsToFocusOn": [
"<string>"
],
"keyDifferences": [
"<string>"
],
"snippet": "<string>",
"referenceCustomerName": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"product": {
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"persona": {
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"useCases": [
{
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"referenceCustomers": [
{
"name": "<string>",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
}
],
"resultUrl": "<string>"
}
}
Call prep input
The body is of type object
.
Call prep successful
The response is of type object
.