Skip to main content

How do I create or manage API keys?

To use the API, you need an authentication "key" or "token". Learn how to create and manage your API keys for programmatic data access.

Updated this week
Note: The API is currently restricted to active Verdigris customers.

Creating a new API key

If you're a Verdigris customer and are interested in using the API, you will need an API Key. You can generate your own API key or multiple keys for different activities through the Verdigris Admin Console.

  1. Go to the Admin Console at admin.verdigris.co to access your profile.

  2. Select Users & API Keys at the top of the screen.

  3. Click the API Keys tab.

  4. Click Create New Key.

  5. Enter a name and description for the key. Use these fields to help you identify which key is used for different projects.

  6. Click Create.

  7. Copy and save the Client ID and Client Secret shown on the screen.

    • โš ๏ธ Important: This is the only time you will see the Client Secret. Be sure to copy it to a safe location.

    • If you lose it, you will need to create a new API key.


Using your API key

  1. Use the Client ID and Client Secret to request a bearer token by making a call to:
    โ€‹https://auth.verdigris.co/oauth/token

  2. For the call to get a token, use the request header and body below. Replace "my_client_id" and "my_client_secret" with your actual Client ID and Client Secret.

import requests url = "https://auth.verdigris.co/oauth/token" 

headers = {"Content-Type": "application/json"}

body = { "client_id": "my_client_id",
"client_secret": "my_client_secret",
"grant_type": "client_credentials",
"audience": "https://api.verdigris.co/" }

response = requests.post(url, headers=headers, json=body) print(response.json())

The response will include your bearer token. Use this token to authenticate API requests.


Managing API keys

  • You can view all your API keys in the API Keys tab.

  • Each key shows its name, description, and API key value.

  • To revoke access, click Delete next to a key.

Did this answer your question?