Skip to main content
GET
/
api
/
v2
/
motion-playbook
/
get
Get a motion playbook
curl --request GET \
  --url https://app.octavehq.com/api/v2/motion-playbook/get \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "oId": "<string>",
    "motionOId": "<string>",
    "name": "<string>",
    "narrativeInput": "<string>",
    "competitorOIds": [
      "<string>"
    ],
    "accountDomain": "<string>",
    "buyingTriggerOId": "<string>",
    "motionFraming": "<string>",
    "keyMessaging": [
      "<string>"
    ],
    "keyPositioning": [
      "<string>"
    ],
    "scope": {
      "allSegments": true,
      "segmentOIds": [
        "<string>"
      ],
      "allPersonas": true,
      "personaOIds": [
        "<string>"
      ]
    },
    "anchorOverrides": {
      "useCases": {
        "oIds": [
          "<string>"
        ]
      },
      "references": {
        "oIds": [
          "<string>"
        ]
      },
      "proofPoints": {
        "oIds": [
          "<string>"
        ]
      },
      "alternatives": {
        "mode": "AUTO",
        "oIds": []
      },
      "buyingTriggers": {
        "mode": "AUTO",
        "oIds": []
      },
      "objections": {
        "mode": "AUTO",
        "oIds": []
      }
    },
    "additionalContext": "<string>",
    "additionalContextSources": [
      {
        "value": "<string>",
        "name": "<string>",
        "details": "<string>",
        "useNameIfUrlFails": true
      }
    ],
    "brandVoiceOId": "<string>",
    "active": true,
    "lastNarrativeGeneratedAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<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

Query Parameters

oId
string
required

Motion playbook oId

Example:

"pb_abc123"

Response

200 - application/json

Motion playbook data

_metadata
object
required
data
object
required