### cURL Example for Listing Personas

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

Example command to fetch a list of personas using cURL, demonstrating the GET request, URL, and required API key header.

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

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

### cURL Request for Get Product

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

Example cURL command to fetch product data from the OctaveHQ API.

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

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

### cURL Example for Listing Use Cases

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

A practical example demonstrating how to call the 'List Use Cases' API endpoint using cURL, including the necessary headers and URL.

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

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

### Octave 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 API via cURL. Includes the request method, URL, and required headers.

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

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

### List Competitors Example

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

Example cURL request to list competitors and the structure of the response.

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

```APIDOC
Response Structure (200 OK):
{
  "_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
    }
  ]
}
```

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

### cURL Request Example

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

This example demonstrates how to call the Call Prep Agent API using cURL. It includes the necessary headers, the POST request method, the endpoint URL, and a sample JSON payload.

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

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

### Octave API v2 Get Reference Example

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

Example cURL request and JSON response for fetching reference data.

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

Response Codes:
200: Success
400: Bad Request
404: Not Found

Example JSON Response (200 OK):
{
  "_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
}
```

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

### Example cURL Request to Create Reference

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

A practical example demonstrating how to call the 'Create Reference' API endpoint using cURL, including necessary 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>"
}'
```

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

### Workspace Setup API

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

Defines the API endpoint for generating and building a workspace. It details authorization requirements, the expected JSON request body, and successful response codes.

```APIDOC
#### Authorizations

[​](#authorization-api-key)

api_key

string

header

required

#### Body

application/json

Generate and build a Workspace input

The body is of type `object`.

#### Response

200

200400

application/json

Workspace setup successful

The response is of type `object`.
```

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

### List Segments cURL Example

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

Example cURL command to fetch segments from the OctaveHQ API, including the necessary API key.

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

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

### List References cURL Example

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

This cURL command demonstrates how to make a GET request to the List References API endpoint, including the necessary API key in the header.

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

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

### cURL Example for Get Playbook

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

Demonstrates how to make a GET request to the OctaveHQ API to retrieve playbook data using cURL. Includes the necessary URL and header for API key authentication.

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

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

### Qualify Person Agent Response Example (Success)

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

Example JSON response for a successful qualification request, detailing metadata, qualification status, and comprehensive data about the person, product, persona, and segment.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "person": {
      "firstName": "<string>",
      "lastName": "<string>",
      "title": "<string>",
      "profileUrl": "<string>",
      "company": {
        "name": "<string>",
        "description": "<string>",
        "domain": "example.com",
        "website": "<string>",
        "founded": 123,
        "location": {
          "region": "<string>",
          "locality": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>",
          "streetAddress": "<string>"
        },
        "employeeCount": 123,
        "followerCount": 123,
        "type": "<string>",
        "slug": "<string>",
        "logoUrl": "<string>",
        "countryCode": "<string>",
        "specialties": [
          "<string>"
        ],
        "industry": "<string>",
        "crunchBaseFunding": [
          {
            "fundingRoundCount": 123,
            "roundDate": "<string>",
            "roundName": "<string>",
            "investorNames": [
              "<string>"
            ],
            "investorCount": 123,
            "roundAmount": 123,
            "roundCurrency": "<string>"
          }
        ]
      },
      "companyName": "<string>",
      "companyDomain": "example.com",
      "companyFoundedYear": 123,
      "companyEmployeeCount": 123,
      "companyDescription": "<string>",
      "headline": "<string>",
      "summary": "<string>",
      "slug": "<string>",
      "internalPictureUrl": "<string>",
      "countryCode": "<string>",
      "location": "<string>",
      "city": "<string>",
      "currentJobFunction": "<string>",
      "currentSeniority": "<string>",
      "followers": 123,
      "allPositionsCount": 123,
      "currentPositionsCount": 123,
      "positions": [
        {
          "companyName": "<string>",
          "title": "<string>",
          "summary": "<string>",
          "is_current": false,
          "startDate": "<string>",
          "endDate": "<string>",
          "seniority": "<string>",
          "jobFunction": "<string>",
          "company": {
            "name": "<string>",
            "domain": "<string>",
            "founded": 123,
            "employeeCount": 123,
            "description": "<string>",
            "location": {
              "region": "<string>",
              "locality": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "streetAddress": "<string>"
            },
            "slug": "<string>"
          }
        }
      ]
    },
    "score": 123,
    "product": {
      "message": "<string>",
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualification": {
        "answers": [
          {
            "answer": "<string>",
            "rationale": "<string>",
            "confidence": "LOW",
            "question": "<string>"
          }
        ],
        "score": 123,
        "rationale": "<string>"
      }
    },
    "persona": {
      "message": "<string>",
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualification": {
        "answers": [
          {
            "answer": "<string>",
            "rationale": "<string>",
            "confidence": "LOW",
            "question": "<string>"
          }
        ],
        "score": 123,
        "rationale": "<string>"
      }
    },
    "segment": {
      "message": "<string>",
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualification": {
        "answers": [
          {
            "answer": "<string>",
            "rationale": "<string>",
            "confidence": "LOW",
            "question": "<string>"
          }
        ],
        "score": 123,
        "rationale": "<string>"
      }
    }
  }
}
```

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

### Example JSON Response for Created Reference

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

Illustrates the structure and typical content of a successful JSON response when a reference is created via the API.

```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 - List References Example

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

