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"
}
'
import requests

url = "https://app.octavehq.com/api/v2/service/generate"

payload = {
    "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"
}
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({
    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'
  })
};

fetch('https://app.octavehq.com/api/v2/service/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/service/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([
    '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'
  ]),
  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/service/generate"

	payload := strings.NewReader("{\n  \"services\": [\n    {\n      \"name\": \"Managed Analytics Onboarding\",\n      \"sources\": [\n        {\n          \"type\": \"URL\",\n          \"value\": \"https://www.example.com/services/onboarding\"\n        }\n      ]\n    },\n    {\n      \"sources\": [\n        {\n          \"type\": \"TEXT\",\n          \"value\": \"6-week onboarding engagement that configures dashboards and trains customer teams\"\n        }\n      ]\n    }\n  ],\n  \"comparativeAdvantageInput\": \"Dedicated success engineer with analytics background\",\n  \"likelyAlternativeInput\": \"Generalist consulting firm or in-house rollout\",\n  \"brandVoiceOId\": \"bv_789\"\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/service/generate")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"services\": [\n    {\n      \"name\": \"Managed Analytics Onboarding\",\n      \"sources\": [\n        {\n          \"type\": \"URL\",\n          \"value\": \"https://www.example.com/services/onboarding\"\n        }\n      ]\n    },\n    {\n      \"sources\": [\n        {\n          \"type\": \"TEXT\",\n          \"value\": \"6-week onboarding engagement that configures dashboards and trains customer teams\"\n        }\n      ]\n    }\n  ],\n  \"comparativeAdvantageInput\": \"Dedicated success engineer with analytics background\",\n  \"likelyAlternativeInput\": \"Generalist consulting firm or in-house rollout\",\n  \"brandVoiceOId\": \"bv_789\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/service/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  \"services\": [\n    {\n      \"name\": \"Managed Analytics Onboarding\",\n      \"sources\": [\n        {\n          \"type\": \"URL\",\n          \"value\": \"https://www.example.com/services/onboarding\"\n        }\n      ]\n    },\n    {\n      \"sources\": [\n        {\n          \"type\": \"TEXT\",\n          \"value\": \"6-week onboarding engagement that configures dashboards and trains customer teams\"\n        }\n      ]\n    }\n  ],\n  \"comparativeAdvantageInput\": \"Dedicated success engineer with analytics background\",\n  \"likelyAlternativeInput\": \"Generalist consulting firm or in-house rollout\",\n  \"brandVoiceOId\": \"bv_789\"\n}"

response = http.request(request)
puts response.read_body
{
  "_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>"
        }
      ]
    }
  ]
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}

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