Skip to main content
POST
/
api
/
v2
/
service
/
create
Create Service
curl --request POST \
  --url https://app.octavehq.com/api/v2/service/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "Managed Analytics Onboarding",
  "internalName": "Analytics Onboarding Service",
  "description": "Hands-on onboarding engagement that configures and validates customer analytics dashboards",
  "primaryUrl": "https://www.example.com/services/onboarding",
  "summary": "6-week onboarding engagement for enterprise customers",
  "deliverables": [
    "Onboarding plan",
    "Integration runbook",
    "Training session"
  ],
  "competencies": [
    "Data engineering",
    "Customer success"
  ],
  "comparativeAdvantage": [
    "Faster time to value",
    "Dedicated success engineer"
  ],
  "likelyAlternative": [
    "In-house rollout",
    "Generalist consulting firm"
  ],
  "challengesAddressed": [
    "Slow time to insight",
    "Ad-hoc data pipelines"
  ],
  "customerBenefits": [
    "Reliable reporting",
    "Reduced internal engineering load"
  ],
  "customFields": [
    {
      "title": "<string>",
      "value": [
        "<string>"
      ]
    }
  ]
}
'
{
  "_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 creation input

name
string
required

The external name of the service

Minimum string length: 1
Example:

"Managed Analytics Onboarding"

internalName
string

The internal name of the service

Example:

"Analytics Onboarding Service"

description
string

A description of the service

Example:

"Hands-on onboarding engagement that configures and validates customer analytics dashboards"

primaryUrl
string<uri>

The primary URL of the service

Example:

"https://www.example.com/services/onboarding"

summary
string

A brief summary of the service

Example:

"6-week onboarding engagement for enterprise customers"

deliverables
string[]

Key deliverables of the service

Example:
[
"Onboarding plan",
"Integration runbook",
"Training session"
]
competencies
string[]

Key competencies required for the service

Example:
["Data engineering", "Customer success"]
comparativeAdvantage
string[]

The comparative advantage of the service

Example:
[
"Faster time to value",
"Dedicated success engineer"
]
likelyAlternative
string[]

The likely alternative to the service

Example:
[
"In-house rollout",
"Generalist consulting firm"
]
challengesAddressed
string[]

The challenges addressed by the service

Example:
[
"Slow time to insight",
"Ad-hoc data pipelines"
]
customerBenefits
string[]

The customer benefits of the service

Example:
[
"Reliable reporting",
"Reduced internal engineering load"
]
customFields
object[]

Custom fields for additional service information

Response

Service created successfully

_metadata
object
required
data
object
required