Skip to main content
POST
/
api
/
v2
/
service
/
generate
Generate Service
curl --request POST \
  --url https://app.octavehq.com/api/v2/service/generate \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "services": [
    {
      "name": "Managed Analytics Onboarding",
      "sources": [
        {
          "type": "URL",
          "value": "https://www.example.com/services/onboarding"
        }
      ]
    },
    {
      "sources": [
        {
          "type": "TEXT",
          "value": "6-week onboarding engagement that configures dashboards and trains customer teams"
        }
      ]
    }
  ],
  "comparativeAdvantageInput": "Dedicated success engineer with analytics background",
  "likelyAlternativeInput": "Generalist consulting firm or in-house rollout",
  "brandVoiceOId": "bv_789"
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "p_1234",
      "createdAt": "2021-01-01",
      "data": {
        "type": "SERVICE",
        "summary": "<string>",
        "deliverables": [
          "Deliverable 1",
          "Deliverable 2"
        ],
        "competencies": [
          "Competency 1",
          "Competency 2"
        ],
        "comparativeAdvantage": [
          "Advantage 1",
          "Advantage 2"
        ],
        "likelyAlternative": [
          "Alternative 1",
          "Alternative 2"
        ],
        "challengesAddressed": [
          "Challenge 1",
          "Challenge 2"
        ],
        "customerBenefits": [
          "Benefit 1",
          "Benefit 2"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "u_1234",
        "firstName": "John",
        "lastName": "Doe"
      },
      "workspace": {
        "oId": "wa_1234"
      },
      "updatedAt": "2021-01-01",
      "archivedAt": "2021-01-01",
      "deletedAt": "2021-01-01",
      "name": "Service Name",
      "internalName": "Service Internal Name",
      "description": "Service Description",
      "primaryUrl": "https://www.service.com",
      "active": true,
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<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

Service generation input with source materials

services
object[]
required

Array of service generation requests - each object generates one service

Minimum array length: 1
Example:
[
{
"name": "Managed Analytics Onboarding",
"sources": [
{
"type": "URL",
"value": "https://www.example.com/services/onboarding"
}
]
},
{
"sources": [
{
"type": "TEXT",
"value": "6-week onboarding engagement that configures dashboards and trains customer teams"
}
]
}
]
comparativeAdvantageInput
string

Optional comparative advantage description

Example:

"Dedicated success engineer with analytics background"

likelyAlternativeInput
string

Optional likely alternative description

Example:

"Generalist consulting firm or in-house rollout"

brandVoiceOId
string

Optional brand voice ID to apply to generated services

Example:

"bv_789"

Response

Service generated successfully

_metadata
object
required
data
object[]
required