Generate Segments

curl --request POST \
  --url https://app.octavehq.com/api/v2/segment/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "segments": [
    {
      "name": "Enterprise Technology Companies",
      "sources": [
        {
          "type": "TEXT",
          "value": "Enterprise companies with 500+ employees in technology sector"
        }
      ]
    },
    {
      "sources": [
        {
          "type": "URL",
          "value": "https://example.com/market-research"
        }
      ]
    }
  ],
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  },
  "brandVoiceOId": "bv_123456"
}
'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "name": "<string>",
      "internalName": "<string>",
      "description": "<string>",
      "unrecognized": true,
      "rejected": true,
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "active": true,
      "data": {
        "fitExplanation": "<string>",
        "firmographics": {},
        "keyPriorities": [
          "<string>"
        ],
        "keyConsiderations": [
          "<string>"
        ],
        "uniqueApproach": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      }
    }
  ]
}

POST

api

segment

generate

Generate Segments

curl --request POST \
  --url https://app.octavehq.com/api/v2/segment/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "segments": [
    {
      "name": "Enterprise Technology Companies",
      "sources": [
        {
          "type": "TEXT",
          "value": "Enterprise companies with 500+ employees in technology sector"
        }
      ]
    },
    {
      "sources": [
        {
          "type": "URL",
          "value": "https://example.com/market-research"
        }
      ]
    }
  ],
  "primaryOfferingOId": "o_123456",
  "linkingStrategy": {
    "mode": "ALL"
  },
  "brandVoiceOId": "bv_123456"
}
'

{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "name": "<string>",
      "internalName": "<string>",
      "description": "<string>",
      "unrecognized": true,
      "rejected": true,
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "active": true,
      "data": {
        "fitExplanation": "<string>",
        "firmographics": {},
        "keyPriorities": [
          "<string>"
        ],
        "keyConsiderations": [
          "<string>"
        ],
        "uniqueApproach": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      }
    }
  ]
}

Authorizations

api_key

string

header

required

Body

application/json

Segment generation input with source materials

segments

object[]

required

Array of segment generation requests - each object generates one market segment

Minimum array length: 1

Show child attributes

segments.sources

object[]

required

Source materials to generate the market segment from

Show child attributes

segments.sources.type

enum<string>

required

The type of source material

Available options:

TEXT,

URL

Example:

"TEXT"

segments.sources.value

string

required

The source content (text, URL, or name)

Minimum string length: 1

Example:

"Lead generation and qualification for enterprise sales"

segments.name

string

Optional name for the segment - if provided, will be used as the entity name

Example:

"Enterprise Technology Companies"

Example:

[
  {
    "name": "Enterprise Technology Companies",
    "sources": [
      {
        "type": "TEXT",
        "value": "Enterprise companies with 500+ employees in technology sector"
      }
    ]
  },
  {
    "sources": [
      {
        "type": "URL",
        "value": "https://example.com/market-research"
      }
    ]
  }
]

primaryOfferingOId

string

Primary Offering to use as context when generating segments. If not provided, the primary company attached to the Workspace will be used.

Example:

"o_123456"

linkingStrategy

object

Strategy for linking generated segments to offerings (products/services)

Option 1
Option 2

Show child attributes

linkingStrategy.mode

enum<string>

required

Link to all active offerings in the workspace

Available options:

ALL

Example:

"ALL"

brandVoiceOId

string

Brand voice oId to apply to generated segments

Example:

"bv_123456"

Response

Segments generated successfully

_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"

data

object[]

required

Show child attributes

data.oId

string

required

data.createdAt

string | null

required

data.updatedAt

string | null

required

data.name

string

required

data.internalName

string

required

data.description

string

required

data.unrecognized

boolean

required

data.rejected

boolean

required

data.deletedAt

string | null

data.archivedAt

string | null

data.active

boolean

default:true

data.data

object

Show child attributes

data.data.fitExplanation

string

required

data.data.firmographics

object

required

Show child attributes

data.data.firmographics.{key}

string[]

data.data.keyPriorities

string[]

required

data.data.keyConsiderations

string[]

required

data.data.uniqueApproach

string[]

required

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.qualifyingQuestions

object[] | null

Show child attributes

data.qualifyingQuestions.question

string

required

The question to ask to qualify the entity

data.qualifyingQuestions.rationale

string

required

The rationale for the question as to why it helps qualify

data.qualifyingQuestions.fitType

enum<string>

required

The fit type of the question

Available options:

GOOD,

BAD

Example:

"GOOD"

data.qualifyingQuestions.weight

enum<string>

required

The weight of the question

Available options:

LOW,

MEDIUM,

HIGH,

INSTANT_QUALIFIER,

INSTANT_DISQUALIFIER

Example:

"MEDIUM"

data.qualifyingQuestions.archivedAt

string | null

The date and time the question was archived

data.user

object

Show child attributes

data.user.oId

string | null

data.user.firstName

string | null

The first name of the user who created the segment

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the segment

Example:

"Doe"

data.workspace

object

Show child attributes

data.workspace.oId

string | null

Create Segment Get Competitor

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

Generate Segments

Authorizations

Body

Response