Skip to main content
POST
/
api
/
v2
/
reference
/
generate
Generate References
curl --request POST \
  --url https://app.octavehq.com/api/v2/reference/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "references": [
    {
      "name": "Large filesharing service",
      "sources": [
        {
          "type": "TEXT",
          "value": "Leading cloud storage company with 500+ million users"
        }
      ]
    },
    {
      "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": "r_1234",
      "createdAt": "2021-01-01",
      "data": {
        "howTheyMakeMoney": "<string>",
        "howTheyUseProduct": "<string>",
        "howTheyBenefitFromProduct": "<string>",
        "emailSnippets": [
          "<string>"
        ],
        "howWeImpactedTheirBusiness": [
          "<string>"
        ],
        "keyStats": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "u_1234",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "w_1234"
      },
      "name": "Large filesharing service",
      "internalName": "Dropbox",
      "updatedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "description": "Description of the reference",
      "active": true,
      "unrecognized": false
    }
  ]
}

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

Reference generation input with source materials

​
references
object[]
required

Array of reference generation requests - each object generates one reference

Minimum array length: 1
Example:
[
  {
    "name": "Large filesharing service",
    "sources": [
      {
        "type": "TEXT",
        "value": "Leading cloud storage company with 500+ million users"
      }
    ]
  },
  {
    "sources": [
      {
        "type": "URL",
        "value": "https://example.com/case-study"
      }
    ]
  }
]
​
primaryOfferingOId
string

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

Example:

"o_123456"

​
linkingStrategy
object

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

​
brandVoiceOId
string

Brand voice oId to apply to generated references

Example:

"bv_123456"

Response

References generated successfully

​
_metadata
object
required
​
data
object[]
required