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": "[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>"
    }
  },
  "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>"
          ],
          "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>",
        "title": "<string>",
        "details": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "evidence": [
          "<string>"
        ]
      }
    ],
    "annotations": {
      "annotations": [
        {
          "type": "<string>",
          "title": "<string>",
          "meta": "<unknown>",
          "description": "<string>",
          "url": "<string>"
        }
      ],
      "metadata": "<unknown>"
    }
  }
}

POST

api

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": "[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>"
    }
  },
  "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>"
          ],
          "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>",
        "title": "<string>",
        "details": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "evidence": [
          "<string>"
        ]
      }
    ],
    "annotations": {
      "annotations": [
        {
          "type": "<string>",
          "title": "<string>",
          "meta": "<unknown>",
          "description": "<string>",
          "url": "<string>"
        }
      ],
      "metadata": "<unknown>"
    }
  }
}

Authorizations

api_key

string

header

required

Body

application/json

Generate content input

string | null

Email of the person to generate content for

Example:

"[email protected]"

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

firstName

string | null

First name of the person to generate content for

linkedInProfile

string | null

LinkedIn profile of the person to generate content for

runtimeContext

any | null

Runtime context

url

string | null

URL to generate content for

customContext

object

Show child attributes

customContext.playbook

object

Show child attributes

customContext.playbook.oId

string

required

customContext.product

object

Show child attributes

customContext.product.oId

string

required

customContext.service

object

Show child attributes

customContext.service.oId

string

required

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"

Response

Generate content successful

_metadata

object

required

Show child attributes

_metadata.requestId

string

required

Request ID

Example:

"requestId"

_metadata.timestamp

string

required

Timestamp

Example:

"2021-01-01T00:00:00.000Z"

_metadata.usage

number

default:0

API usage

Example:

0

_metadata.message

string

Message

Example:

"message"

found

boolean

required

Whether the operation was successful

Example:

true

message

string | null

Message

Example:

"Additional information"

data

object

Show child attributes

data.content

string | null

data.jsonContent

object

Show child attributes

data.jsonContent.{key}

unknown

data.product

object

Show child attributes

data.product.data

object

required

Show child attributes

data.product.data.type

enum<string>

default:PRODUCT

Available options:

PRODUCT,

SERVICE

data.product.data.internalName

string | null

The internal name of the product

data.product.data.summary

string | null

data.product.data.capabilities

string[]

Key capabilities of the product

Example:

["Capability 1", "Capability 2"]

data.product.data.differentiatedValue

string[]

The differentiated value of the product

Example:

[
  "Differentiated Value 1",
  "Differentiated Value 2"
]

data.product.data.statusQuo

string[]

The status quo of the product

Example:

["Status Quo 1", "Status Quo 2"]

data.product.data.challengesAddressed

string[]

The challenges addressed by the offering

Example:

["Challenge 1", "Challenge 2"]

data.product.data.customerBenefits

string[]

The customer benefits of the offering

Example:

["Benefit 1", "Benefit 2"]

data.product.data.customFields

object[]

Show child attributes

data.product.data.customFields.title

string

required

data.product.data.customFields.value

string[]

required

data.product.oId

string | null

data.product.name

string | null

data.product.internalName

string | null

The internal name of the product

Example:

"Product Internal Name"

data.product.description

string | null

The description of the product

Example:

"Product Description"

data.product.primaryUrl

string | null

The primary URL of the product

Example:

"https://www.product.com"

data.product.qualifyingQuestions

object[] | null

Show child attributes

data.product.qualifyingQuestions.question

string

required

The question to ask to qualify the entity

data.product.qualifyingQuestions.rationale

string

required

The rationale for the question as to why it helps qualify

data.product.qualifyingQuestions.fitType

enum<string>

required

The fit type of the question

Available options:

GOOD,

BAD

Example:

"GOOD"

data.product.qualifyingQuestions.weight

enum<string>

required

The weight of the question

Available options:

LOW,

MEDIUM,

HIGH,

INSTANT_QUALIFIER,

INSTANT_DISQUALIFIER

Example:

"MEDIUM"

data.product.qualifyingQuestions.archivedAt

string | null

The date and time the question was archived

data.product.matchConfidence

enum<string>

Available options:

LOW,

MEDIUM,

HIGH

data.product.matchAnalysis

string | null

data.playbook

object

Show child attributes

data.playbook.oId

string | null

data.playbook.name

string | null

data.playbook.description

string | null

data.playbook.type

enum<string> | null

Available options:

LEGACY,

SECTOR,

SOLUTION,

MILESTONE,

PRACTITIONER,

COMPETITIVE,

ACCOUNT,

CUSTOM

data.playbook.keyInsight

string[]

data.playbook.matchConfidence

enum<string>

Available options:

LOW,

MEDIUM,

HIGH

