Developers

Read one workspace from your own tools. Create the key in Settings, then Integrations. The token is shown once. A paid plan is required. Use the API tab for HTTP, or the MCP tab for Claude and Cursor.

Get an API key

Both the read API and the MCP server use the same key. There is no OAuth. A paid plan is required.

Sign in to your workspace.
Open Organization settings, then Integrations.
Under API keys and MCP, name a key and click Create key.
Copy the token from the notice. It starts with dbk_ and is shown once.
Send it as Authorization: Bearer dbk_… or as X-API-Key.

Create an API key

Revoke a key from the same list when you need to rotate it. A missing or revoked key returns 401. A free workspace returns 402.

GET /api/v1/competitors
Authorization: Bearer dbk_…

Request

GET /api/v1/competitors
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 42,
      "name": "Acme Analytics",
      "website_url": "https://acme.example",
      "category": "Analytics",
      "watch": "core",
      "tracked_since": "2026-01-12T09:00:00Z",
      "url": "https://debriefing.io/competitors/42"
    },
    {
      "id": 57,
      "name": "Northwind AI",
      "website_url": "https://northwind.example",
      "category": "AI",
      "watch": "horizon",
      "tracked_since": "2026-03-02T14:30:00Z",
      "url": "https://debriefing.io/competitors/57"
    }
  ]
}

Parameters

id path · required
Competitor id from the watchlist.

Request

GET /api/v1/competitors/42
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 42,
    "name": "Acme Analytics",
    "description": "Product analytics for B2B SaaS teams.",
    "website_url": "https://acme.example",
    "category": "Analytics",
    "industry": "Software",
    "company_type": "private",
    "business_model": "subscription",
    "company_size": 120,
    "founding_year": 2018,
    "headquarters": {
      "city": "San Francisco",
      "country": "US"
    },
    "target_customer": "B2B SaaS product teams",
    "ownership": {
      "type": "private",
      "public": false
    },
    "urls": {
      "pricing": "https://acme.example/pricing",
      "docs": "https://docs.acme.example",
      "linkedin": "https://www.linkedin.com/company/acme"
    },
    "watch": "core",
    "priority": 1,
    "tracked_since": "2026-01-12T09:00:00Z",
    "workspace": {
      "relative_risk": "medium",
      "relative_opportunity": "high",
      "icp_overlap": {
        "score": "high",
        "notes": "Same ICP in mid-market SaaS."
      }
    },
    "reads": {
      "positioning": "Product analytics for growth and product teams.",
      "pricing": {
        "plans": [
          {
            "name": "Pro",
            "price": "$99/mo"
          }
        ],
        "recent_changes": []
      },
      "funding": {
        "total_raised_text": "$45M",
        "last_round": "Series B",
        "estimated_revenue_text": "$8M–$12M ARR"
      },
      "traffic": {
        "monthly_visits": 180000,
        "trend": "up"
      },
      "fortnight": {
        "written_at": "2026-09-20T08:00:00Z",
        "sentences": [
          {
            "text": "Acme raised pricing on the Pro plan.",
            "kind": "pricing"
          }
        ]
      }
    },
    "freshness": {
      "state_updated_at": "2026-09-22T11:00:00Z",
      "last_signal_at": "2026-09-21T16:40:00Z",
      "last_snapshot_at": "2026-09-22T10:55:00Z"
    },
    "links": {
      "signals": "/api/v1/signals?competitor_id=42",
      "battlecard_id": 9,
      "url": "https://debriefing.io/competitors/42"
    }
  }
}

Parameters

competitor_id query
Limit to one tracked competitor.
severity query
low, medium, or high.
since query
ISO 8601 time. First seen on or after this time.
q query
Case-insensitive match on title or summary.
page query
Page number. Default 1.
per_page query
Page size. Default 50. Maximum 50.

Request

