Tips

Where Do I Find My Marqo API Key?

July 22, 2024
3
mins read

This article will run through accessing and finding your Marqo Cloud API key.

1. Log in (Sign Up) to Marqo Cloud

You must first navigate to Marqo Cloud and either sign up (if you haven’t already) or log in to your existing Marqo Cloud account.

Figure 1: Marqo Cloud sign in/sign up portal.

You will be greeted with our Marqo Cloud UI:

Figure 2: Marqo Cloud UI Platform.

2. Navigate to ‘API Keys’

You can find the 'API Keys' header on the lefthand side navigation bar. When navigating to the ‘API Keys’ header for the first time, your Marqo Cloud will look like this:

Figure 3: Marqo Cloud 'API Keys' UI.

Notice, you have a default API key.

Figure 4: API Keys section with default API Key on the Marqo Cloud UI.

You are welcome to use this API key going forward. Simply press the ‘copy’ icon to the righthand side to copy your API key. You can also press the ‘eye’ icon to view your API key. There is the option to delete the API key too but please take care when doing this.

If you decide you want to create a new API key, you can do as follows.

3. Creating Your API Key

Click on the ‘+ New API Key’ icon in the top right corner of the ‘API Keys’ section.

Figure 5: Image illustrating where you can create a new API Key in Marqo Cloud.

After pressing this, you will be prompted to put in your desired API Key name.

Figure 6: Creating a new API Key on Marqo Cloud.

Once you are happy with your name, click ‘Create API Key’. This will generate a new key for you that will be visible in the ‘API Keys’ header.

Conclusion

Awesome, now you have your Marqo API Key, you can begin creating indexes on Marqo Cloud or using our embedding model tuning platform, Marqtune. Happy coding!

Ellie Sleightholm
Head of Developer Relations at Marqo