Example of how to list references using the Octave API with cURL, including request headers and response structure.

```APIDOC
Endpoint: GET /api/v2/reference/list

Description: Retrieves a list of references.

Request:
  Headers:
    api_key: <api-key> (Required) - Your authentication token.

  Example (cURL):
    curl --request GET \
      --url https://app.octavehq.com/api/v2/reference/list \
      --header 'api_key: <api-key>'

Response (200 OK):
  Content-Type: application/json
  Body:
    {
      "_metadata": {
        "usage": 0,
        "requestId": "requestId",
        "message": "message",
        "timestamp": "2021-01-01T00:00:00.000Z"
      },
      "data": [
        {
          "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
        }
      ],
      "total": 123
    }

Response (400 Bad Request):
  Indicates an issue with the request, such as an invalid API key.
```

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

### Qualify Person Agent Request Example

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

Example cURL command to send a request to the Qualify Person Agent API, including necessary headers and a sample JSON payload.

```bash
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/qualify-person/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": "<string>", \
  "agentOId": "agent_123" \
}'
```

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

### Octave API: Playbook - Get Playbook

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

Retrieves details for a specific playbook. This endpoint allows fetching a single playbook's configuration and associated steps.

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

Description:
  Retrieves a specific playbook.

Example Usage:
  Requires a playbook identifier to fetch its details.
```

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

### List Products API Endpoint

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

Details the GET request to list products from the OctaveHQ API. Includes authorization, query parameters, and response structure. Supports filtering and pagination.

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

```APIDOC
GET /api/v2/product/list

-- Authorization --
api_key: string (header, required)

-- Query Parameters --
text: string (optional)
  Description: Text to filter products by.
limit: number | null (optional, default: 10)
  Description: Maximum number of products to return.
offset: number | null (optional, default: 0)
  Description: Number of products to skip.
queryType: enum<string> (optional, default: ALL)
  Description: Type of query. Available options: `ALL`, `TEAM`, `MINE`.
productOId: string (optional)
  Description: Filter products by their OId.

-- Response --
200 OK
Content-Type: application/json

{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "total": 123,
  "data": [
    {
      "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"
      }
    }
  ]
}

-- Related Endpoints --
[Get Product](/v2-api-reference/product/get-product)
[Get Segment](/v2-api-reference/segment/get-segment)
```

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

### cURL Example for Get Persona

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

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

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

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

### cURL Request Example

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

Example of how to make a GET request to the OctaveHQ API to retrieve a segment using cURL.

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

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

### Octave API: Product Management

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

Endpoints for retrieving and listing product information.

```APIDOC
Product Management:
  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 Segment Example

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

