Skip to main content
POST
/
api
/
v2
/
agents
/
generate-content
/
run
Content Agent
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": "john.doe@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "jobTitle": "<string>",
  "companyDomain": "example.com",
  "companyName": "<string>",
  "linkedInProfile": "<string>",
  "crmContactId": "<string>",
  "crmLeadId": "<string>",
  "crmAccountId": "<string>",
  "runtimeContext": "<unknown>",
  "url": "<string>",
  "customContext": {},
  "agentOId": "agent_123",
  "experimentOId": "experiment_123",
  "includeFullAnnotation": true
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "content": "<string>",
    "jsonContent": {},
    "product": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "matchAnalysis": "<string>"
    },
    "service": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "matchAnalysis": "<string>"
    },
    "solution": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "matchAnalysis": "<string>"
    },
    "playbook": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "matchAnalysis": "<string>"
    },
    "persona": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "matchAnalysis": "<string>"
    },
    "useCases": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "matchAnalysis": "<string>"
      }
    ],
    "referenceCustomers": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "matchAnalysis": "<string>"
      }
    ],
    "alternatives": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "matchAnalysis": "<string>"
      }
    ],
    "buyingTriggers": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "matchAnalysis": "<string>"
      }
    ],
    "objections": [
      {
        "oId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "matchAnalysis": "<string>"
      }
    ],
    "valueProps": [
      {
        "oId": "<string>",
        "name": "<string>",
        "details": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "evidence": [
          "<string>"
        ]
      }
    ],
    "annotations": {
      "annotations": [
        {
          "type": "<string>",
          "title": "<string>",
          "meta": null,
          "description": "<string>",
          "url": "<string>"
        }
      ],
      "metadata": null
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Generate content input

email
string | null

Email of the person to generate content for

Example:

"john.doe@example.com"

firstName
string | null

First name of the person to generate content for

lastName
string | null
jobTitle
string | null

Job title of the person to generate content for

companyDomain
string | null

Company domain to generate content for

Example:

"example.com"

companyName
string | null

Company name to generate content for

linkedInProfile
string | null

LinkedIn profile of the person to generate content for

crmContactId
string | null
crmLeadId
string | null
crmAccountId
string | null
runtimeContext
any | null

Runtime context

url
string | null

URL to generate content for

customContext
object
outputFormat
enum<string> | null
Available options:
JSON,
TEXT,
HTML,
MARKDOWN
agentOId
string

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

Example:

"agent_123"

experimentOId
string

ExperimentOId is required when running an experiment

Example:

"experiment_123"

includeFullAnnotation
boolean

If true, returns full annotation data including metadata. If false or omitted (default), returns minimal annotations to reduce response size.

Response

Generate content successful

_metadata
object
required
found
boolean
required

Whether the operation was successful

Example:

true

message
string | null

Message

Example:

"Additional information"

data
object