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
    }
  ]
}

POST

api

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
    }
  ]
}

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

Show child attributes

references.sources

object[]

required

Source materials to generate the reference from

Show child attributes

references.sources.type

enum<string>

required

The type of source material

Available options:

TEXT,

URL

Example:

"TEXT"

references.sources.value

string

required

The source content (text, URL, or name)

Minimum string length: 1

Example:

"Lead generation and qualification for enterprise sales"

references.name

string

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

Example:

"Large filesharing service"

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)

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 references

Example:

"bv_123456"

Response

References 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

The ID of the reference

Minimum string length: 1

Example:

"r_1234"

data.createdAt

string

required

The date and time the reference was created

Example:

"2021-01-01"

data.data

object

required

Show child attributes

data.data.howTheyMakeMoney

string | null

data.data.howTheyUseProduct

string | null

data.data.howTheyBenefitFromProduct

string | null

data.data.emailSnippets

string[] | null

data.data.howWeImpactedTheirBusiness

string[] | null

data.data.keyStats

string[] | null

data.data.customFields

object[]

Show child attributes

data.data.customFields.title

string

required

data.data.customFields.value

string[]

required

data.user

object

required

Show child attributes

data.user.oId

string | null

The ID of the user

Example:

"u_1234"

data.user.firstName

string | null

The first name of the user who created the reference

Example:

"John"

data.user.lastName

string | null

The last name of the user who created the reference

Example:

"Doe"

data.workspace

object

required

Show child attributes

data.workspace.oId

string | null

The ID of the workspace

Example:

"w_1234"

data.name

string | null

The external facing name of the reference

Example:

"Large filesharing service"

data.internalName

string | null

The internal name of the reference

Example:

"Dropbox"

data.updatedAt

string | null

The date and time the reference was updated

Example:

"2021-01-01"

data.deletedAt

string | null

The date and time the reference was deleted

Example:

"2021-01-01"

data.archivedAt

string | null

The date and time the reference was archived

Example:

"2021-01-01"

data.description

string | null

The description of the reference

Example:

"Description of the reference"

data.active

boolean

default:true

Whether the reference is active and can be used

Example:

true

data.unrecognized

boolean | null

Whether the reference is unrecognized

Example:

false

Update Reference Get Product

⌘I

Agents

Async

Workspace

API Key

Persona

Playbook

Use Case

Reference

Product

Segment

Competitor

Proof Point

Generate References

Authorizations

Body

Response