Generating an API Key

Last updated: August 28, 2025

You can create an API key in Zams to interact with your agents programmatically. API keys allow you to connect external applications or scripts directly to your agents, enabling automation and advanced integrations.

Prerequisites

There are no prerequisites for creating an API key.

Warning: An API key gives access to all your agents and actions. Handle it securely and never share it publicly.

Steps

Step 1: Open Settings

  1. In the left-hand navigation menu, click Settings.

Step 2: Navigate to API Keys

  1. Scroll down to the API Keys section.

  2. Here you will see a list of existing API keys for your account.

Step 3: Create a New API Key

  1. Click the Create API Key button on the right-hand side.

  2. Enter a name for your API key (e.g., production_api_key).

  3. Click Create.

Step 4: Copy Your API Key

  1. Once created, the API key will appear in the list.

  2. Click the copy button to copy the API key to your clipboard.

Tip: Store your API key securely in a secrets manager or environment variable.

Refer to the Zams API Documentation for details on how to use your API key in requests.