Skip to main content

​
Get your API key

1

Log in to your Octave dashboard

Go to app.octavehq.com and sign in. If you don’t have an account, start for free.
2

Copy your API key

Navigate to Settings > API Keys and copy your workspace API key. Each workspace has a unique key.

​
Make your first API call

List the agents available in your workspace: 
curl -X GET https://api.octavehq.com/api/v2/agents/list \
  -H "Api key: YOUR_API_KEY"
You should see a response like: 
{
  "metadata": {
    "hasNext": false,
    "total": 9
  },
  "data": [
    {
      "type": "PROSPECTOR",
      "name": "Prospector Agent",
      "description": "Research and qualify prospects against your ICP"
    }
  ]
}

​
Run an agent

Once you have your agent list, run one. Here’s how to enrich a company: 
curl -X POST https://api.octavehq.com/api/v2/agents/enrich-company \
  -H "Api key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Stripe",
    "companyUrl": "https://stripe.com"
  }'
The response includes firmographic data, product fit analysis, and a confidence score based on your ICP definition. The agent reads your Library — your defined personas, use cases, segments, and proof points — to evaluate how well this company fits your ideal customer profile. Every agent call is grounded in your actual GTM strategy, not generic enrichment data.

​
What to build next

Explore All Agents

See the full list of pre-built agents: prospecting, enrichment, qualification, sequencing, and call prep.

Run Async Workflows

For batch operations, use the async endpoint with a callback URL to process results at scale.

Manage Your Library

Create personas, segments, competitors, and proof points that agents use as context.

Connect via MCP

Skip the API and give AI assistants direct access to your workspace.