Skip to main content
POST
/
api
/
v2
/
solution
/
generate
Generate Solution
curl --request POST \
  --url https://app.octavehq.com/api/v2/solution/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "<string>",
  "sources": [
    {
      "value": "<string>",
      "name": "<string>",
      "details": "<string>",
      "useNameIfUrlFails": true
    }
  ],
  "instructions": "<string>",
  "brandVoiceOId": "<string>",
  "enableRagEnrichment": true,
  "offeringOIds": [],
  "useCaseOIds": [],
  "personaOIds": [],
  "segmentOIds": [],
  "referenceOIds": [],
  "collateralOIds": [],
  "competitorOIds": [],
  "alternativeOIds": [],
  "buyingTriggerOIds": [],
  "objectionOIds": [],
  "proofPointOIds": [],
  "genericTextEntityOIds": []
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "name": "<string>",
    "internalName": "<string>",
    "summary": "<string>",
    "description": "<string>",
    "distinctCapabilities": [],
    "keyComponents": [],
    "customerBenefits": [],
    "challengesAddressed": [],
    "statusQuo": [],
    "differentiatedValue": [],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<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
name
string
required
sources
object[]
required
instructions
string
brandVoiceOId
string
enableRagEnrichment
boolean
offeringOIds
string[]
useCaseOIds
string[]
personaOIds
string[]
segmentOIds
string[]
referenceOIds
string[]
collateralOIds
string[]
competitorOIds
string[]
alternativeOIds
string[]
buyingTriggerOIds
string[]
objectionOIds
string[]
proofPointOIds
string[]
genericTextEntityOIds
string[]

Response

200 - application/json

Generated solution payload (not persisted)

_metadata
object
required
data
object
required