GET /api/v1/signals?severity=high&per_page=2
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 881,
      "competitor_id": 42,
      "competitor_name": "Acme Analytics",
      "title": "Acme raised Pro plan pricing",
      "summary": "The Pro plan moved from $79 to $99 per month on the public pricing page.",
      "category": "pricing",
      "type": "price_change",
      "severity": "high",
      "status": "open",
      "first_seen_at": "2026-09-21T16:40:00Z",
      "last_seen_at": "2026-09-21T16:40:00Z",
      "confidence": 0.92,
      "topics": [
        "pricing",
        "packaging"
      ],
      "evidence": [
        {
          "text": "Pro · $99 / month",
          "source_title": "Acme Pricing",
          "source_url": "https://acme.example/pricing",
          "observed_at": "2026-09-21T16:40:00Z"
        }
      ],
      "url": "https://debriefing.io/dashboard/signals/881"
    }
  ],
  "page": 1,
  "per_page": 2
}

Parameters

id path · required
Signal id.

Request

GET /api/v1/signals/881
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 881,
    "competitor_id": 42,
    "competitor_name": "Acme Analytics",
    "title": "Acme raised Pro plan pricing",
    "summary": "The Pro plan moved from $79 to $99 per month on the public pricing page.",
    "category": "pricing",
    "type": "price_change",
    "severity": "high",
    "status": "open",
    "first_seen_at": "2026-09-21T16:40:00Z",
    "last_seen_at": "2026-09-21T16:40:00Z",
    "confidence": 0.92,
    "topics": [
      "pricing",
      "packaging"
    ],
    "evidence": [
      {
        "text": "Pro · $99 / month",
        "source_title": "Acme Pricing",
        "source_url": "https://acme.example/pricing",
        "observed_at": "2026-09-21T16:40:00Z"
      }
    ],
    "url": "https://debriefing.io/dashboard/signals/881"
  }
}

Parameters

type query
Debrief type, for example daily_digest or weekly_tldr.
page query
Page number. Default 1.
per_page query
Page size. Default 50. Maximum 50.

Request

GET /api/v1/digests?type=daily_digest
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 310,
      "slug": "daily-2026-09-22",
      "type": "daily_digest",
      "status": "generated",
      "title": "Daily digest · 22 Sep 2026",
      "headline": "Acme raised Pro pricing. Northwind opened a EU careers page.",
      "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe.",
      "what_to_watch": "Watch whether Acme changes packaging next.",
      "coverage_period_start": "2026-09-21T00:00:00Z",
      "coverage_period_end": "2026-09-22T00:00:00Z",
      "generated_at": "2026-09-22T07:15:00Z",
      "signal_ids": [
        881,
        902
      ],
      "url": "https://debriefing.io/dashboard/digests/daily-2026-09-22"
    }
  ],
  "page": 1,
  "per_page": 50
}

Parameters

id path · required
Digest slug or numeric id.

Request

GET /api/v1/digests/daily-2026-09-22
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 310,
    "slug": "daily-2026-09-22",
    "type": "daily_digest",
    "status": "generated",
    "title": "Daily digest · 22 Sep 2026",
    "headline": "Acme raised Pro pricing. Northwind opened a EU careers page.",
    "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe.",
    "what_to_watch": "Watch whether Acme changes packaging next.",
    "coverage_period_start": "2026-09-21T00:00:00Z",
    "coverage_period_end": "2026-09-22T00:00:00Z",
    "generated_at": "2026-09-22T07:15:00Z",
    "signal_ids": [
      881,
      902
    ],
    "url": "https://debriefing.io/dashboard/digests/daily-2026-09-22"
  }
}

Request

GET /api/v1/battlecards
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 9,
      "competitor_id": 42,
      "competitor_name": "Acme Analytics",
      "status": "generated",
      "generated_at": "2026-09-20T12:00:00Z",
      "sections": {
        "overview": "Acme sells product analytics to mid-market SaaS.",
        "strengths": [
          "Strong product analytics brand",
          "Clear Pro packaging"
        ],
        "weaknesses": [
          "Price rose without a feature add"
        ],
        "talk_tracks": [
          "Ask what they get for the new Pro price."
        ]
      },
      "url": "https://debriefing.io/dashboard/battlecards/9"
    }
  ]
}

Parameters

id path · required
Battlecard id or competitor id.

Request

GET /api/v1/battlecards/9
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 9,
    "competitor_id": 42,
    "competitor_name": "Acme Analytics",
    "status": "generated",
    "generated_at": "2026-09-20T12:00:00Z",
    "sections": {
      "overview": "Acme sells product analytics to mid-market SaaS.",
      "strengths": [
        "Strong product analytics brand",
        "Clear Pro packaging"
      ],
      "weaknesses": [
        "Price rose without a feature add"
      ],
      "talk_tracks": [
        "Ask what they get for the new Pro price."
      ]
    },
    "url": "https://debriefing.io/dashboard/battlecards/9"
  }
}

