Skip to main content
POST
/
api
/
v2
/
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>",
      "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>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt

Use this file to discover all available pages before exploring further.

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
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)

​
brandVoiceOId
string

Brand voice oId to apply to generated proof points

Example:

"bv_123456"

Response

Proof points generated successfully

​
_metadata
object
required
​
data
object[]
required