For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu
Docs Home
/
AI Models
Docs Home
/
AI Models
Docs Home
/
AI Models

Model API Keys

Model API keys serve as the authentication and authorization mechanism for the Embedding and Reranking API and enable you to access Voyage AI models through the API. This page describes how to create and manage your API keys in the Atlas UI.

Note

It is named model API key to distinguish it from other API keys in Atlas. You use this key the same way as API keys from other model providers.

Create and Manage Model API Keys

You can create and manage model API keys from the Atlas UI at the organization and project levels. Rate limits apply to the API keys based on whether you created them at the organization or project level.

Required Permissions

To create, update, and delete model API keys:

To view model API keys:

For a complete list of permissions for each role, see Organization and Project Access.

Create an API Key

When you create a model API key at the organization level, link the key to a project. After you create the key, you can't change which project the key is linked to. Rate limits apply to each key in the project.

Note

If you create a model API key through Atlas, as described in the following procedure, the key only authenticates requests to https://ai.mongodb.com/v1/embeddings. Conversely, if you create a key through VoyageAI directly, it will authenticate requests to https://api.voyageai.com/v1/embeddings.

To create model API keys at the organization level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. At the organization level, click Model API Keys under the Services header in the navigation bar.

3

Create the model API key.

  1. Click Create new model API key.

  2. Enter a name for the key.

    Model API keys can't exceed 250 characters.

  3. Select a project from the dropdown to link with the API key.

  4. Click Create.

4

Save the API key.

  1. Copy the model API key and store it in a secure location.

    After you leave the page where the key is displayed, you won't be able to view it again. If you lose it, create a new one.

  2. Click Done.

To create model API keys at the project level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. At the project level, click AI Models under the Services header in the navigation bar.

3

Create the model API key.

  1. If it's not already displayed, select Model API Keys from the navigation bar.

  2. Click Create model API key.

  3. Enter a name for the key.

    Model API keys can't exceed 250 characters.

  4. Click Create.

4

Save the API key.

  1. Copy the model API key and store it in a secure location.

    After you leave the page where the key is displayed, you won't be able to view it again. If you lose it, create a new one.

  2. Click Done.

View an API Key

Organization owners can view and edit all model API keys for the organization at the organization level. Project owners can view and edit only the model API keys for the projects to which they have access.

To view model API keys at the organization level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. At the organization level, click Model API Keys under the Services header in the navigation bar.

For each model API key, the page displays the following:

Column Name
Column Value Description
Name
Name of the model API key.

Secret Key

Redacted model API key associated with the model API key name.

Created On (UTC)

Date in UTC when the user created the model API key.

Last Used (UTC)

Date in UTC when the model API key was last used. Value is Never if the key is new or has never been used.

Project

Name of the project that is linked with the model API key.

Created By

Name of the user who created the key.

Actions

Actions you can take on the key. You can click:

  • to edit the model API key.

  • to delete the model API key.

To view model API keys at the project level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. At the project level, click AI Models under the Services header in the navigation bar.

For each model API key, the page displays the following information about the key:

Column Name
Column Value Description
Name
Name of the model API key.

Secret Key

Redacted model API key associated with the model API key name.

Created On (UTC)

Date in UTC when the user created the model API key.

Last Used (UTC)

Date in UTC when the model API key was last used. Value is Never if the key is new or has never been used.

Project

Name of the project that is linked with the model API key.

Created By

Name of the user who created the key.

Actions

Actions you can take on the key. You can click:

  • to edit the model API key.

  • to delete the model API key.

Edit an API Key

To edit model API keys at the organization level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. At the organization level, click Model API Keys under the Services header in the navigation bar.

3

Edit the key.

  1. In the Actions column, click corresponding to the key that you want to edit.

  2. In the Edit Model API Key page, modify the name of the model API key.

    model API key name must be unique to the project and can be up to 250 characters in length.

  3. Click Save to apply the changes.

To edit model API keys at the project level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. At the project level, click AI Models under the Services header in the navigation bar.

3

Edit the key.

  1. In the Actions column, click corresponding to the key that you want to edit.

  2. In the Edit Model API Key page, modify the name of the model API key.

    The name must be unique in the project and can be up to 250 characters in length.

  3. Click Save to apply the changes.

Delete an API Key

When you delete a model API key, MongoDB immediately disables the key and rejects any API requests made using the deleted key. Once you delete the key, you can't view, restore, or modify it.

To delete model API keys at the organization level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. At the organization level, click Model API Keys under the Services header in the navigation bar.

3

Delete the key.

  1. In the Actions column, click corresponding to the key that you want to delete.

  2. In the confirmation modal, click Delete key to delete the key.

To delete model API keys at the project level, complete the following steps:

1

Log in to Atlas.

2

Go to the AI Models page in the Atlas UI.

  1. If it's not already displayed, select your desired organization from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. At the project level, click AI Models under the Services header in the navigation bar.

3

Delete the key.

  1. In the Actions column, click corresponding to the key that you want to delete.

  2. In the confirmation modal, click Delete key to delete the key.

Next Steps

After creating a model API key, you can:

Next

Organization and Project Access

On this page