API reference
After this page you can authenticate against the WireTap API and know where each endpoint family lives. The API is small on purpose: one ingest surface for SDK telemetry, one query surface backing the bot, MCP server, and web app.
Base URLs
Section titled “Base URLs”| Deployment | Base URL |
|---|---|
| Hosted | https://api.wiretapsol.com |
| Self-hosted | http://127.0.0.1:8790 (default API_PORT) |
Authentication
Section titled “Authentication”Machine routes take your API key in the x-api-key header. wiretap init mints a key and
saves it to ~/.wiretap.json (or set WIRETAP_API_KEY); keys are prefixed wt_:
curl -H "x-api-key: wt_…" \ http://127.0.0.1:8790/v1/programsA key is scoped to your account: it can write ingest envelopes and read that account’s data.
(The public /why read surface needs no key at all.)
Conventions
Section titled “Conventions”- JSON everywhere; timestamps are Unix milliseconds (UTC).
- Errors are
{ "error": { "code": string, "message": string } }with meaningful HTTP status. - List endpoints paginate with
limit+ opaquecursor.
Endpoint families
Section titled “Endpoint families”- Ingest endpoints — SDK envelope batches.
- Query endpoints — everything the nine questions need.