Skip to main content
POST
/
api
/
v2
/
agents
/
call-prep
/
run
Call Prep Agent
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 '
{
  "agentOId": "agent_123",
  "email": "[email protected]",
  "jobTitle": "<string>",
  "companyDomain": "example.com",
  "companyName": "<string>",
  "firstName": "<string>",
  "linkedInProfile": "<string>",
  "runtimeContext": "<unknown>"
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "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>",
    "annotations": {
      "annotations": [
        {
          "type": "<string>",
          "title": "<string>",
          "meta": "<unknown>",
          "description": "<string>",
          "url": "<string>"
        }
      ],
      "metadata": "<unknown>"
    }
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Call prep input

​
agentOId
string
required

AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.

Example:

"agent_123"

​
email
string | null

Email of the person to build sales call prep materials for

Example:

"[email protected]"

​
jobTitle
string | null

Job title of the person to build sales call prep materials for

​
companyDomain
string | null

The domain of the company to build call prep materials for

Example:

"example.com"

​
companyName
string | null

The name of the company to build call prep materials for

​
firstName
string | null

First name of the person to build sales call prep materials for

​
linkedInProfile
string | null

LinkedIn profile URL of the person to build sales call prep materials for

​
runtimeContext
any | null

Runtime context for sales call prep materials

Response

Call prep successful

​
_metadata
object
required
​
found
boolean
required

Whether the operation was successful

Example:

true

​
message
string | null

Message

Example:

"Additional information"

​
data
object