Skip to main content
This feature is coming soon. The endpoint and SDK helper described on this page are not yet available. This page documents the planned interface.

What it is

When you onboard with Autoplay, your productโ€™s golden paths are indexed in Autoplayโ€™s managed vector database. A golden path is a curated sequence of steps that represents the ideal journey a user takes to successfully adopt a feature โ€” for example, the optimal path from sign-up to first meaningful action in your product. Your support AI agent can query this knowledge base at inference time to retrieve the most relevant adoption guidance for any question a user asks.

Why it matters

Real-time session data (delivered via the SDK) tells your support AI agent what a user is doing right now. The knowledge base tells it what they should be doing โ€” and how to bridge the gap. Together, they give the support AI agent two sources of structured context:
SourceWhat it containsHow itโ€™s delivered
Real-time session streamLive UI actions + session summariesActionsPayload / SummaryPayload via SSE or webhook
Knowledge baseGolden paths, feature guides, adoption stepsGET /knowledge-base/{product_id}?query=...

How it fits in the pipeline


Endpoint

Path parameters

product_id
string
required
Your product identifier โ€” the same one used for the SSE stream and webhook.

Query parameters

query
string
required
The userโ€™s question or the session context snippet to use as the search vector. The endpoint embeds this text and performs an ANN lookup against your productโ€™s golden paths.
top_k
integer
default:"3"
Number of golden path results to return. Higher values give the LLM more context but consume more tokens.

Authentication

Pass the same Unkey API key used for the SSE stream:

Support AI agent integration example

Inject the knowledge base results alongside the live session context in your system prompt:

Combining with RedisEventBuffer

For the best results, retrieve the userโ€™s recent session activity from your buffer at the same time as fetching golden paths:

Golden path management

Golden paths for your product are managed through two surfaces: Autoplay Chrome extension (recommended) Record a golden path directly in your product โ€” no manual writing required. Open the extension, start recording, walk through the ideal user journey in your app, then save. The extension captures each step automatically and adds it to your productโ€™s knowledge base. Autoplay dashboard
  • Add and edit golden paths manually for each feature or workflow
  • Edit step descriptions to match your UI terminology
  • Archive paths for deprecated features
  • Preview how paths are retrieved for sample queries
Contact your Autoplay account manager to configure your productโ€™s knowledge base.