> ## 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.

<Info>
  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](/documentation/embedding/react-components).
</Info>

Follow the steps below to obtain an API key:

<Steps>
  <Step title="Log into your Papermap account">
    Visit [papermap.ai](https://www.papermap.ai) and sign in with your credentials.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Generate New Key">
    Navigate to **API Keys** from the sidebar and click **Create New Key** to generate a new API key.
  </Step>

  <Step title="Copy your key">
    Copy the generated API key (starts with `ak_`) and SECRET key also. Store it securely!
  </Step>
</Steps>

## 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.
</Warning>

### 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

<CardGroup cols={2}>
  <Card title="React Components" icon="grid-2" href="/documentation/embedding/react-components">
    Embed `PaperChat`, `PaperCard`, and `PaperBoard` directly in your React application
  </Card>

  <Card title="Basic Embedding" icon="code" href="/documentation/embedding/basic-embedding">
    Start with simple iframe embedding to get your first dashboard up and running
  </Card>

  <Card title="Configuration" icon="gear" href="/documentation/embedding/configuration">
    Learn about advanced configuration options and customization parameters for your embedded dashboards
  </Card>

  <Card title="Parameter Usecases" icon="list-check" href="/documentation/embedding/parameter-usecases">
    Explore common parameter combinations and use cases for different embedding scenarios
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/documentation/embedding/troubleshooting">
    Common issues and solutions for embedding Papermap dashboards in your application
  </Card>
</CardGroup>