# Octave API

## Docs

- [What are Alternatives in Octave?](https://docs.octavehq.com/concepts/alternatives.md): Alternatives capture non-product substitutes like manual processes, status quo, or in-house builds. Fight 'do nothing' objections.
- [How does Octave learn from your conversations?](https://docs.octavehq.com/concepts/analytics.md): Octave analyzes sales calls, emails, and deal outcomes to surface insights and keep your GTM strategy in sync with buyers.
- [What are Buying Triggers in Octave?](https://docs.octavehq.com/concepts/buying-triggers.md): Buying Triggers are signals like funding rounds, leadership changes, and tech migrations that indicate a prospect is ready to buy.
- [What are Competitors in Octave?](https://docs.octavehq.com/concepts/competitors.md): Store strengths, weaknesses, win/loss reasons, and differentiation points. Agents use Competitors for competitive positioning.
- [What is the Octave Library?](https://docs.octavehq.com/concepts/library.md): The Octave Library stores your GTM strategy as interconnected entities that AI agents query at runtime. Learn how it works.
- [What are Offerings in Octave?](https://docs.octavehq.com/concepts/offerings.md): Offerings represent your products and services in the Octave Library. Every persona, use case, and playbook connects back to one.
- [How do Personas work in Octave?](https://docs.octavehq.com/concepts/personas.md): Personas store pain points, goals, and messaging guidance for your target buyers. Agents use them to personalize every interaction.
- [How do Octave Playbooks work?](https://docs.octavehq.com/concepts/playbooks.md): Playbooks combine personas, use cases, proof points, and competitors into executable sales strategies that agents use at runtime.
- [What are Proof Points in Octave?](https://docs.octavehq.com/concepts/proof-points.md): Proof Points are stats, awards, and customer outcomes that validate your product. Agents weave them into messaging to build credibility.
- [What are Reference Customers in Octave?](https://docs.octavehq.com/concepts/references.md): References are customer success stories with outcomes and testimonials. Agents cite them in outreach to build trust with similar prospects.
- [What are Segments in Octave?](https://docs.octavehq.com/concepts/segments.md): Segments define target market groups by industry, company size, and other firmographics. Agents use them to tailor messaging and prioritize accounts.
- [What are Use Cases in Octave?](https://docs.octavehq.com/concepts/use-cases.md): Use Cases describe the problems your product solves. Agents match prospects to the right messaging based on their specific scenario.
- [Octave API Documentation](https://docs.octavehq.com/introduction.md): Build AI-powered GTM workflows with the Octave API. Run agents, manage personas, and generate context-aware content programmatically.
- [Available Tools](https://docs.octavehq.com/mcp/available-tools.md): Complete reference of 50+ MCP tools for research, content generation, pipeline analysis, CRM access, and knowledge base management.
- [Claude Code](https://docs.octavehq.com/mcp/claude-code.md): Set up the Octave MCP server and LFGTM plugin in Claude Code for GTM research, content generation, and pipeline tools.
- [Claude Desktop](https://docs.octavehq.com/mcp/claude-desktop.md): Connect Octave to Claude Desktop using a custom connector or remote MCP config
- [Cursor](https://docs.octavehq.com/mcp/cursor.md): Set up the Octave MCP server in Cursor to give your AI assistant access to your GTM knowledge base and agents.
- [Other Editors](https://docs.octavehq.com/mcp/other-editors.md): Connect Octave to VS Code, Zed, Windsurf, and other MCP-compatible editors
- [Octave MCP](https://docs.octavehq.com/mcp/overview.md): Connect your Octave workspace to Claude, Cursor, and other AI tools via MCP. Access your GTM knowledge base directly from your editor.
- [Quickstart](https://docs.octavehq.com/quickstart.md): Make your first Octave API call in under 5 minutes. Get your API key, run an agent, and see results.
- [Call Prep Agent](https://docs.octavehq.com/v2-api-reference/agents/call-prep-agent.md): Generate call prep content including discovery questions, call scripts, and objection handling
- [Content Agent](https://docs.octavehq.com/v2-api-reference/agents/content-agent.md): Provide either `agentOId` or `experimentOId` depending on what you want to run. - Use `agentOId` to run a specific agent. - Use `experimentOId` to run a specific experiment.
- [Enrich Company Agent](https://docs.octavehq.com/v2-api-reference/agents/enrich-company-agent.md): Enrich a company
- [Enrich Person Agent](https://docs.octavehq.com/v2-api-reference/agents/enrich-person-agent.md): Enrich a Person
- [List Agent Types](https://docs.octavehq.com/v2-api-reference/agents/list-agent-types.md): List all available agent types with their metadata
- [List Agents](https://docs.octavehq.com/v2-api-reference/agents/list-agents.md): List all agents
- [Prospector Agent](https://docs.octavehq.com/v2-api-reference/agents/prospector-agent.md): Find relevant people at a company or lookalike companies
- [Qualify Company Agent](https://docs.octavehq.com/v2-api-reference/agents/qualify-company-agent.md): Determine if a company is qualified for a given Product and/or Segment
- [Qualify Person Agent](https://docs.octavehq.com/v2-api-reference/agents/qualify-person-agent.md): Determine if a person is qualified for a given Product, Persona, and/or Segment
- [Sequence Agent](https://docs.octavehq.com/v2-api-reference/agents/sequence-agent.md): Provide either `agentOId` or `experimentOId` depending on what you want to run. - Use `agentOId` to run a specific agent. - Use `experimentOId` to run a specific experiment. Only one of them should be set at a time.
- [Create Alternative](https://docs.octavehq.com/v2-api-reference/alternative/create-alternative.md): Create a new alternative (status quo / incumbent / DIY pattern)
- [Delete Alternative](https://docs.octavehq.com/v2-api-reference/alternative/delete-alternative.md): Soft delete a Alternative by OId. The alternative will be marked as deleted but not permanently removed.
- [Generate Alternatives](https://docs.octavehq.com/v2-api-reference/alternative/generate-alternatives.md): Generate status quo / incumbent alternative analysis from source materials using AI.
- [Get Alternative](https://docs.octavehq.com/v2-api-reference/alternative/get-alternative.md): Get Alternative by OId
- [List alternatives](https://docs.octavehq.com/v2-api-reference/alternative/list-alternatives.md): List alternatives with optional filtering and pagination
- [Update Alternative](https://docs.octavehq.com/v2-api-reference/alternative/update-alternative.md): Update an existing alternative
- [Log Event](https://docs.octavehq.com/v2-api-reference/analytics/receive-generic-webhook-events.md): Log emails, calls, CRM, and social data from custom integrations (n8n, Clay, Make, etc.).
- [List API keys](https://docs.octavehq.com/v2-api-reference/api-key/list-api-keys.md): This endpoint returns a list of API keys. Rate limited to 1000 requests per minute.
- [Validate API key](https://docs.octavehq.com/v2-api-reference/api-key/validate-api-key.md): This endpoint validates the API key provided in the header. If the request succeeds, the API key is valid. Rate limited to 1000 requests per minute.
- [Run Agents](https://docs.octavehq.com/v2-api-reference/async/run-agent.md): Asynchronously run agents by providing the relevant input payload and a `callbackUrl`. Once processing is complete, the result will be sent to your provided callback URL.
- [Get Brand Voice](https://docs.octavehq.com/v2-api-reference/brand-voice/get-brand-voice.md): Get Brand Voice by OId
- [List Brand Voices](https://docs.octavehq.com/v2-api-reference/brand-voice/list-brand-voices.md): List all brand voices in the workspace
- [Create Buying Trigger](https://docs.octavehq.com/v2-api-reference/buying-trigger/create-buying-trigger.md): Create a new buying trigger
- [Delete Buying Trigger](https://docs.octavehq.com/v2-api-reference/buying-trigger/delete-buying-trigger.md): Soft delete a buying trigger by OId. The buying trigger will be marked as deleted but not permanently removed.
- [Get Buying Trigger](https://docs.octavehq.com/v2-api-reference/buying-trigger/get-buying-trigger.md): Get buying trigger by OId
- [List buying triggers](https://docs.octavehq.com/v2-api-reference/buying-trigger/list-buying-triggers.md): List buying triggers with optional filtering and pagination
- [Update Buying Trigger](https://docs.octavehq.com/v2-api-reference/buying-trigger/update-buying-trigger.md): Update an existing buying trigger
- [Create Competitor](https://docs.octavehq.com/v2-api-reference/competitor/create-competitor.md): Create a new competitor
- [Delete Competitor](https://docs.octavehq.com/v2-api-reference/competitor/delete-competitor.md): Soft delete a Competitor by OId. The competitor will be marked as deleted but not permanently removed.
- [Generate Competitors](https://docs.octavehq.com/v2-api-reference/competitor/generate-competitors.md): Generate competitor analysis from source materials using AI. Each input array generates one competitor analysis. Supports text, URLs, and generative names as sources.
- [Get Competitor](https://docs.octavehq.com/v2-api-reference/competitor/get-competitor.md): Get Competitor by OId
- [List competitors](https://docs.octavehq.com/v2-api-reference/competitor/list-competitors.md): List competitors with optional filtering and pagination
- [Update Competitor](https://docs.octavehq.com/v2-api-reference/competitor/update-competitor.md): Update an existing competitor
- [Create Persona](https://docs.octavehq.com/v2-api-reference/persona/create-persona.md): Create a new persona
- [Delete Persona](https://docs.octavehq.com/v2-api-reference/persona/delete-persona.md): Soft delete a Persona by OId. The persona will be marked as deleted but not permanently removed.
- [Generate Personas](https://docs.octavehq.com/v2-api-reference/persona/generate-personas.md): Generate personas from source materials using AI. Each input array generates one persona. Supports text, URLs, and generative names as sources.
- [Get Persona](https://docs.octavehq.com/v2-api-reference/persona/get-persona.md): Get Persona by OId
- [List persona](https://docs.octavehq.com/v2-api-reference/persona/list-persona.md): List personas by query
- [Update Persona](https://docs.octavehq.com/v2-api-reference/persona/update-persona.md): Update an existing persona
- [Create Playbook](https://docs.octavehq.com/v2-api-reference/playbook/create-playbook.md): Create Playbook
- [Delete Playbook](https://docs.octavehq.com/v2-api-reference/playbook/delete-playbook.md): Soft delete a Playbook by OId. The playbook will be marked as deleted but not permanently removed.
- [Get Playbook](https://docs.octavehq.com/v2-api-reference/playbook/get-playbook.md): Get Playbook by OId
- [List Playbooks](https://docs.octavehq.com/v2-api-reference/playbook/list-playbooks.md): List Playbooks
- [Update Playbook](https://docs.octavehq.com/v2-api-reference/playbook/update-playbook.md): Update an existing playbook. Only provided fields will be updated - omitted fields remain unchanged. The 'data' object will be shallow merged with existing data.
- [Create Product](https://docs.octavehq.com/v2-api-reference/product/create-product.md): Create a new product
- [Delete Product](https://docs.octavehq.com/v2-api-reference/product/delete-product.md): Soft delete a Product by OId. The product will be marked as deleted but not permanently removed.
- [Generate Product](https://docs.octavehq.com/v2-api-reference/product/generate-product.md): Generate a product from source materials using AI. Creates and validates the product against usage rules.
- [Get Product](https://docs.octavehq.com/v2-api-reference/product/get-product.md): Get Product by OId
- [List Products](https://docs.octavehq.com/v2-api-reference/product/list-products.md): List Products
- [Update Product](https://docs.octavehq.com/v2-api-reference/product/update-product.md): Update an existing product
- [Create Proof Point](https://docs.octavehq.com/v2-api-reference/proof-point/create-proof-point.md): Create a new proof point
- [Delete Proof Point](https://docs.octavehq.com/v2-api-reference/proof-point/delete-proof-point.md): Soft delete a Proof Point by OId. The proof point will be marked as deleted but not permanently removed.
- [Generate Proof Points](https://docs.octavehq.com/v2-api-reference/proof-point/generate-proof-points.md): Generate proof points from source materials using AI. Each input array generates one proof point. Supports text, URLs, and generative names as sources.
- [Get Proof Point](https://docs.octavehq.com/v2-api-reference/proof-point/get-proof-point.md): Get Proof Point by OId
- [List proof points](https://docs.octavehq.com/v2-api-reference/proof-point/list-proof-points.md): List proof points with optional filtering and pagination
- [Update Proof Point](https://docs.octavehq.com/v2-api-reference/proof-point/update-proof-point.md): Update an existing proof point
- [Create Reference](https://docs.octavehq.com/v2-api-reference/reference/create-reference.md): Create a new customer reference
- [Delete Reference](https://docs.octavehq.com/v2-api-reference/reference/delete-reference.md): Soft delete a Reference by OId. The reference will be marked as deleted but not permanently removed.
- [Generate References](https://docs.octavehq.com/v2-api-reference/reference/generate-references.md): Generate customer references from source materials using AI. Each input array generates one reference. Supports text, URLs, and generative names as sources.
- [Get Reference](https://docs.octavehq.com/v2-api-reference/reference/get-reference.md): Get Reference by OId
- [List References](https://docs.octavehq.com/v2-api-reference/reference/list-references.md): List References
- [Update Reference](https://docs.octavehq.com/v2-api-reference/reference/update-reference.md): Update an existing reference
- [Create Resource](https://docs.octavehq.com/v2-api-reference/resource/create-resource.md): Create a new global resource in the workspace.
- [Delete Resource(s)](https://docs.octavehq.com/v2-api-reference/resource/delete-resources.md): Soft delete one or more resources. Provide either a single oId or an array of oIds.
- [Get Resource](https://docs.octavehq.com/v2-api-reference/resource/get-resource.md): Get a resource by OId. Optionally check storage task status for pending/uploading resources.
- [Get Resource Status](https://docs.octavehq.com/v2-api-reference/resource/get-resource-status.md): Get the current processing status of a resource. Use this to poll for completion after creating async resources (URL or drive mode).
- [List Resources](https://docs.octavehq.com/v2-api-reference/resource/list-resources.md): List all global resources in the workspace with optional filtering and pagination. Only returns global resources (workspace-wide), not entity-specific resources.
- [Search Resources](https://docs.octavehq.com/v2-api-reference/resource/search-resources.md): Search across global resources using semantic search. Returns resources ranked by relevance to the query.
- [Create Segment](https://docs.octavehq.com/v2-api-reference/segment/create-segment.md): Create a new market segment
- [Delete Segment](https://docs.octavehq.com/v2-api-reference/segment/delete-segment.md): Soft delete a Segment by OId. The segment will be marked as deleted but not permanently removed.
- [Generate Segments](https://docs.octavehq.com/v2-api-reference/segment/generate-segments.md): Generate market segments from source materials using AI. Each input array generates one segment. Supports text, URLs, and generative names as sources.
- [Get Segment](https://docs.octavehq.com/v2-api-reference/segment/get-segment.md): Get Segment by OId
- [List segments](https://docs.octavehq.com/v2-api-reference/segment/list-segments.md): List segments with optional filtering and pagination
- [Update Segment](https://docs.octavehq.com/v2-api-reference/segment/update-segment.md): Update an existing market segment
- [Create Use Case](https://docs.octavehq.com/v2-api-reference/use-case/create-use-case.md): Create a new use case
- [Delete Use Case](https://docs.octavehq.com/v2-api-reference/use-case/delete-use-case.md): Soft delete a Use Case by OId. The use case will be marked as deleted but not permanently removed.
- [Generate Use Cases](https://docs.octavehq.com/v2-api-reference/use-case/generate-use-cases.md): Generate use cases from source materials using AI. Each input array generates one use case. Supports text, URLs, and generative names as sources.
- [Get Use Case](https://docs.octavehq.com/v2-api-reference/use-case/get-use-case.md): Get Use Case by OId
- [List Use Cases](https://docs.octavehq.com/v2-api-reference/use-case/list-use-cases.md): List Use Cases
- [Update Use Case](https://docs.octavehq.com/v2-api-reference/use-case/update-use-case.md): Update an existing use case
- [Run a workflow](https://docs.octavehq.com/v2-api-reference/workflow/run-a-workflow.md): Runs a workflow asynchronously and returns a job OId to track execution.
- [Workspace Builder Agent](https://docs.octavehq.com/v2-api-reference/workspace/build.md): Generate and build a Workspace

## OpenAPI Specs

- [openapi](https://docs.octavehq.com/v2-api-reference/openapi.json)