Get an API key

Both the read API and the MCP server use the same key. There is no OAuth. A paid plan is required.

Sign in to your workspace.
Open Organization settings, then Integrations.
Under API keys and MCP, name a key and click Create key.
Copy the token from the notice. It starts with dbk_ and is shown once.
Send it as Authorization: Bearer dbk_… or as X-API-Key.

Create an API key

Revoke a key from the same list when you need to rotate it. A missing or revoked key returns 401. A free workspace returns 402.

Endpoint:

https://debriefing.io/mcp

Create an API key (see above) and keep it ready.
Pick your client below and paste the config.
Restart the client. Ask it to list your competitors.

Cursor

Add a remote server in ~/.cursor/mcp.json or in the project .cursor/mcp.json. Prefer headers with an environment variable so the key stays out of the file.

Create an API key in Settings, then Integrations. Copy it once.
Export DEBRIEFING_API_KEY=dbk_… in your shell profile.
Paste the config below. Restart Cursor.
Open Customize, confirm the debriefing server is on, then ask for your tracked competitors.

On Windows, keep the Bearer value in an env var. Do not put spaces inside the args string for Authorization.

~/.cursor/mcp.json

{
  "mcpServers": {
    "debriefing": {
      "url": "https://debriefing.io/mcp",
      "headers": {
        "Authorization": "Bearer ${env:DEBRIEFING_API_KEY}"
      }
    }
  }
}

Claude Desktop

Claude Desktop speaks stdio. mcp-remote bridges it to our HTTP endpoint. Put the Bearer token in env so spaces in the header do not break the args array.

Install Node.js 18 or newer.
Open Claude Desktop settings. On macOS the file is ~/Library/Application Support/Claude/claude_desktop_config.json. On Windows it is %APPDATA%\Claude\claude_desktop_config.json.
Paste the config. Replace dbk_… with your key. Keep no space around the colon in Authorization:${AUTH_HEADER}.
Restart Claude Desktop. Look for the tools control near the input box.

claude_desktop_config.json

{
  "mcpServers": {
    "debriefing": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://debriefing.io/mcp",
        "--header",
        "Authorization:${AUTH_HEADER}"
      ],
      "env": {
        "AUTH_HEADER": "Bearer dbk_…"
      }
    }
  }
}

Claude Code

Claude Code can call a remote HTTP MCP server. Pass the API key as a header.

Create an API key in Settings, then Integrations.
Run: claude mcp add --transport http debriefing https://debriefing.io/mcp --header "Authorization: Bearer dbk_…"
Inside Claude Code, run /mcp and confirm the debriefing server is connected.

Other MCP clients

Any client that can reach a Streamable HTTP MCP server can use the same endpoint. Clients that only speak stdio should use mcp-remote.

Endpoint: https://debriefing.io/mcp
Auth: Authorization: Bearer dbk_… or X-API-Key: dbk_…
Transport: JSON-RPC over HTTP POST. This server does not push over SSE.

stdio via mcp-remote

{
  "mcpServers": {
    "debriefing": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://debriefing.io/mcp",
        "--header",
        "Authorization:${AUTH_HEADER}"
      ],
      "env": {
        "AUTH_HEADER": "Bearer dbk_…"
      }
    }
  }
}

list_competitors The competitors this workspace tracks, with ids to use in other tools.

No arguments.

Example result

{
  "items": [
    {
      "id": 42,
      "name": "Acme Analytics",
      "website_url": "https://acme.example",
      "category": "Analytics",
      "watch": "core"
    }
  ]
}

get_competitor The dossier for one tracked competitor: company facts, workspace risk and opportunity, and the stored reads (positioning, product, pricing, funding, and more).

Arguments

competitor_id integer · required

Example call

{
  "competitor_id": 42
}

Example result

{
  "id": 42,
  "name": "Acme Analytics",
  "reads": {
    "positioning": "Product analytics for growth and product teams.",
    "funding": {
      "last_round": "Series B",
      "estimated_revenue_text": "$8M–$12M ARR"
    }
  },
  "workspace": {
    "relative_risk": "medium",
    "relative_opportunity": "high"
  }
}

