# Papermap

## Docs

- [Welcome to Papermap](https://docs.papermap.ai/index.md): Papermap empowers teams to harness the power of AI native data analytics without the complexity of traditional data platforms.
- [Terminal UI Overview](https://docs.papermap.ai/documentation/tui/overview.md): Use Papermap directly from your terminal with keyboard-first analytics, streamed insights, workspaces, model switching, and shell mode.
- [Install the TUI](https://docs.papermap.ai/documentation/tui/install.md): Install Papermap TUI with Homebrew, the install script, Go, or a source build.
- [TUI Authentication](https://docs.papermap.ai/documentation/tui/authentication.md): Sign in to Papermap TUI, understand browser login, credential storage, logout, and session behavior.
- [Navigate the TUI](https://docs.papermap.ai/documentation/tui/navigation.md): Use Papermap TUI shortcuts, command palette, streamed answers, conversations, model switching, shell mode, and terminal selection.
- [TUI Workspaces](https://docs.papermap.ai/documentation/tui/workspaces.md): Switch workspaces, create database-backed workspaces, list available workspaces, and understand the local workspace cache.
- [TUI Configuration](https://docs.papermap.ai/documentation/tui/configuration.md): Configure Papermap TUI API URLs, frontend login URL, thinking traces, selected model, and shell behavior.
- [TUI Troubleshooting](https://docs.papermap.ai/documentation/tui/troubleshooting.md): Fix common Papermap TUI installation, login, workspace, streaming, shell mode, and configuration issues.
- [Embedding Overview](https://docs.papermap.ai/documentation/embedding/overview.md)
- [Getting Your API Key](https://docs.papermap.ai/documentation/embedding/get-api-key.md)
- [React Components](https://docs.papermap.ai/documentation/embedding/react-components.md)
- [Basic Embedding](https://docs.papermap.ai/documentation/embedding/basic-embedding.md)
- [Configuration](https://docs.papermap.ai/documentation/embedding/configuration.md)
- [Parameter Usecases](https://docs.papermap.ai/documentation/embedding/parameter-usecases.md)
- [Troubleshoot](https://docs.papermap.ai/documentation/embedding/troubleshooting.md)
- [Multi-Tenancy Overview](https://docs.papermap.ai/documentation/multi-tenancy/overview.md)
- [Multi-Tenancy Example](https://docs.papermap.ai/documentation/multi-tenancy/multitenancy-example.md)
- [Multi-Tenancy Setup](https://docs.papermap.ai/documentation/multi-tenancy/setup.md)
- [Backend Implementation](https://docs.papermap.ai/documentation/multi-tenancy/backend.md)
- [HMAC Authentication](https://docs.papermap.ai/documentation/multi-tenancy/authentication.md)
- [Creating Dashboards](https://docs.papermap.ai/documentation/multi-tenancy/creating-dashboards.md)
- [Iframe Embed Tokens](https://docs.papermap.ai/documentation/multi-tenancy/iframe-tokens.md)
- [API Endpoints](https://docs.papermap.ai/documentation/multi-tenancy/api-endpoints.md)
- [Tenant Usage Tracking](https://docs.papermap.ai/documentation/multi-tenancy/tenant-usage.md)
- [Security Best Practices](https://docs.papermap.ai/documentation/multi-tenancy/security.md)
- [Best Practices](https://docs.papermap.ai/documentation/multi-tenancy/best-practices.md)
- [Papermap AIR](https://docs.papermap.ai/air/index.md): Build governed AI agents and connect private tools without opening your infrastructure to inbound traffic.
- [Visual quickstart](https://docs.papermap.ai/air/quickstart.md): Create a project, prompt, active agent, and first run in the AIR staging console.
- [How AIR works](https://docs.papermap.ai/air/concepts/how-air-works.md): Understand projects, agents, runs, workers, tools, and the durable execution loop.
- [Projects and keys](https://docs.papermap.ai/air/concepts/projects-and-keys.md): Choose the correct AIR credential and keep every integration scoped to one project.
- [Create and version an agent](https://docs.papermap.ai/air/agents/create-agent.md): Bind immutable instructions, model access, approved tools, and limits into an active AIR agent version.
- [Create and manage runs](https://docs.papermap.ai/air/applications/create-runs.md): Start, stream, inspect, wait for, and cancel AIR runs from an application.
- [Create a private worker](https://docs.papermap.ai/air/workers/create-worker.md): Register typed Python functions as governed tools over an outbound-only worker connection.
- [Deploy a worker](https://docs.papermap.ai/air/workers/deploy-worker.md): Package and operate AIR workers safely in containers and Kubernetes.
- [Connect MCP tools](https://docs.papermap.ai/air/workers/mcp.md): Mount local Model Context Protocol servers into an outbound AIR worker.
- [Security](https://docs.papermap.ai/air/guides/security.md): Protect AIR credentials, tenant data, workers, and tool permissions.
- [Troubleshooting](https://docs.papermap.ai/air/guides/troubleshooting.md): Resolve common run, credential, worker, and tool configuration problems.
- [Python SDK](https://docs.papermap.ai/air/reference/python-sdk.md): Reference for AIR application clients, runs, workers, tools, and errors.
- [Environment variables](https://docs.papermap.ai/air/reference/environment-variables.md): Configuration used by AIR applications and worker processes.
- [Features Overview](https://docs.papermap.ai/features/overview.md): Discover what makes Papermap the modern data platform for teams who want powerful analytics without the complexity.
- [Branching Chats](https://docs.papermap.ai/features/branching-chats.md): Branch conversations with Alan to explore different questions without losing your original context.
- [Web Search](https://docs.papermap.ai/features/web-search.md): Combine real-time web data with your own data for richer, more contextual insights.
- [Papermap Apps](https://docs.papermap.ai/features/apps.md): Open Apps from the bar, then create bookmarks, notes, skills, document extractions, and data entry recipes.
- [Generate Embed Token](https://docs.papermap.ai/api-reference/generate-embed-token.md): Generate a temporary token for testing embedded dashboards. This token allows you to preview and test your dashboard embedding configuration before implementing it in production.
- [Create Dashboard](https://docs.papermap.ai/api-reference/create-dashboard.md): Endpoint to create a new dashboard
- [Get Workspace Tenant Usage](https://docs.papermap.ai/api-reference/get-workspace-tenant-usage.md): Retrieve usage data for all tenants in a workspace
- [Get Tenant Usage History](https://docs.papermap.ai/api-reference/get-tenant-usage-history.md): Retrieve usage history for a specific tenant
- [Release Notes](https://docs.papermap.ai/changelog/release-notes.md)
- [Developer Platform](https://docs.papermap.ai/changelog/developer-platform.md)

## OpenAPI Specs

- [embed-openapi](https://docs.papermap.ai/api-reference/embedding/embed-openapi.json)
- [tenant-usage-openapi](https://docs.papermap.ai/api-reference/tenant-usage/tenant-usage-openapi.json)
- [dashboard-openapi](https://docs.papermap.ai/api-reference/managing-dashboards/dashboard-openapi.json)

## Optional

- [Your Workspaces](https://www.papermap.ai/auth/login)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.