data.playbook.matchAnalysis

string | null

data.persona

object

Show child attributes

data.persona.data

object

required

Show child attributes

data.persona.data.internalName

string | null

The internal name of the persona

data.persona.data.primaryResponsibilities

string[]

The primary responsibilities of the persona

Example:

["Responsibility 1", "Responsibility 2"]

data.persona.data.painPoints

string[]

The pain points of the persona

Example:

["Pain Point 1", "Pain Point 2"]

data.persona.data.keyConcerns

string[]

The key concerns of the persona

Example:

["Concern 1", "Concern 2"]

data.persona.data.keyObjectives

string[]

The key objectives of the persona

Example:

["Objective 1", "Objective 2"]

data.persona.data.commonJobTitles

string[]

The common job titles of the persona

Example:

["Job Title 1", "Job Title 2"]

data.persona.data.whyTheyMatterToUs

string[]

The reasons why the persona matters to us

Example:

["Reason 1", "Reason 2"]

data.persona.data.whyWeMatterToThem

string[]

The reasons why we matter to this type of persona

Example:

["Reason 1", "Reason 2"]

data.persona.data.customFields

object[]

Show child attributes

data.persona.data.customFields.title

string

required

data.persona.data.customFields.value

string[]

required

data.persona.oId

string | null

data.persona.name

string | null

data.persona.internalName

string | null

The internal name of the persona

Example:

"Sally the Sales Leader"

data.persona.description

string | null

The description of the persona

data.persona.qualifyingQuestions

object[] | null

Show child attributes

data.persona.qualifyingQuestions.question

string

required

The question to ask to qualify the entity

data.persona.qualifyingQuestions.rationale

string

required

The rationale for the question as to why it helps qualify

data.persona.qualifyingQuestions.fitType

enum<string>

required

The fit type of the question

Available options:

GOOD,

BAD

Example:

"GOOD"

data.persona.qualifyingQuestions.weight

enum<string>

required

The weight of the question

Available options:

LOW,

MEDIUM,

HIGH,

INSTANT_QUALIFIER,

INSTANT_DISQUALIFIER

Example:

"MEDIUM"

data.persona.qualifyingQuestions.archivedAt

string | null

The date and time the question was archived

data.persona.matchConfidence

enum<string>

Available options:

LOW,

MEDIUM,

HIGH

data.persona.matchAnalysis

string | null

data.useCases

object[] | null

Show child attributes

data.useCases.oId

string | null

data.useCases.name

string | null

data.useCases.internalName

string | null

The internal name of the use case

Example:

"Use Case Internal Name"

data.useCases.description

string | null

The description of the use case

Example:

"Use Case Description"

data.useCases.primaryUrl

string | null

The primary URL of the use case

Example:

"https://www.use-case.com"

data.useCases.data

object

Show child attributes

data.useCases.data.summary

string | null

Summary

data.useCases.data.scenarios

string[] | null

Scenarios

data.useCases.data.desiredOutcomes

string[] | null

Desired Outcomes

data.useCases.data.businessDrivers

string[] | null

Business Drivers

data.useCases.data.customFields

object[]

Show child attributes

data.useCases.data.customFields.title

string

required

data.useCases.data.customFields.value

string[]

required

data.useCases.scenarios

string[] | null

Scenarios

data.useCases.desiredOutcomes

string[] | null

Desired Outcomes

data.useCases.matchConfidence

enum<string>

Available options:

LOW,

MEDIUM,

HIGH

data.useCases.matchAnalysis

string | null

data.referenceCustomers

object[] | null

Show child attributes

data.referenceCustomers.name

string

default:""

data.referenceCustomers.oId

string | null

data.referenceCustomers.matchConfidence

enum<string>

Available options:

LOW,

MEDIUM,

HIGH

data.referenceCustomers.matchAnalysis

string | null

data.referenceCustomers.howTheyUseProduct

string | null

default:""

data.referenceCustomers.howTheyBenefitFromProduct

string | null

default:""

data.referenceCustomers.howWeImpactedTheirBusiness

string[] | null

data.referenceCustomers.keyStats

string[] | null

data.valueProps

object[] | null

Show child attributes

data.valueProps.oId

string | null

data.valueProps.title

string | null

data.valueProps.details

string | null

data.valueProps.createdAt

string | null

data.valueProps.updatedAt

string | null

data.valueProps.evidence

string[] | null

data.annotations

object

Show child attributes

data.annotations.annotations

object[] | null

Show child attributes

data.annotations.annotations.type

string

required

data.annotations.annotations.title

string

required

data.annotations.annotations.meta

unknown

data.annotations.annotations.description

string | null

data.annotations.annotations.url

string | null

data.annotations.metadata

unknown

Enrich Person Agent Sequence Agent

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

Content Agent

Authorizations

Body

Response