Sequence Agent

curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/sequence/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>",
  "lang": "<string>",
  "requestId": "<string>",
  "outputFormat": "text",
  "runtimeContext": {
    "all": ""
  },
  "runtimeInstructions": {
    "all": ""
  },
  "playbookSelectionContext": "<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": {
    "emails": [
      {
        "email": "<string>",
        "subject": "<string>",
        "coreValueProp": "",
        "sections": {
          "greeting": "",
          "opening": "",
          "body": "",
          "closing": "",
          "cta": "",
          "ps": "",
          "signature": ""
        }
      }
    ],
    "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": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Sally the Sales Leader",
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "outputType": "SCOPED_PLAYBOOK"
  }
}

POST

api

agents

sequence

run

Sequence Agent

curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/sequence/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>",
  "lang": "<string>",
  "requestId": "<string>",
  "outputFormat": "text",
  "runtimeContext": {
    "all": ""
  },
  "runtimeInstructions": {
    "all": ""
  },
  "playbookSelectionContext": "<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": {
    "emails": [
      {
        "email": "<string>",
        "subject": "<string>",
        "coreValueProp": "",
        "sections": {
          "greeting": "",
          "opening": "",
          "body": "",
          "closing": "",
          "cta": "",
          "ps": "",
          "signature": ""
        }
      }
    ],
    "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": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Sally the Sales Leader",
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "outputType": "SCOPED_PLAYBOOK"
  }
}

Authorizations

api_key

string

header

required

Body

application/json

Generate emails input

string | null

Email of the person to generate emails for

Example:

"[email protected]"

jobTitle

string | null

Job title of the person to generate emails for

companyDomain

string | null

Company domain of the person to generate emails for

Example:

"example.com"

companyName

string | null

Company name of the person to generate emails for

firstName

string | null

First name of the person to generate emails for

linkedInProfile

string | null

LinkedIn profile of the person to generate emails for

lang

string | null

Language of the person to generate emails for

requestId

string | null

outputFormat

enum<string> | null

default:text

Output format of the emails to generate

Available options:

text,

html,

markdown

runtimeContext

object

Runtime context of the person to generate emails for

Show child attributes

runtimeContext.{key}

string

runtimeInstructions

object

Runtime instructions of the person to generate emails for

Show child attributes

runtimeInstructions.{key}

string

playbookSelectionContext

string | null

Playbook selection context of the person to generate emails for

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 emails 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.emails

object[] | null

Show child attributes

data.emails.email

string

required

data.emails.subject

string

required

data.emails.coreValueProp

string | null

default:""

data.emails.sections

object

Show child attributes

data.emails.sections.greeting

string | null

default:""

data.emails.sections.opening

string | null

default:""

data.emails.sections.body

string | null

default:""

data.emails.sections.closing

string | null

default:""

data.emails.sections.cta

string | null

default:""

data.emails.sections.ps

string | null

default:""

data.emails.sections.signature

string | null

default:""

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.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.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.outputType

enum<string> | null

Available options:

SCOPED_PLAYBOOK,

BEST_FIT_PLAYBOOK,

RESEARCH_BASED,

ALL

Content Agent Prospector Agent

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

Sequence Agent

Authorizations

Body

Response