Getting Your API Key

API keys are essential for authentication and interacting with Weave's endpoints.

Welcome to Weave API documentation. You can interact with Weave through our REST APIs.

Current limitations:

  • Only 50 active API keys per user.

  • Each account is limited to 500 API requests per minute.

    • If this limit is exceeded, API requests will be temporarily suspended until the following minute.

    • This limit is currently the same across all plans, and subject to change at a later stage.

How to Generate an API Key

Here's how to generate your own API key to get started:

Steps to Generate an API Key:

  1. Click on the Profile menu on the top right corner.

  2. Select Settings.

  3. Go to the API Keys section.

  4. Click on the + Create API Key button to generate an API key,

  5. Remember to store it securely as it will only display once. For security purposes, do not share your API key with others.

You may also generate your API through the Prompt page or the Workflow page:

Revoke API Key

Revoking an API key is an important security measure that may be necessary if the key is compromised or no longer needed. When you revoke a key, any code that uses that key can no longer make API calls. You have to update the code with a new active key to make it work again. To revoke your API key:

  1. Go to Settings.

  2. Select the API Keys section.

  3. Go to your active key and click on the three menu dots (…)

  4. In the drop down, select Revoke.

  5. In the confirmation pop-up, enter the name of your API key to complete the revoke process.

Last updated