Skip to main content
POST
/
api
/
v2
/
use-case
/
generate
Generate Use Cases
curl --request POST \
  --url https://app.octavehq.com/api/v2/use-case/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "primaryOfferingOId": "o_123456",
  "brandVoiceOId": "bv_123456",
  "linkingStrategy": {
    "mode": "ALL"
  },
  "useCases": [
    {
      "name": "Automated Lead Scoring",
      "sources": [
        {
          "type": "TEXT",
          "value": "Automated lead scoring and qualification process for sales teams"
        }
      ]
    },
    {
      "sources": [
        {
          "type": "URL",
          "value": "https://example.com/customer-success-story"
        }
      ]
    }
  ]
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "data": [
    {
      "oId": "uc_1234",
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "name": "Use Case Name",
      "internalName": "Use Case Internal Name",
      "description": "Use Case Description",
      "primaryUrl": "https://www.use-case.com",
      "active": true,
      "data": {
        "summary": "<string>",
        "scenarios": [
          "<string>"
        ],
        "desiredOutcomes": [
          "<string>"
        ],
        "businessDrivers": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "<string>"
      },
      "scenarios": [
        "<string>"
      ],
      "desiredOutcomes": [
        "<string>"
      ]
    }
  ]
}

Authorizations

api_key
string
header
required

Body

application/json

Use case generation input with source materials

useCases
object[]
required

Array of use case generation requests - each object generates one use case

Minimum length: 1
Example:
[
{
"name": "Automated Lead Scoring",
"sources": [
{
"type": "TEXT",
"value": "Automated lead scoring and qualification process for sales teams"
}
]
},
{
"sources": [
{
"type": "URL",
"value": "https://example.com/customer-success-story"
}
]
}
]
primaryOfferingOId
string

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

Example:

"o_123456"

brandVoiceOId
string

Brand voice oId to apply to generated use cases

Example:

"bv_123456"

linkingStrategy
object

Strategy for linking this persona to products/offerings Strategy for linking generated use cases to products/offerings

  • Option 1
  • Option 2

Response

Use cases generated successfully

_metadata
object
required
data
object[]
required
I