Create Solution
curl --request POST \
--url https://app.octavehq.com/api/v2/solution/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"solution": {
"name": "<string>",
"internalName": "<string>",
"summary": "<string>",
"description": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"sources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": true
}
],
"active": true,
"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": {
"oId": "sv_1234",
"createdAt": "<string>",
"data": {
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"locked": true,
"updatedAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"primaryUrl": "<string>",
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"linkedProducts": [],
"linkedUseCases": [],
"linkedPersonas": [],
"linkedSegments": [],
"lockedBy": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"picture": "<string>"
}
}
}Solution
Create Solution
Create a new solution from generated output and sources
POST
/
api
/
v2
/
solution
/
create
Create Solution
curl --request POST \
--url https://app.octavehq.com/api/v2/solution/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"solution": {
"name": "<string>",
"internalName": "<string>",
"summary": "<string>",
"description": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"sources": [
{
"value": "<string>",
"name": "<string>",
"details": "<string>",
"useNameIfUrlFails": true
}
],
"active": true,
"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": {
"oId": "sv_1234",
"createdAt": "<string>",
"data": {
"internalName": "<string>",
"summary": "<string>",
"distinctCapabilities": [],
"keyComponents": [],
"customerBenefits": [],
"challengesAddressed": [],
"statusQuo": [],
"differentiatedValue": [],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"user": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"workspace": {
"oId": "<string>"
},
"locked": true,
"updatedAt": "<string>",
"archivedAt": "<string>",
"deletedAt": "<string>",
"name": "<string>",
"internalName": "<string>",
"description": "<string>",
"primaryUrl": "<string>",
"active": true,
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"linkedProducts": [],
"linkedUseCases": [],
"linkedPersonas": [],
"linkedSegments": [],
"lockedBy": {
"oId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"picture": "<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
Body
application/json
Solution creation input
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I