> ## Documentation Index
> Fetch the complete documentation index at: https://docs.papermap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Your API Key

API Keys in Papermap are scoped to workspaces. A workspace is a secure environment connected to a specific data source where you can chat with our AI to obtain insights from your data and build multiple live dashboards.

> [!NOTE]
>
> The API key you create here can be used for both iframe embedding and React
> component embedding with `@papermap/papermap`. For the React integration path,
> see [React Components](https://docs.papermap.ai/documentation/embedding/react-components.md).

Follow the steps below to obtain an API key:

**1. Log into your Papermap account**

Visit [papermap.ai](https://www.papermap.ai) and sign in with your credentials.

**2. Open Workspace Settings**

Navigate to your workspace and click the options icon (three dots) in the workspace card, then select **Settings** from the dropdown menu.

**3. Generate New Key**

Navigate to **API Keys** from the sidebar and click **Create New Key** to generate a new API key.

**4. Copy your key**

Copy the generated API key (starts with `ak_`) and SECRET key also. Store it securely!

## Security Considerations

> [!WARNING]
>
> **Never expose your API key in client-side code or public repositories.** Your API key provides full access to your Papermap data and should be treated as a password.

### Best Practices

* **Store securely**: Use environment variables or secure configuration management
* **Never commit**: Add your API key to `.gitignore` and never commit it to version control
* **Rotate regularly**: Generate new API keys periodically and revoke old ones
* **Monitor usage**: Check your API key usage in the Papermap dashboard for any suspicious activity
* **Use HTTPS**: Always use HTTPS when embedding dashboards to protect data in transit

### For Production Applications

* Implement server-side proxy endpoints that generate temporary tokens
* Use proper authentication and authorization before serving embedded content

## Next Steps

> [card] [React Components](https://docs.papermap.ai/documentation/embedding/react-components.md)
>
> Embed `PaperChat`, `PaperCard`, and `PaperBoard` directly in your React application

> [card] [Basic Embedding](https://docs.papermap.ai/documentation/embedding/basic-embedding.md)
>
> Start with simple iframe embedding to get your first dashboard up and running

> [card] [Configuration](https://docs.papermap.ai/documentation/embedding/configuration.md)
>
> Learn about advanced configuration options and customization parameters for your embedded dashboards

> [card] [Parameter Usecases](https://docs.papermap.ai/documentation/embedding/parameter-usecases.md)
>
> Explore common parameter combinations and use cases for different embedding scenarios

> [card] [Troubleshooting](https://docs.papermap.ai/documentation/embedding/troubleshooting.md)
>
> Common issues and solutions for embedding Papermap dashboards in your application


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