Demonstrates how to retrieve a specific segment using the Octave API. It includes a cURL request example and the expected JSON response structure for a successful retrieval.

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

```APIDOC
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
}

Response (400 Bad Request):
(Details not provided in source text, but implies error handling for invalid requests)
```

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

### Workspace API Endpoints

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

Provides functionality for building and managing workspaces.

```APIDOC
Workspace API:

POST /workspace/build
  Builds or updates a workspace using the Workspace Builder Agent.
```

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

### Get Competitor cURL Request

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

Example cURL command to fetch competitor data from the OctaveHQ API.

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

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

### Create Playbook Response (200 OK)

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

Example JSON response for a successful playbook creation. It includes metadata such as usage, request ID, and timestamp, along with details of the created playbook, its associated personas, and templates.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "playbook": {
    "oId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "LEGACY",
    "keyInsight": [
      "<string>"
    ]
  },
  "personas": [
    {
      "oId": "p_1234",
      "name": "VP of Sales",
      "internalName": "Sally the Sales Leader",
      "description": "<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>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "activeSequences": 123,
      "sentEmails": 123,
      "valueProps": [
        {
          "title": "<string>",
          "details": "<string>",
          "evidence": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "templates": [
    [
      {
        "oId": "<string>",
        "name": "<string>",
        "persona": {
          "oId": "<string>",
          "name": "<string>"
        },
        "status": "active"
      }
    ]
  ]
}
```

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

### List Competitors cURL Request

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

Example cURL command to list competitors. It specifies the GET request method, the API endpoint URL, and the required 'api_key' header for authorization.

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

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

### Octave API - Product Management

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

Endpoints for retrieving and listing products.

```APIDOC
Product API:

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

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

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

### Build Workspace using cURL

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

Example cURL command to interact with the Workspace Builder API to create a new workspace. It demonstrates the POST request method, endpoint URL, and the required JSON payload structure for workspace and offering details.

```curl
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/workspace/build \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "workspace": {
    "name": "Octave",
    "url": "https://octave.com",
    "addExistingUsers": true,
    "agentOIds": [
      "agent_oid1",
      "agent_oid2"
    ]
  },
  "offering": {
    "name": "Octave",
    "additionalUrls": [
      "<string>"
    ],
    "statusQuo": "<string>",
    "differentiatedValue": "Octave",
    "references": [
      {
        "url": "<string>",
        "details": "<string>"
      }
    ]
  },
  "runtimeContext": "<any>"
}'
```

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

### Validate API Key Request Example

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

Example cURL command to validate an API key.

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

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

### Octave API - Workspace

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

Endpoint for building and managing workspaces.

```APIDOC
Workspace API:

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

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

### Validate API Key Response Example

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

Example JSON response for a successful API key validation.

```json
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "status": "ok",
  "valid": true,
  "credits": {
    "totalUsed": 175,
    "totalRemaining": 425,
    "totalMax": 575,
    "quotaUsed": 150,
    "quotaAvailable": 350,
    "quotaMax": 500,
    "period": "month",
    "creditsUsed": 25,
    "creditsAvailable": 75
  }
}
```

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

### Create Playbook using cURL

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

Example command to create a playbook using cURL. This demonstrates how to send a POST request to the API endpoint with the necessary API key in the header and a JSON payload containing the playbook configuration.

```curl
curl --request POST \
  --url https://app.octavehq.com/api/v2/playbook/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{ \
  "name": "<string>", \
  "description": "<string>", \
  "keyInsight": "<string>", \
  "type": "LEGACY", \
  "context": "<string>", \
  "personaOIds": [ \
    "<string>" \
  ], \
  "useCaseOIds": [ \
    "<string>" \
  ], \
  "competitorOId": "<string>", \
  "segmentOId": "<string>", \
  "proofPointOIds": [ \
    "<string>" \
  ], \
  "referenceOIds": [ \
    "<string>" \
  ], \
  "createTemplates": true, \
  "productOId": "<string>", \
  "status": "active", \
  "referenceMode": "specific", \
  "proofPointMode": "none", \
  "model": "ECHO", \
  "additionalContextSources": [ \
    { \
      "type": "URL", \
      "value": "https://example.com/market-research" \
    }, \
    { \
      "type": "TEXT", \
      "value": "Additional market insights about the target segment." \
    } \
  ] \
}'
```

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

### Get Competitor API Endpoint

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

Details for the GET /api/v2/competitor/get endpoint, including authorization, query parameters, and response structure.

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

Description: Retrieves a specific competitor's data by its unique identifier (OId).

Authorization:
  - api_key: string, header, required

Query Parameters:
  - oId: string, required. Competitor OId.

Response:
  - 200: Competitor data (object)
    - _metadata: object
      - usage: number
      - requestId: string
      - message: string
      - timestamp: string (ISO 8601 format)
    - oId: string
    - createdAt: string (ISO 8601 format)
    - updatedAt: string (ISO 8601 format)
    - deletedAt: string (ISO 8601 format, nullable)
    - archivedAt: string (ISO 8601 format, nullable)
    - name: string
    - internalName: string
    - description: string
    - data: object
      - businessModel: array of strings
      - comparativeStrengths: array of strings
      - comparativeWeaknesses: array of strings
      - keyDifferentiators: array of strings
      - reasonsWeWin: array of strings
      - customersWeWon: array of strings
      - customersWeSwitched: array of strings
      - customFields: array of objects
        - title: string
        - value: array of strings
    - user: object
      - oId: string
    - workspace: object
      - oId: string
    - shared: boolean
  - 400: Bad Request (details not specified)

Related Methods:
  - List segments: GET /v2-api-reference/segment/list-segments
  - List competitors: GET /v2-api-reference/competitor/list-competitors
```

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

### Octave API: Product - List Products

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

Retrieves a list of all available products. This endpoint provides an overview of all products managed by Octave.

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

Description:
  Lists all available products.

Example Usage:
  Returns a collection of product objects.
```

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

### Octave API: Use Case Management

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

Endpoints for retrieving and listing use case information.

```APIDOC
Use Case Management:
  GET /v2-api-reference/use-case/get-use-case
    - Retrieves details for a specific use case.

  GET /v2-api-reference/use-case/list-use-cases
    - Lists all available use cases.
```

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

### Octave API: Playbook - Create Playbook

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

Creates a new playbook. This endpoint allows users to define and save new playbook configurations.

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

Description:
  Creates a new playbook.

Example Usage:
  Requires playbook definition data in the request body.
```

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

### Octave API - Get Use Case Endpoint Details

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

Details the GET endpoint for retrieving a specific use case by its OId. Includes the HTTP method, path, and a brief description.

```APIDOC
Use Case:
  GET Get Use Case: /api/v2/use-case/get
    Description: Get Use Case by OId
```

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

### Octave API - Call Prep Agent Response (Success)

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

Example of a successful response (HTTP 200) from the Call Prep Agent. It includes metadata, a success message, and detailed data for call preparation, such as discovery questions, call scripts, and relevant case studies.

```JSON
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "discoveryQuestions": [],
    "callScript": "<string>",
    "personBrief": "<string>",
    "companyBrief": "<string>",
    "objectionHandling": "<string>",
    "relevantCaseStudies": [
      {
        "whyIsThisRelevant": [
          "<string>"
        ],
        "keyPointsToFocusOn": [
          "<string>"
        ],
        "keyDifferences": [
          "<string>"
        ],
        "snippet": "<string>",
        "referenceCustomerName": "<string>",
        "matchConfidence": "LOW",
        "matchAnalysis": "<string>"
      }
    ],
    "product": {
      "name": "<string>",
      "oId": "<string>",
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "playbook": {
      "name": "<string>",
      "oId": "<string>",
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "persona": {
      "name": "<string>",
      "oId": "<string>",
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "useCases": [
      {
        "name": "<string>",
        "oId": "<string>",
        "matchConfidence": "LOW",
        "matchAnalysis": "<string>"
      }
    ],
    "referenceCustomers": [
      {
        "name": "<string>",
        "oId": "<string>",
        "matchConfidence": "LOW",
        "matchAnalysis": "<string>"
      }
    ],
    "resultUrl": "<string>"
  }
}
```

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

### Use Case API Endpoints

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

Endpoints for retrieving and listing use case information.

```APIDOC
Use Case API:

GET /use-case/get-use-case
  Retrieves details for a specific use case.

GET /use-case/list-use-cases
  Retrieves a list of all available use cases.
```

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

### Octave API: Competitor Management

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

Endpoints for retrieving and listing competitor information.

```APIDOC
Competitor Management:
  GET /v2-api-reference/competitor/get-competitor
    - Retrieves details for a specific competitor.

  GET /v2-api-reference/competitor/list-competitors
    - Lists all available competitors.
```

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

### List Competitors JSON Response Example

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

Example JSON structure for a successful response when listing competitors. It includes metadata like usage and request ID, pagination information (hasNext, total), and the 'data' array containing competitor objects.

```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 V2 API: Segment Management

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

Endpoints for retrieving and listing segment information, including an example for listing segments.

```APIDOC
Segment:
  GET /v2-api-reference/segment/get-segment
    - Retrieves details for a specific segment.
    - Requires segment identifier.

  GET /v2-api-reference/segment/list-segments
    - Fetches a list of all segments.
    - Example Request:
      curl --request GET \
        --url https://app.octavehq.com/api/v2/segment/list \
        --header 'api_key: <api-key>'
    - Example Response (200 OK):
      {
        "_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": {
              "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
          }
        ]
      }
