API

Overview

Snipplle provides an API that can be used to interact with your data outside of the web interface.

At the moment, the API is primarily designed to support the Snipplle CLI, enabling command-line access to your snippets.

API Keys

Access to the API is authenticated using API keys.

An API key represents your identity and grants access to your Snipplle account and workspaces according to your permissions.

Generating an API Key

You can generate an API key from your account settings.

Once generated:

• The key can be used to authenticate API requests
• It should be stored securely
• Anyone with access to the key can access your data

API keys can be revoked at any time.

Using the API with the CLI

The primary use case for the API is connecting the Snipplle CLI.

With an API key, the CLI can:

• Authenticate with Snipplle
• Access your snippets
• Work within your available workspaces

This allows you to interact with Snipplle directly from your terminal.

Security Considerations

• Keep API keys private
• Do not commit keys to source control
• Rotate keys if they are exposed

If an API key is compromised, revoke it immediately.