Skip to main content

Frankie docs

Frankie adds an assistant to your app, your website and your docs. It answers questions and, inside your app, does things for the signed-in user through the API you already have.

Start here​

Install it with an AI​

You don't write the install by hand. Pick one:

The three agents​

AgentWhere it appearsWhat it does
Product agentInside your appAnswers questions and takes actions for the signed-in user, using your API.
Support agentYour website (by default /)Answers visitors' questions and hands the chat to your team when it can't help.
Docs agentYour docs (by default /docs/**)Answers only from your documentation and links the page it used.

Browse by topic​

What happens on each message​

  1. Who is this? The widget asks your backend for a five-minute token naming the user. Your login stays yours. See Authentication.
  2. Open a session. Frankie checks the origin, the key, the rate limit and the token.
  3. The agent runs with only the actions you switched on, calling your API as that user, so it can never see or change more than they could.
  4. Answers stream back as they're written, with each action shown as it happens.