```

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

### Octave Async and Workspace APIs

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

Endpoints for running agents asynchronously and building workspaces.

```APIDOC
Async and Workspace API:

POST /v2-api-reference/async/run-agent
  Description: Initiates an agent task asynchronously.
  Parameters: Agent identifier and task payload.
  Returns: Asynchronous task ID.

POST /v2-api-reference/workspace/build
  Description: Builds or modifies a workspace using the Workspace Builder Agent.
  Parameters: Workspace configuration and data payload.
  Returns: Workspace build status or details.
```

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

### Get Product API Endpoint

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

Details for retrieving a product by its OId. Includes authorization, query parameters, and response structure.

```APIDOC
GET /api/v2/product/get
  Description: Get Product by OId
  Authorization:
    api_key: string (header, required)
  Query Parameters:
    oId: string (required) - Product OId
  Responses:
    200: application/json - Product data
      Content:
        _metadata: object
          usage: number
          requestId: string
          message: string
          timestamp: string
        oId: string
        createdAt: string
        updatedAt: string
        archivedAt: string
        deletedAt: string
        name: string
        internalName: string
        description: string
        primaryUrl: string
        data: object
          summary: string
          capabilities: array of strings
          customerBenefits: array of strings
          challengesAddressed: array of strings
          differentiatedValue: array of strings
          statusQuo: array of strings
          customFields: array of objects
            title: string
            value: array of strings
        qualifyingQuestions: array of objects
          question: string
          rationale: string
          fitType: string (e.g., GOOD)
          weight: string (e.g., MEDIUM)
          archivedAt: string
        user: object
          oId: string
        workspace: object
          oId: string
    400: Bad Request
    404: Not Found
```

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

### Octave API - Products

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

Endpoints for retrieving and listing product information.

```APIDOC
Product API:

  Get Product:
    GET /v2-api-reference/product/get-product
    Parameters:
      - productId: The unique identifier for the product.
    Description: Retrieves details for a specific product.

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

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

### Octave Workspace API

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

Endpoint for building and managing workspace configurations.

```APIDOC
POST /v2-api-reference/workspace/build
  - Builds or updates workspace configurations.
```