Generate Proof Points

curl --request POST \
  --url https://app.octavehq.com/api/v2/proof-point/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "proofPoints": [
    {
      "name": "50% Sales Improvement Case Study",
      "sources": [
        {
          "type": "TEXT",
          "value": "Customer success story showing 50% improvement in sales conversion rates"
        }
      ]
    },
    {
      "sources": [
        {
          "type": "URL",
          "value": "https://example.com/case-study"
        }
      ]
    }
  ],
  "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>",
      "shared": true,
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "active": true,
      "data": {
        "howWeTalkAboutThis": [
          "<string>"
        ],
        "whyThisMatters": [
          "<string>"
        ],
        "type": "stat",
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      }
    }
  ]
}

POST

api

proof-point

generate

Generate Proof Points

curl --request POST \
  --url https://app.octavehq.com/api/v2/proof-point/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "proofPoints": [
    {
      "name": "50% Sales Improvement Case Study",
      "sources": [
        {
          "type": "TEXT",
          "value": "Customer success story showing 50% improvement in sales conversion rates"
        }
      ]
    },
    {
      "sources": [
        {
          "type": "URL",
          "value": "https://example.com/case-study"
        }
      ]
    }
  ],
  "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>",
      "shared": true,
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "active": true,
      "data": {
        "howWeTalkAboutThis": [
          "<string>"
        ],
        "whyThisMatters": [
          "<string>"
        ],
        "type": "stat",
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      }
    }
  ]
}

Authorizations

api_key

string

header

required

Body

application/json

Proof point generation input with source materials

proofPoints

object[]

required

Array of proof point generation requests - each object generates one proof point

Minimum array length: 1

Show child attributes

proofPoints.sources

object[]

required

Source materials to generate the proof point from

Show child attributes

proofPoints.sources.type

enum<string>

required

The type of source material

Available options:

TEXT,

URL

Example:

"TEXT"

proofPoints.sources.value

string

required

The source content (text, URL, or name)

Minimum string length: 1

Example:

"Lead generation and qualification for enterprise sales"

proofPoints.name

string

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

Example:

"50% Sales Improvement Case Study"

Example:

[
  {
    "name": "50% Sales Improvement Case Study",
    "sources": [
      {
        "type": "TEXT",
        "value": "Customer success story showing 50% improvement in sales conversion rates"
      }
    ]
  },
  {
    "sources": [
      {
        "type": "URL",
        "value": "https://example.com/case-study"
      }
    ]
  }
]

primaryOfferingOId

string

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

Example:

"o_123456"

linkingStrategy

object

Strategy for linking generated proof points 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 proof points

Example:

"bv_123456"

Response

Proof points 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.shared

boolean

required

data.deletedAt

string | null

data.archivedAt

string | null

data.active

boolean

default:true

data.data

object

Show child attributes

data.data.howWeTalkAboutThis

string[] | null

data.data.whyThisMatters

string[] | null

data.data.type

enum<string>

Available options:

stat,

fact,

quote,

award,

recognition,

other

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

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 proof point

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the proof point

Example:

"Doe"

data.workspace

object

Show child attributes

data.workspace.oId

string | null

Create Proof Point

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

Generate Proof Points

Authorizations

Body

Response