Loading…

Teaflask Docs

Getting started Glossary Production checklist

Overview Architecture Grounding

Overview Prompt User access Skills Actions Sitemap Memory Delegation Workspace Playground Revisions Suggestions Knowledge App Access Model Upload your API files

Overview Install Surfaces Identity Tool views Transcript Publishable keys Adapters Appearance Headless

Overview Drafting Editing Releasing Organizing Verification Markdown

Overview Organization Members SSO Keys Billing Limits Support

Documentation

Start

Getting startedTeaflask turns your codebase and documentation into an agent that understands your product and can act on a user's behalf.
GlossaryDefinitions of the terms used throughout Teaflask.
Production checklistBefore making the assistant available to your users, review its knowledge, permissions, frontend integration, and funding.
Fundamentals

Agents

OverviewAn agent combines the instructions, model, product knowledge, and capabilities that power your embedded assistant.
PromptThe prompt contains the instructions you write for an agent: its role, responsibilities, tone, and how it should respond to users.
User accessUser access controls whether people can chat anonymously or must sign in to your app.

Assistant UI

Overview@teaflask/assistant is the Teaflask Assistant: the part of Teaflask that runs in your product.
InstallBy the end of this page, the assistant will be on every page of your app, answering as your agent.
SurfacesA surface is a place where the conversation appears.

Knowledge

OverviewManage your product documentation under Docs.
DraftingStart a doc by asking Brew to draft it, writing it yourself, or bringing content from another tool.
EditingOpen Docs and select a document to edit its title and body.
Releasing

Administration

OverviewManage your organization, team access, funding, and connected repositories from Settings.
OrganizationYour organization contains your team's documentation, agents, skills, actions, members, and billing balance.
MembersManage your Teaflask team under Settings > Members.

Troubleshooting

AdministrationFind fixes for funding, membership, sign-in, GitHub connections, and deletion warnings.

Skills

Skills are reusable instructions maintained by your organization and shared across agents.

AActionsActions let an agent perform operations through your existing API.

SSitemapThe sitemap is your organization's catalog of product pages.

MMemoryMemory stores facts across conversations.

DDelegationDelegation lets an agent send a self-contained task to a background subagent while it continues working.

WWorkspaceA workspace gives an agent a sandboxed computer for running commands, reading and editing files, and processing data.

PPlaygroundThe Playground lets you talk to an agent using its latest saved configuration, whether or not that revision is published.

RRevisionsAgent revisions separate the configuration you are editing from the configuration users receive.

SSuggestionsSuggestions are clickable opening prompts shown when a conversation is empty.

KKnowledgeKnowledge settings control which documentation tools an agent can use and which released docs those tools can access.

AAApp AccessApp access lets an agent work with the page a user is on: read its contents, point out a control, fill in a form, or navigate to another part of your app.

MModelModel settings control which model answers, how much reasoning it uses, and how Teaflask manages long conversations.

UAUpload your API filesUpload API files as an alternative to scanning a connected repository.

Identity

The publishable key decides which agent replies.

TVTool viewsEvery time the agent calls a tool or an action, the call appears in the conversation as a row: a short label, an icon, and a body that expands.

TTranscriptThe transcript is the conversation as your users see it: their messages, the agent's replies, every tool the agent uses, the approvals and questions it raises, and work it hands…

PKPublishable keysA publishable key answers one question: which agent replies.

AAdaptersActions are the API operations you've registered for the agent under Actions.

AAppearanceThe assistant is styled with CSS custom properties, all named --tf-*.

HHeadlessHeadless lets you build your own interface on top of the assistant's conversation.

Saving keeps your team's work.

OOrganizingUse folders to arrange your docs and tags to group related material across folders.

VVerificationVerification checks documentation claims against your connected code.

MMarkdownDoc bodies are Markdown (CommonMark and GitHub-flavored): headings, lists, tables, fenced code, links and images, plus the :::note, :::warning, :::tip, :::accordion and :::video…

SSO

Single sign-on lets your team sign in to Teaflask through your identity provider using SAML.

KKeysOwners manage two kinds of credentials under Settings > Keys:

BBillingTeaflask uses a prepaid balance in US dollars.

LLimitsRate limits control how frequently clients can make requests.

SSupportContact hello@teaflask.com for product questions, help with your organization, or Enterprise enquiries.