curl --request POST \
--url https://app.octavehq.com/api/v2/solution/generate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "Enterprise Analytics Suite",
"sources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": true
}
],
"instructions": "<string>",
"brandVoiceOId": "bv_789",
"enableRagEnrichment": true,
"save": false,
"async": false,
"callbackUrl": "https://example.com/webhook/solution",
"offeringOIds": [],
"useCaseOIds": [],
"personaOIds": [],
"segmentOIds": [],
"referenceOIds": [],
"collateralOIds": [],
"competitorOIds": [],
"alternativeOIds": [],
"buyingTriggerOIds": [],
"objectionOIds": [],
"proofPointOIds": [],
"genericTextEntityOIds": []
}
'import requests
url = "https://app.octavehq.com/api/v2/solution/generate"
payload = {
"name": "Enterprise Analytics Suite",
"sources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": True
}
],
"instructions": "<string>",
"brandVoiceOId": "bv_789",
"enableRagEnrichment": True,
"save": False,
"async": False,
"callbackUrl": "https://example.com/webhook/solution",
"offeringOIds": [],
"useCaseOIds": [],
"personaOIds": [],
"segmentOIds": [],
"referenceOIds": [],
"collateralOIds": [],
"competitorOIds": [],
"alternativeOIds": [],
"buyingTriggerOIds": [],
"objectionOIds": [],
"proofPointOIds": [],
"genericTextEntityOIds": []
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Enterprise Analytics Suite',
sources: [
{
value: '<string>',
name: '<string>',
details: '<string>',
useNameIfUrlFails: true
}
],
instructions: '<string>',
brandVoiceOId: 'bv_789',
enableRagEnrichment: true,
save: false,
async: false,
callbackUrl: 'https://example.com/webhook/solution',
offeringOIds: [],
useCaseOIds: [],
personaOIds: [],
segmentOIds: [],
referenceOIds: [],
collateralOIds: [],
competitorOIds: [],
alternativeOIds: [],
buyingTriggerOIds: [],
objectionOIds: [],
proofPointOIds: [],
genericTextEntityOIds: []
})
};
fetch('https://app.octavehq.com/api/v2/solution/generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/solution/generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Enterprise Analytics Suite',
'sources' => [
[
'value' => '<string>',
'name' => '<string>',
'details' => '<string>',
'useNameIfUrlFails' => true
]
],
'instructions' => '<string>',
'brandVoiceOId' => 'bv_789',
'enableRagEnrichment' => true,
'save' => false,
'async' => false,
'callbackUrl' => 'https://example.com/webhook/solution',
'offeringOIds' => [
],
'useCaseOIds' => [
],
'personaOIds' => [
],
'segmentOIds' => [
],
'referenceOIds' => [
],
'collateralOIds' => [
],
'competitorOIds' => [
],
'alternativeOIds' => [
],
'buyingTriggerOIds' => [
],
'objectionOIds' => [
],
'proofPointOIds' => [
],
'genericTextEntityOIds' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/solution/generate"
payload := strings.NewReader("{\n \"name\": \"Enterprise Analytics Suite\",\n \"sources\": [\n {\n \"value\": \"<string>\",\n \"name\": \"<string>\",\n \"details\": \"<string>\",\n \"useNameIfUrlFails\": true\n }\n ],\n \"instructions\": \"<string>\",\n \"brandVoiceOId\": \"bv_789\",\n \"enableRagEnrichment\": true,\n \"save\": false,\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/solution\",\n \"offeringOIds\": [],\n \"useCaseOIds\": [],\n \"personaOIds\": [],\n \"segmentOIds\": [],\n \"referenceOIds\": [],\n \"collateralOIds\": [],\n \"competitorOIds\": [],\n \"alternativeOIds\": [],\n \"buyingTriggerOIds\": [],\n \"objectionOIds\": [],\n \"proofPointOIds\": [],\n \"genericTextEntityOIds\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/solution/generate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Enterprise Analytics Suite\",\n \"sources\": [\n {\n \"value\": \"<string>\",\n \"name\": \"<string>\",\n \"details\": \"<string>\",\n \"useNameIfUrlFails\": true\n }\n ],\n \"instructions\": \"<string>\",\n \"brandVoiceOId\": \"bv_789\",\n \"enableRagEnrichment\": true,\n \"save\": false,\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/solution\",\n \"offeringOIds\": [],\n \"useCaseOIds\": [],\n \"personaOIds\": [],\n \"segmentOIds\": [],\n \"referenceOIds\": [],\n \"collateralOIds\": [],\n \"competitorOIds\": [],\n \"alternativeOIds\": [],\n \"buyingTriggerOIds\": [],\n \"objectionOIds\": [],\n \"proofPointOIds\": [],\n \"genericTextEntityOIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/solution/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Enterprise Analytics Suite\",\n \"sources\": [\n {\n \"value\": \"<string>\",\n \"name\": \"<string>\",\n \"details\": \"<string>\",\n \"useNameIfUrlFails\": true\n }\n ],\n \"instructions\": \"<string>\",\n \"brandVoiceOId\": \"bv_789\",\n \"enableRagEnrichment\": true,\n \"save\": false,\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/solution\",\n \"offeringOIds\": [],\n \"useCaseOIds\": [],\n \"personaOIds\": [],\n \"segmentOIds\": [],\n \"referenceOIds\": [],\n \"collateralOIds\": [],\n \"competitorOIds\": [],\n \"alternativeOIds\": [],\n \"buyingTriggerOIds\": [],\n \"objectionOIds\": [],\n \"proofPointOIds\": [],\n \"genericTextEntityOIds\": []\n}"
response = http.request(request)
puts response.read_body{
"_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>"
]
}
],
"additionalProperties": {},
"type": "SOLUTION",
"savedSolution": {
"oId": "sv_1234",
"createdAt": "2023-11-07T05:31:56Z",
"data": {
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {},
"type": "SOLUTION"
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"locked": true,
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"primaryUrl": "<string>",
"releaseNotesUrls": [
"https://www.solution.com/changelog"
],
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"linkedProducts": [],
"linkedUseCases": [],
"linkedPersonas": [],
"linkedSegments": [],
"lockedBy": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"picture": "<string>"
}
}
}
}Generate Solution
Generate solution draft content from sources, name, optional library links, and instructions
curl --request POST \
--url https://app.octavehq.com/api/v2/solution/generate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "Enterprise Analytics Suite",
"sources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": true
}
],
"instructions": "<string>",
"brandVoiceOId": "bv_789",
"enableRagEnrichment": true,
"save": false,
"async": false,
"callbackUrl": "https://example.com/webhook/solution",
"offeringOIds": [],
"useCaseOIds": [],
"personaOIds": [],
"segmentOIds": [],
"referenceOIds": [],
"collateralOIds": [],
"competitorOIds": [],
"alternativeOIds": [],
"buyingTriggerOIds": [],
"objectionOIds": [],
"proofPointOIds": [],
"genericTextEntityOIds": []
}
'import requests
url = "https://app.octavehq.com/api/v2/solution/generate"
payload = {
"name": "Enterprise Analytics Suite",
"sources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": True
}
],
"instructions": "<string>",
"brandVoiceOId": "bv_789",
"enableRagEnrichment": True,
"save": False,
"async": False,
"callbackUrl": "https://example.com/webhook/solution",
"offeringOIds": [],
"useCaseOIds": [],
"personaOIds": [],
"segmentOIds": [],
"referenceOIds": [],
"collateralOIds": [],
"competitorOIds": [],
"alternativeOIds": [],
"buyingTriggerOIds": [],
"objectionOIds": [],
"proofPointOIds": [],
"genericTextEntityOIds": []
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Enterprise Analytics Suite',
sources: [
{
value: '<string>',
name: '<string>',
details: '<string>',
useNameIfUrlFails: true
}
],
instructions: '<string>',
brandVoiceOId: 'bv_789',
enableRagEnrichment: true,
save: false,
async: false,
callbackUrl: 'https://example.com/webhook/solution',
offeringOIds: [],
useCaseOIds: [],
personaOIds: [],
segmentOIds: [],
referenceOIds: [],
collateralOIds: [],
competitorOIds: [],
alternativeOIds: [],
buyingTriggerOIds: [],
objectionOIds: [],
proofPointOIds: [],
genericTextEntityOIds: []
})
};
fetch('https://app.octavehq.com/api/v2/solution/generate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.octavehq.com/api/v2/solution/generate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Enterprise Analytics Suite',
'sources' => [
[
'value' => '<string>',
'name' => '<string>',
'details' => '<string>',
'useNameIfUrlFails' => true
]
],
'instructions' => '<string>',
'brandVoiceOId' => 'bv_789',
'enableRagEnrichment' => true,
'save' => false,
'async' => false,
'callbackUrl' => 'https://example.com/webhook/solution',
'offeringOIds' => [
],
'useCaseOIds' => [
],
'personaOIds' => [
],
'segmentOIds' => [
],
'referenceOIds' => [
],
'collateralOIds' => [
],
'competitorOIds' => [
],
'alternativeOIds' => [
],
'buyingTriggerOIds' => [
],
'objectionOIds' => [
],
'proofPointOIds' => [
],
'genericTextEntityOIds' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octavehq.com/api/v2/solution/generate"
payload := strings.NewReader("{\n \"name\": \"Enterprise Analytics Suite\",\n \"sources\": [\n {\n \"value\": \"<string>\",\n \"name\": \"<string>\",\n \"details\": \"<string>\",\n \"useNameIfUrlFails\": true\n }\n ],\n \"instructions\": \"<string>\",\n \"brandVoiceOId\": \"bv_789\",\n \"enableRagEnrichment\": true,\n \"save\": false,\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/solution\",\n \"offeringOIds\": [],\n \"useCaseOIds\": [],\n \"personaOIds\": [],\n \"segmentOIds\": [],\n \"referenceOIds\": [],\n \"collateralOIds\": [],\n \"competitorOIds\": [],\n \"alternativeOIds\": [],\n \"buyingTriggerOIds\": [],\n \"objectionOIds\": [],\n \"proofPointOIds\": [],\n \"genericTextEntityOIds\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/solution/generate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Enterprise Analytics Suite\",\n \"sources\": [\n {\n \"value\": \"<string>\",\n \"name\": \"<string>\",\n \"details\": \"<string>\",\n \"useNameIfUrlFails\": true\n }\n ],\n \"instructions\": \"<string>\",\n \"brandVoiceOId\": \"bv_789\",\n \"enableRagEnrichment\": true,\n \"save\": false,\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/solution\",\n \"offeringOIds\": [],\n \"useCaseOIds\": [],\n \"personaOIds\": [],\n \"segmentOIds\": [],\n \"referenceOIds\": [],\n \"collateralOIds\": [],\n \"competitorOIds\": [],\n \"alternativeOIds\": [],\n \"buyingTriggerOIds\": [],\n \"objectionOIds\": [],\n \"proofPointOIds\": [],\n \"genericTextEntityOIds\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/solution/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Enterprise Analytics Suite\",\n \"sources\": [\n {\n \"value\": \"<string>\",\n \"name\": \"<string>\",\n \"details\": \"<string>\",\n \"useNameIfUrlFails\": true\n }\n ],\n \"instructions\": \"<string>\",\n \"brandVoiceOId\": \"bv_789\",\n \"enableRagEnrichment\": true,\n \"save\": false,\n \"async\": false,\n \"callbackUrl\": \"https://example.com/webhook/solution\",\n \"offeringOIds\": [],\n \"useCaseOIds\": [],\n \"personaOIds\": [],\n \"segmentOIds\": [],\n \"referenceOIds\": [],\n \"collateralOIds\": [],\n \"competitorOIds\": [],\n \"alternativeOIds\": [],\n \"buyingTriggerOIds\": [],\n \"objectionOIds\": [],\n \"proofPointOIds\": [],\n \"genericTextEntityOIds\": []\n}"
response = http.request(request)
puts response.read_body{
"_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>"
]
}
],
"additionalProperties": {},
"type": "SOLUTION",
"savedSolution": {
"oId": "sv_1234",
"createdAt": "2023-11-07T05:31:56Z",
"data": {
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {},
"type": "SOLUTION"
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"locked": true,
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"primaryUrl": "<string>",
"releaseNotesUrls": [
"https://www.solution.com/changelog"
],
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "2023-11-07T05:31:56Z"
}
],
"linkedProducts": [],
"linkedUseCases": [],
"linkedPersonas": [],
"linkedSegments": [],
"lockedBy": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"picture": "<string>"
}
}
}
}Authorizations
Body
Name for the solution to generate
"Enterprise Analytics Suite"
Source materials to generate the solution from
Show child attributes
Show child attributes
Optional additional instructions for generation
Optional brand voice ID to apply to the generated solution
"bv_789"
Whether to enable RAG enrichment during generation
If true, the generated solution is persisted immediately. Returns the saved entity under savedSolution in the response.
false
If true, the solution generation will be processed asynchronously. Requires save: true to persist the result.
false
Optional callback URL. When provided with async: true, the API will POST the result to this URL once processing completes.
"https://example.com/webhook/solution"