The ShowPilot API
Read your workspace's numbers and, soon, its tours, visitors and conversations from your own tools.
The API lives at https://api.showpilot.com/v1. It is the same host and the same paths ShowPilot's own dashboard uses; an API key is what tells the two apart. Every call is scoped to the workspace the key belongs to, and the workspace is never a parameter.
The API reads tours and their documents, hubs, agents, visitors with their journey, conversations with messages, leads, follow-ups, tour sittings, and the Insights numbers. The first writes are in: answer or dismiss a follow-up, and update a lead's owner, status or CRM link, each with an Idempotency-Key so a retry never writes twice. Next come signed webhooks for the events that matter, then documents through a propose-and-apply flow that any agent harness can drive. Every endpoint is described once, in the OpenAPI contract, and the Reference here is generated from it. Signed webhooks, an event log and a stream tell your systems when something happens.
Start here
- Create a key in Settings → API keys. Keys are shown once; store them where your tool keeps secrets. The help page walks through it.
- Call an endpoint with the key as a bearer token:
curl "https://api.showpilot.com/v1/insights/pulse?from=2026-08-25&to=2026-09-23" \
-H "Authorization: Bearer $SHOWPILOT_API_KEY"- Read the response headers. Every call returns
X-Request-Idand the rate-limit headers described in Rate limits.
Conventions
- Ids. Objects expose a UUID
idand, where one exists, thepublicIdused in share links and embeds. - Time. ISO 8601 in UTC. Day parameters are
YYYY-MM-DD. - Errors. One envelope,
{ "error": { "code", "message", "requestId" } }, with a stable code per case. See Errors. - Versioning.
/v1only gains fields and endpoints. Nothing is removed or retyped; a breaking change would be/v2. - Vocabulary. A product walkthrough is a tour; a collection of tours for an account is a hub.
For agents
https://www.showpilot.com/docs/llms.txt lists every page of this site as plain text, and llms-full.txt carries the full content, so an agent can read these docs without a browser. The OpenAPI contract is the source for an MCP server and function-calling schemas that are on the way; the reference pages here describe the same operations.