search_signals Signals (evidence-backed competitor moves), newest first. Filter by competitor_id, severity (low, medium, high), a text query, or a since time.

Arguments

competitor_id integer
severity string
low, medium, high
query string
since string
ISO 8601 time
limit integer

Example call

{
  "competitor_id": 42,
  "severity": "high",
  "limit": 5
}

Example result

{
  "items": [
    {
      "id": 881,
      "title": "Acme raised Pro plan pricing",
      "severity": "high",
      "evidence": [
        {
          "text": "Pro · $99 / month",
          "source_url": "https://acme.example/pricing"
        }
      ]
    }
  ]
}

list_digests Generated digests for this workspace, newest first. Filter by type such as daily_digest.

Arguments

type string
limit integer

Example call

{
  "type": "daily_digest",
  "limit": 5
}

Example result

{
  "items": [
    {
      "id": 310,
      "slug": "daily-2026-09-22",
      "type": "daily_digest",
      "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe."
    }
  ]
}

get_digest One digest by id or slug, or the newest when no id is given. Pass type daily_digest for the daily one.

Arguments

id string
type string

Example call

{
  "id": "daily-2026-09-22"
}

Example result

{
  "id": 310,
  "slug": "daily-2026-09-22",
  "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe.",
  "signal_ids": [
    881,
    902
  ]
}

list_battlecards Generated battlecards for this workspace.

No arguments.

Example result

{
  "items": [
    {
      "id": 9,
      "competitor_id": 42,
      "competitor_name": "Acme Analytics",
      "status": "generated"
    }
  ]
}

get_battlecard One battlecard by competitor_id or battlecard_id.

Arguments

competitor_id integer
battlecard_id integer

Example call

{
  "competitor_id": 42
}

Example result

{
  "id": 9,
  "competitor_id": 42,
  "sections": {
    "overview": "Acme sells product analytics to mid-market SaaS.",
    "talk_tracks": [
      "Ask what they get for the new Pro price."
    ]
  }
}

get_evidence The evidence behind one signal: each source excerpt with its URL and date.

Arguments

signal_id integer · required

Example call

{
  "signal_id": 881
}

Example result

{
  "signal_id": 881,
  "title": "Acme raised Pro plan pricing",
  "evidence": [
    {
      "text": "Pro · $99 / month",
      "source_title": "Acme Pricing",
      "source_url": "https://acme.example/pricing"
    }
  ]
}

Brief me on one competitor

Use get_competitor for Acme, then search_signals for that competitor from the last 14 days. Cite the evidence URLs.

What moved this week?

List digests of type daily_digest, open the newest one, and summarize what matters for our sales team.

Prep a call

Get the battlecard for competitor_id 42. Pull the three highest-severity open signals. Give me talk tracks grounded in the evidence.

Trace a claim

Search signals for pricing changes. For the top result, call get_evidence and show me each source excerpt with its URL.

401 Unauthorized

The key is missing, mistyped, or revoked. Create a new key in Settings, then Integrations.
402 Payment required

MCP needs a paid plan. Upgrade, then retry with the same key.
Tools do not appear

Restart the client after you save the config. Confirm Node.js 18+ is on the PATH when you use mcp-remote.
Header mangled on Windows or Cursor

Do not put spaces inside the args string for Authorization. Use Authorization:${AUTH_HEADER} and put Bearer dbk_… in the env value.
GET /mcp returns 405

This server answers POST only. It does not stream over SSE. Clients must use Streamable HTTP or mcp-remote.

Get an API key

Request

Response

Parameters

Request

Response

Parameters

Request

Response

Parameters

Request

Response

Parameters

Request

Response

Parameters

Request

Response

Request

Response

Parameters

Request

Response

Get an API key

~/.cursor/mcp.json

claude_desktop_config.json

stdio via mcp-remote

Example result

Arguments

Example call

Example result

Arguments

Example call

Example result

Arguments

Example call

Example result

Arguments

Example call

Example result

Example result

Arguments

Example call

Example result

Arguments

Example call

Example result

Brief me on one competitor

What moved this week?

Prep a call

Trace a claim

401 Unauthorized

402 Payment required

Tools do not appear

Header mangled on Windows or Cursor

GET /mcp returns 405