Developer docs

Start here

Everything StreamAgent exposes to code, which plan unlocks it, and where each piece is documented. One registry of capabilities serves two protocols, REST and MCP, so a script and an AI assistant reach the same things with the same key. Written to be read by people and by assistants; every page is also available as Markdown.

One registry, two protocols

Every capability is one entry: an MCP tool and a REST route of the same name, one implementation, one scope, one rate limit, one privacy rule. list_leads over MCP and GET /leads over REST run the same code and return the same shape. A key that can do a thing on one protocol can do it on the other; a key that cannot, cannot. New capabilities land on both at once.

  • Building a script, a cron job, a Zapier step or a CRM sync? Use the REST API.
  • Working inside Claude, ChatGPT or Perplexity, or building an agent? Connect the MCP server.
  • Either way, create a key or connect an assistant under Authentication, and listen for what happens with Webhooks.

What you can integrate with

Six surfaces are live, each with its own page here.

SurfaceWhat it isDocs
MCP server47 tools over the Model Context Protocol at https://app.streamagent.io/api/mcp: videos, analytics, leads, transcripts, routes, scheduling, channel, workspace. Works from Claude, ChatGPT, Perplexity, or your own client with an API key.MCP server
REST APIPlain JSON at https://app.streamagent.io/api/v1 for every capability: add, list and update videos; add, enrich and update leads; build routes; read the workspace summary, daily series, per-video analytics and transcripts; read the revenue ledger; book calls; curate the channel; and, with an Admin key, manage webhook endpoints and keys. Cursor pagination, idempotent writes, an OpenAPI document.REST API
API keysBearer keys in three tiers, scoped to one workspace, with per-key rate limits. One key works on the REST API and the MCP server alike.Authentication
Outbound webhooksSigned POSTs to your endpoint when a lead is captured or changed by API, a goal is reached, a call is booked or canceled, an outcome is recorded, a video becomes ready or fails, or a viewer starts, completes, passes a gate or picks a branch in a video.Webhooks
EmbedsA responsive iframe for any video or route that forwards campaign attribution from the host page, plus a message contract for passing click ids across the frame.Embeds and attribution
ReceiversInbound URLs for revenue sources and scheduling tools, each verified by a per-workspace secret.Receivers

Which plan unlocks what

Webhooks are on every plan. API keys and assistant connections need developer access, which is part of Pro and above.

CapabilityCorePro and above
Outbound webhooksYesYes
API keys (REST API and MCP server)NoYes
Connect an AI assistantNoYes
Custom domain for public pagesNoYes

Where secrets live

  • API keys: Settings → API keys. The full secret is shown once, at creation; only its first eight characters are kept visible after that.
  • Webhook signing secrets: one per endpoint, under Integrations → Webhooks.
  • Assistant connections: Settings → Connected apps lists every assistant with access, what it may do, and a revoke action.
  • By code: an Admin key can register endpoints (secret returned once), rotate secrets, and create keys of equal or lower access, through the Provisioning routes on the REST API page.

Read these docs as Markdown

Every page has a plain-text twin at the same path plus /index.md, for example /docs/authentication/index.md. Point an assistant at it, or fetch it from a script.

Getting help

Frankie, the in-app assistant, answers integration questions from these same pages and can open the right screen for you. For anything it cannot resolve, it hands the conversation to a person.