Octave API

https://docs.octavehq.com/v2-api-reference/
Admin
Octave API is a platform for managing AI agents that perform tasks like prospecting, content...
Tokens:141,458
Snippets:426
Trust Score:6.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### cURL Request Example

Source: https://docs.octavehq.com/v2-api-reference/product/get-product

Example of how to call the Get Product API endpoint using cURL, including the necessary API key and endpoint URL.

```curl
curl --request GET \
  --url https://app.octavehq.com/api/v2/product/get \
  --header 'api_key: <api-key>'
```

--------------------------------

### Bash: Get Competitor Request Example

Source: https://docs.octavehq.com/v2-api-reference/competitor/get-competitor

Example cURL command to fetch competitor data from the Octave V2 API. It specifies the GET request, the API endpoint URL, and includes the necessary API key in the header for authentication.

```bash
curl --request GET \
  --url https://app.octavehq.com/api/v2/competitor/get \
  --header 'api_key: <api-key>'
```

--------------------------------

### Sequence Agent Run Response Example

Source: https://docs.octavehq.com/v2-api-reference/agents/sequence-agent

Example JSON response from a successful Sequence Agent API run.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "emails": [
      {
        "email": "<string>",
        "subject": "<string>",
        "coreValueProp": "",
        "sections": {
          "greeting": "",
          "opening": "",
          "body": "",
          "closing": "",
          "cta": "",
          "ps": "",
          "signature": ""
        }
      }
    ],
    "product": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Product Internal Name",
      "description": "Product Description",
      "data": {
        "summary": "<string>",
        "capabilities": [
          "Capability 1",
          "Capability 2"
        ],
        "customerBenefits": [
          "Benefit 1",
          "Benefit 2"
        ],
        "challengesAddressed": [
          "Challenge 1",
          "Challenge 2"
        ],
        "differentiatedValue": [
          "Differentiated Value 1",
          "Differentiated Value 2"
        ],
        "statusQuo": [
          "Status Quo 1",
          "Status Quo 2"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "playbook": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "LEGACY",
      "keyInsight": [
        "<string>"
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "persona": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Sally the Sales Leader",
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "activeSequences": 123,
      "sentEmails": 123,
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "outputType": "SCOPED_PLAYBOOK"
  }
}
```

--------------------------------

### JSON Response Example

Source: https://docs.octavehq.com/v2-api-reference/product/get-product

An example of a successful JSON response when retrieving product data from the OctaveHQ API v2.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "p_1234",
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01",
  "archivedAt": "2021-01-01",
  "deletedAt": "2021-01-01",
  "name": "Product Name",
  "internalName": "Product Internal Name",
  "description": "Product Description",
  "primaryUrl": "https://www.product.com",
  "data": {
    "summary": "<string>",
    "capabilities": [
      "Capability 1",
      "Capability 2"
    ],
    "customerBenefits": [
      "Benefit 1",
      "Benefit 2"
    ],
    "challengesAddressed": [
      "Challenge 1",
      "Challenge 2"
    ],
    "differentiatedValue": [
      "Differentiated Value 1",
      "Differentiated Value 2"
    ],
    "statusQuo": [
      "Status Quo 1",
      "Status Quo 2"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "u_1234"
  },
  "workspace": {
    "oId": "wa_1234"
  }
}
```

--------------------------------

### Content Agent Run cURL Example

Source: https://docs.octavehq.com/v2-api-reference/agents/content-agent

Example cURL command to execute the Content Agent API for generating content. Demonstrates how to set the request method, URL, headers (Content-Type, api_key), and the JSON payload with example values.

```cURL
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/generate-content/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{ \
  "email": "john.doe@example.com", \
  "jobTitle": "<string>", \
  "companyDomain": "example.com", \
  "companyName": "<string>", \
  "firstName": "<string>", \
  "linkedInProfile": "<string>", \
  "runtimeContext": "<any>", \
  "url": "<string>", \
  "agentOId": "agent_123", \
  "experimentOId": "experiment_123" \
}'
```

--------------------------------

### Sequence Agent Run cURL Example

Source: https://docs.octavehq.com/v2-api-reference/agents/sequence-agent

Example cURL command to execute the Sequence Agent API for running an agent.

```bash
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/sequence/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{ \
  "email": "john.doe@example.com", \
  "jobTitle": "<string>", \
  "companyDomain": "example.com", \
  "companyName": "<string>", \
  "firstName": "<string>", \
  "linkedInProfile": "<string>", \
  "lang": "<string>", \
  "outputFormat": "text", \
  "runtimeContext": { \
    "all": "" \
  }, \
  "runtimeInstructions": { \
    "all": "" \
  }, \
  "playbookSelectionContext": "<string>", \
  "agentOId": "agent_123", \
  "experimentOId": "experiment_123" \
}'
```

--------------------------------

### Get Persona cURL Example

Source: https://docs.octavehq.com/v2-api-reference/persona/get-persona

Demonstrates how to call the Get Persona API endpoint using cURL. This example includes the necessary HTTP GET request, the target URL, and the required API key header for authentication.

```bash
curl --request GET \
  --url https://app.octavehq.com/api/v2/persona/get \
  --header 'api_key: <api-key>'
```

--------------------------------

### Octave v2 API: Get Use Case Example

Source: https://docs.octavehq.com/v2-api-reference/use-case/get-use-case

Example of how to retrieve a specific Use Case using the Octave v2 API. It includes the cURL request and the expected JSON response structure.

```cURL
curl --request GET \
  --url https://app.octavehq.com/api/v2/use-case/get \
  --header 'api_key: <api-key>'
```

```JSON
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "uc_1234",
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01",
  "deletedAt": "2021-01-01",
  "archivedAt": "2021-01-01",
  "name": "Use Case Name",
  "internalName": "Use Case Internal Name",
  "description": "Use Case Description",
  "primaryUrl": "https://www.use-case.com",
  "data": {
    "summary": "<string>",
    "scenarios": [
      "<string>"
    ],
    "desiredOutcomes": [
      "<string>"
    ],
    "businessDrivers": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "user": {
    "oId": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  },
  "scenarios": [
    "<string>"
  ],
  "desiredOutcomes": [
    "<string>"
  ]
}
```

--------------------------------

### JSON: Get Competitor Response Example

Source: https://docs.octavehq.com/v2-api-reference/competitor/get-competitor

A sample JSON response for a successful 'Get Competitor' API request. It illustrates the structure and types of data returned, including metadata, timestamps, and detailed competitor attributes.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "data": {
    "businessModel": [
      "<string>"
    ],
    "comparativeStrengths": [
      "<string>"
    ],
    "comparativeWeaknesses": [
      "<string>"
    ],
    "keyDifferentiators": [
      "<string>"
    ],
    "reasonsWeWin": [
      "<string>"
    ],
    "customersWeWon": [
      "<string>"
    ],
    "customersWeSwitched": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "user": {
    "oId": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  },
  "shared": true
}
```

--------------------------------

### List Use Cases cURL Example

Source: https://docs.octavehq.com/v2-api-reference/use-case/list-use-cases

Example of how to call the List Use Cases API endpoint using cURL, including the necessary method, URL, and API key header.

```cURL
curl --request GET \
  --url https://app.octavehq.com/api/v2/use-case/list \
  --header 'api_key: <api-key>'
```

--------------------------------

### List Competitors Response Example

Source: https://docs.octavehq.com/v2-api-reference/competitor/list-competitors

Example JSON response structure for the List Competitors API endpoint, showing metadata and competitor data.

```JSON
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "hasNext": false,
  "total": 0,
  "data": [
    {
      "oId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "archivedAt": "<string>",
      "name": "<string>",
      "internalName": "<string>",
      "description": "<string>",
      "data": {
        "businessModel": [
          "<string>"
        ],
        "comparativeStrengths": [
          "<string>"
        ],
        "comparativeWeaknesses": [
          "<string>"
        ],
        "keyDifferentiators": [
          "<string>"
        ],
        "reasonsWeWin": [
          "<string>"
        ],
        "customersWeWon": [
          "<string>"
        ],
        "customersWeSwitched": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "user": {
        "oId": "<string>"
      },
      "workspace": {
        "oId": "<string>"
      },
      "shared": true
    }
  ]
}
```

--------------------------------

### Octave API - List Products Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for listing all available products.

```APIDOC
GET /v2-api-reference/product/list-products

**Description:** Retrieves a list of all available products.

**Parameters:** None.

**Response:** A list of product objects.
```

--------------------------------

### API Response Example (200 OK)

Source: https://docs.octavehq.com/v2-api-reference/segment/get-segment

Example JSON response when successfully retrieving segment data.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "data": {
    "fitExplanation": "<string>",
    "firmographics": {},
    "keyPriorities": [
      "<string>"
    ],
    "keyConsiderations": [
      "<string>"
    ],
    "uniqueApproach": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  },
  "unrecognized": true,
  "rejected": true
}
```

--------------------------------

### List Personas cURL Request Example

Source: https://docs.octavehq.com/v2-api-reference/persona/list-persona

Demonstrates how to make a GET request to the list personas endpoint using cURL. It includes the necessary URL, HTTP method, and an example API key header.

```curl
curl --request GET \
  --url https://app.octavehq.com/api/v2/persona/list \
  --header 'api_key: <api-key>'
```

--------------------------------

### cURL Request Example

Source: https://docs.octavehq.com/v2-api-reference/segment/get-segment

Example of how to call the Get Segment API endpoint using cURL.

```curl
curl --request GET \
  --url https://app.octavehq.com/api/v2/segment/get \
  --header 'api_key: <api-key>'
```

--------------------------------

### Create Reference API Example

Source: https://docs.octavehq.com/v2-api-reference/reference/create-reference

Demonstrates how to create a new reference using the Octave V2 API via cURL. Includes the request endpoint, method, headers, and a sample JSON payload.

```curl
curl --request POST \
  --url https://app.octavehq.com/api/v2/reference/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "productOId": "<string>",
  "url": "<string>",
  "companyName": "<string>",
  "companyDomain": "<string>",
  "details": "<string>"
}'
```

--------------------------------

### Octave API Segment Management

Source: https://docs.octavehq.com/v2-api-reference/segment/get-segment

Endpoints for retrieving and listing segments within the Octave platform. Includes detailed example for getting a specific segment.

```APIDOC
Segment:
  GET /api/v2/segment/get
    - Retrieves a specific segment by its identifier.
    - Example Request:
      curl --request GET \
        --url https://app.octavehq.com/api/v2/segment/get \
        --header 'api_key: <api-key>'
    - Example Response (200 OK):
      {
        "_metadata": {
          "usage": 0,
          "requestId": "requestId",
          "message": "message",
          "timestamp": "2021-01-01T00:00:00.000Z"
        },
        "oId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>",
        "archivedAt": "<string>",
        "name": "<string>",
        "internalName": "<string>",
        "description": "<string>",
        "data": {
          "fitExplanation": "<string>",
          "firmographics": {},
          "keyPriorities": ["<string>"],
          "keyConsiderations": ["<string>"],
          "uniqueApproach": ["<string>"],
          "customFields": [
            {
              "title": "<string>",
              "value": ["<string>"]
            }
          ]
        },
        "qualifyingQuestions": [
          {
            "question": "<string>",
            "rationale": "<string>",
            "fitType": "GOOD",
            "weight": "MEDIUM",
            "archivedAt": "<string>"
          }
        ],
        "user": {
          "oId": "<string>"
        },
        "workspace": {
          "oId": "<string>"
        },
        "unrecognized": true,
        "rejected": true
      }

  GET /v2-api-reference/segment/list-segments
    - Lists all segments available in the workspace.
```

--------------------------------

### Octave V2 API: Product Management

Source: https://docs.octavehq.com/v2-api-reference/reference/create-reference

Endpoints for retrieving and listing product information. Supports GET requests for single product details and multiple products.

```APIDOC
Product Management:
  GET Get Product: /v2-api-reference/product/get-product
    - Retrieves details for a specific product.
  GET List Products: /v2-api-reference/product/list-products
    - Retrieves a list of all available products.
```

--------------------------------

### Octave V2 API: Workspace

Source: https://docs.octavehq.com/v2-api-reference/playbook/create-playbook

Endpoint for managing workspace configurations, specifically for building workspace elements.

```APIDOC
Workspace API:

  POST /v2-api-reference/workspace/build
    - Builds or configures elements within the workspace using the Workspace Builder Agent.
```

--------------------------------

### Octave V2 API: Workspace Operations

Source: https://docs.octavehq.com/v2-api-reference/agents/template-agent

Endpoint for building workspace configurations.

```APIDOC
POST /v2-api-reference/workspace/build
  - Builds or configures workspace settings.
```

--------------------------------

### Run Prospector Agent (POST)

Source: https://docs.octavehq.com/v2-api-reference/agents/prospector-agent

Example cURL request to execute the Prospector Agent. It demonstrates how to send a POST request with the necessary API key and a JSON payload containing company domain and search context.

```curl
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/prospector/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{ \
  "companyDomain": "example.com", \
  "limit": 10, \
  "minimal": true, \
  "searchContext": { \
    "playbookOId": "<string>", \
    "personaOIds": [ \
      "<string>" \
    ], \
    "fuzzyTitles": [ \
      "<string>" \
    ], \
    "exactTitles": [ \
      "<string>" \
    ], \
    "excludeTitles": [ \
      "<string>" \
    ], \
    "personCountry": { \
      "matches": { \
        "exact": [ \
          "<string>" \
        ], \
        "contains": [ \
          "<string>" \
        ], \
        "prefix": [ \
          "<string>" \
        ] \
      }, \
      "excludes": { \
        "exact": [ \
          "<string>" \
        ], \
        "contains": [ \
          "<string>" \
        ], \
        "prefix": [ \
          "<string>" \
        ] \
      } \
    }, \
    "personLocation": { \
      "countryCode": { \
        "matches": { \
          "exact": [ \
            "<string>" \
          ], \
          "contains": [ \
            "<string>" \
          ], \
          "prefix": [ \
            "<string>" \
          ] \
        }, \
        "excludes": { \
          "exact": [ \
            "<string>" \
          ], \
          "contains": [ \
            "<string>" \
          ], \
          "prefix": [ \
            "<string>" \
          ] \
        } \
      }, \
      "city": { \
        "matches": { \
          "exact": [ \
            "<string>" \
          ], \
          "contains": [ \
            "<string>" \
          ], \
          "prefix": [ \
            "<string>" \
          ] \
        }, \
        "excludes": { \
          "exact": [ \
            "<string>" \
          ], \
          "contains": [ \
            "<string>" \
          ], \
          "prefix": [ \
            "<string>" \
          ] \
        } \
      }, \
      "text": { \
        "matches": { \
          "exact": [ \
            "<string>" \
          ], \
          "contains": [ \
            "<string>" \
          ], \
          "prefix": [ \
            "<string>" \
          ] \
        }, \
        "excludes": { \
          "exact": [ \
            "<string>" \
          ], \
          "contains": [ \
            "<string>" \
          ], \
          "prefix": [ \
            "<string>" \
          ] \
        } \
      } \
    } \
  }, \
  "agentOId": "agent_123" \
}'
```

--------------------------------

### Create Reference API Response Example

Source: https://docs.octavehq.com/v2-api-reference/reference/create-reference

Illustrates a successful (200 OK) response from the Create Reference API endpoint. Shows the structure of the returned reference object, including metadata and created data.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "r_1234",
  "name": "Large filesharing service",
  "internalName": "Dropbox",
  "createdAt": "2021-01-01",
  "updatedAt": "2021-01-01",
  "deletedAt": "2021-01-01",
  "archivedAt": "2021-01-01",
  "description": "Description of the reference",
  "data": {
    "howTheyMakeMoney": "<string>",
    "howTheyUseProduct": "<string>",
    "howTheyBenefitFromProduct": "<string>",
    "emailSnippets": [
      "<string>"
    ],
    "howWeImpactedTheirBusiness": [
      "<string>"
    ],
    "keyStats": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "user": {
    "oId": "u_1234"
  },
  "workspace": {
    "oId": "w_1234"
  },
  "unrecognized": false
}
```

--------------------------------

### Octave API - Get Competitor Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific competitor by its identifier.

```APIDOC
GET /v2-api-reference/competitor/get-competitor

**Description:** Retrieves details for a specific competitor.

**Parameters:** Requires a competitor identifier (e.g., `competitorOId`).

**Response:** A competitor object with detailed information.
```

--------------------------------

### Octave API - Get Segment Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific segment by its identifier.

```APIDOC
GET /v2-api-reference/segment/get-segment

**Description:** Retrieves details for a specific segment.

**Parameters:** Requires a segment identifier (e.g., `segmentOId`).

**Response:** A segment object with detailed information.
```

--------------------------------

### Octave API - Get Product Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific product by its identifier.

```APIDOC
GET /v2-api-reference/product/get-product

**Description:** Retrieves details for a specific product.

**Parameters:** Requires a product identifier (e.g., `productOId`).

**Response:** A product object with detailed information.
```

--------------------------------

### Octave API: Product Management

Source: https://docs.octavehq.com/v2-api-reference/agents/sequence-agent

Handles retrieval of product information and listing of all products. This API allows access to product catalogs and details.

```APIDOC
Product API:

GET /v2-api-reference/product/get-product
  Description: Retrieves details for a specific product.

GET /v2-api-reference/product/list-products
  Description: Lists all available products.
```

--------------------------------

### Octave V2 API: Product Management

Source: https://docs.octavehq.com/v2-api-reference/agents/template-agent

Endpoints for retrieving and listing product information.

```APIDOC
GET /v2-api-reference/product/get-product
  - Retrieves details for a specific product.

GET /v2-api-reference/product/list-products
  - Lists all available products.
```

--------------------------------

### Octave API - Get Reference Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific reference by its identifier.

```APIDOC
GET /v2-api-reference/reference/get-reference

**Description:** Retrieves details for a specific reference.

**Parameters:** Requires a reference identifier (e.g., `referenceOId`).

**Response:** A reference object with detailed information.
```

--------------------------------

### Octave API - Get Playbook Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific playbook by its identifier.

```APIDOC
GET /v2-api-reference/playbook/get-playbook

**Description:** Retrieves details for a specific playbook.

**Parameters:** Requires a playbook identifier (e.g., `playbookOId`).

**Response:** A playbook object with detailed information.
```

--------------------------------

### List Products

Source: https://docs.octavehq.com/v2-api-reference/async/run-agent

Retrieves a list of all available products. This endpoint provides an overview of all defined products.

```APIDOC
GET /v2-api-reference/product/list-products

Lists products.
```

--------------------------------

### Octave API - Create Playbook Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the POST request for creating a new playbook.

```APIDOC
POST /v2-api-reference/playbook/create-playbook

**Description:** Creates a new playbook.

**Request Body:** Requires parameters defining the new playbook's configuration.
```

--------------------------------

### Octave API - Get Persona Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific persona by its identifier.

```APIDOC
GET /v2-api-reference/persona/get-persona

**Description:** Retrieves details for a specific persona.

**Parameters:** Requires a persona identifier (e.g., `personaOId`).

**Response:** A persona object with detailed information.
```

--------------------------------

### Octave V2 Product API

Source: https://docs.octavehq.com/v2-api-reference/playbook/get-playbook

Endpoints for retrieving and listing product information.

```APIDOC
Product API:

GET /v2-api-reference/product/get-product
  Description: Retrieves details for a specific product.

GET /v2-api-reference/product/list-products
  Description: Lists all available products.
```

--------------------------------

### Octave API - Get Use Case Endpoint

Source: https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent

This section details the GET request for retrieving a specific use case by its identifier.

```APIDOC
GET /v2-api-reference/use-case/get-use-case

**Description:** Retrieves details for a specific use case.

**Parameters:** Requires a use case identifier (e.g., `useCaseOId`).

**Response:** A use case object with detailed information.
```

--------------------------------

### Octave V2 API: Product Management

Source: https://docs.octavehq.com/v2-api-reference/playbook/create-playbook

Endpoints for retrieving and listing product information within the Octave platform.

```APIDOC
Product API:

  GET /v2-api-reference/product/get-product
    - Retrieves details for a specific product.

  GET /v2-api-reference/product/list-products
    - Retrieves a list of all available products.
```

--------------------------------

### Get Playbook API Request with cURL

Source: https://docs.octavehq.com/v2-api-reference/playbook/get-playbook

This cURL command demonstrates how to make a GET request to the OctaveHQ API to retrieve a playbook. It requires an 'api_key' in the request header for authentication.

```curl
curl --request GET \
  --url https://app.octavehq.com/api/v2/playbook/get \
  --header 'api_key: <api-key>'
```

--------------------------------

### Octave V2 API: Use Case Management

Source: https://docs.octavehq.com/v2-api-reference/reference/create-reference

Endpoints for retrieving and listing use cases. Supports GET requests for single use case details and multiple use cases.

```APIDOC
Use Case Management:
  GET Get Use Case: /v2-api-reference/use-case/get-use-case
    - Retrieves details for a specific use case.
  GET List Use Cases: /v2-api-reference/use-case/list-use-cases
    - Retrieves a list of all available use cases.
```

--------------------------------

### Octave API v2: List Products

Source: https://docs.octavehq.com/v2-api-reference/api-key/list-api-keys

Retrieves a list of all available products. This allows users to view and manage the products or services offered by Octave.

```APIDOC
GET /v2-api-reference/product/list-products

This endpoint retrieves a list of products.
```

--------------------------------

### Octave V2 API: Workspace

Source: https://docs.octavehq.com/v2-api-reference/reference/create-reference

Provides functionality for building and managing workspaces. Includes an endpoint for the Workspace Builder Agent.

```APIDOC
Workspace:
  POST Workspace Builder Agent: /v2-api-reference/workspace/build
    - Utilizes the Workspace Builder Agent to construct or manage workspaces.
```

--------------------------------

### OctaveHQ API: Get Segment

Source: https://docs.octavehq.com/v2-api-reference/segment/get-segment

Retrieves a specific segment from OctaveHQ by its unique Object ID (OId). Requires an API key for authorization. The endpoint supports GET requests and expects the 'oId' as a query parameter.

```APIDOC
GET /api/v2/segment/get

Parameters:
  Query Parameters:
    oId (string, required): Segment OId
  Headers:
    api_key (string, required): API key for authentication

Responses:
  200: Segment data (application/json)
  400: Error response

Response Schema (200):
{
  "_metadata": {
    "usage": "<integer>",
    "requestId": "<string>",
    "message": "<string>",
    "timestamp": "<string>"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "name": "<string>",
  "internalName": "<string>",
  "description": "<string>",
  "data": {
    "fitExplanation": "<string>",
    "firmographics": {},
    "keyPriorities": [
      "<string>"
    ],
    "keyConsiderations": [
      "<string>"
    ],
    "uniqueApproach": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "qualifyingQuestions": [
    {
      "question": "<string>",
      "rationale": "<string>",
      "fitType": "GOOD",
      "weight": "MEDIUM",
      "archivedAt": "<string>"
    }
  ],
  "user": {
    "oId": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  },
  "unrecognized": "<boolean>",
  "rejected": "<boolean>"
}
```

--------------------------------

### APIDOC: Get Playbook Endpoint and Response Structure

Source: https://docs.octavehq.com/v2-api-reference/playbook/get-playbook

Details the GET request for retrieving playbook information from the OctaveHQ v2 API. Includes the cURL command for execution and a comprehensive JSON structure representing the playbook data, its associated product, buyer personas, use cases, and references.

```curl
curl --request GET \
  --url https://app.octavehq.com/api/v2/playbook/get \
  --header 'api_key: <api-key>'
```

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "<string>",
    "message": "<string>",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "oId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "archivedAt": "<string>",
  "name": "<string>",
  "description": "<string>",
  "data": {
    "explanation": "<string>",
    "attributes": {},
    "icpConcerns": [],
    "icpPriorities": [],
    "keyInsight": [],
    "statusQuo": [],
    "differentiatedValue": [],
    "exampleDomains": [],
    "exampleDescription": "",
    "approachAngle": [
      "<string>"
    ],
    "strategicNarrative": [
      "<string>"
    ],
    "customFields": [
      {
        "title": "<string>",
        "value": [
          "<string>"
        ]
      }
    ]
  },
  "shared": true,
  "type": "LEGACY",
  "status": "active",
  "referenceMode": "specific",
  "proofPointMode": "none",
  "user": {
    "oId": "<string>"
  },
  "workspace": {
    "oId": "<string>"
  },
  "product": {
    "oId": "<string>",
    "name": "<string>",
    "data": {
      "summary": "<string>",
      "capabilities": [
        "Capability 1",
        "Capability 2"
      ],
      "customerBenefits": [
        "Benefit 1",
        "Benefit 2"
      ],
      "challengesAddressed": [
        "Challenge 1",
        "Challenge 2"
      ],
      "differentiatedValue": [
        "Differentiated Value 1",
        "Differentiated Value 2"
      ],
      "statusQuo": [
        "Status Quo 1",
        "Status Quo 2"
      ],
      "customFields": [
        {
          "title": "<string>",
          "value": [
            "<string>"
          ]
        }
      ]
    },
    "description": "<string>"
  },
  "buyerPersonas": [
    {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "hypotheses": [
        {
          "oId": "<string>",
          "createdAt": "<string>",
          "archivedAt": "<string>",
          "deletedAt": "<string>",
          "updatedAt": "<string>",
          "title": "<string>",
          "details": "<string>",
          "context": "<string>",
          "persona": {
            "name": "<string>",
            "oId": "<string>"
          },
          "playbook": {
            "name": "<string>",
            "oId": "<string>"
          },
          "user": {
            "name": "<string>",
            "oId": "<string>"
          }
        }
      ],
      "data": {
        "primaryResponsibilities": [
          "Responsibility 1",
          "Responsibility 2"
        ],
        "painPoints": [
          "Pain Point 1",
          "Pain Point 2"
        ],
        "keyConcerns": [
          "Concern 1",
          "Concern 2"
        ],
        "keyObjectives": [
          "Objective 1",
          "Objective 2"
        ],
        "commonJobTitles": [
          "Job Title 1",
          "Job Title 2"
        ],
        "whyTheyMatterToUs": [
          "Reason 1",
          "Reason 2"
        ],
        "whyWeMatterToThem": [
          "Reason 1",
          "Reason 2"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "useCases": [
    {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "data": {
        "summary": "<string>",
        "scenarios": [
          "<string>"
        ],
        "desiredOutcomes": [
          "<string>"
        ],
        "businessDrivers": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "sequenceTemplates": [
    {
      "oId": "<string>",
      "name": "<string>",
      "persona": {
        "oId": "<string>",
        "name": "<string>"
      },
      "status": "active"
    }
  ],
  "references": [
    {
      "oId": "<string>",
      "name": "<string>",
      "data": {
        "howTheyMakeMoney": "<string>",
        "howTheyUseProduct": "<string>",
        "howTheyBenefitFromProduct": "<string>",
        "emailSnippets": [
          "<string>"
        ],
        "howWeImpactedTheirBusiness": [
          "<string>"
        ],
        "keyStats": [
          "<string>"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "description": "<string>"
    }
  ],
  "segment": {
    "oId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "data": "<any>"
  }
}
```

--------------------------------

### List Competitors cURL Request

Source: https://docs.octavehq.com/v2-api-reference/competitor/list-competitors

Example cURL command to list competitors using the OctaveHQ v2 API. Requires an API key for authorization.

```cURL
curl --request GET \
  --url https://app.octavehq.com/api/v2/competitor/list \
  --header 'api_key: <api-key>'
```

--------------------------------

### Octave v2 API: Product Management

Source: https://docs.octavehq.com/v2-api-reference/use-case/get-use-case

Reference for Octave v2 API endpoints for retrieving and listing product information.

```APIDOC
##### Product
* [GET Get Product](/v2-api-reference/product/get-product)
* [GET List Products](/v2-api-reference/product/list-products)
```
Tokens:
Raw