Setting Up Data Dictionary API Keys

Overview

Arovy's Data Dictionary API allows your development team to programmatically access your documented data dictionary — enabling use cases like internal LLM integrations and automated data pipelines. This article walks you through generating an API key and handing it off to your developers.

Applies to: Arovy Data Dictionary | Feature: API Keys
 

Prerequisites

• An Arovy account with admin or settings access
• A populated Data Dictionary (fields documented and ready to expose via API)
• A developer or technical team ready to integrate

Estimated Time

~2 minutes

Step-by-Step Instructions

Step 1: Open Settings

1. Click your initials in the top-right corner of the Arovy interface.
2. Select Settings from the dropdown menu.

Step 2: Navigate to API Keys

1. In the Settings submenu, click API Keys.

   This page lists all existing API keys for your Data Dictionary.

   

Step 3: Create a New API Key

1. Click Create New Key.

   Arovy generates a new API key and adds it to the list.

2. Click the reveal icon (eye) next to the key to expose the full key value.
3. Click Copy to copy the key to your clipboard.

Step 4: Share the Key with Your Development Team

1. Pass the copied key to your developer or technical team via your preferred secure channel.

2. Direct them to the Arovy API documentation, which uses this key in all examples and explains exactly how to authenticate and query the Data Dictionary.

   Security note: Treat API keys like passwords. Avoid sharing them over email or chat in plain text where possible. If a key is compromised, return to the API Keys page and delete it, then generate a new one.

Expected Results

After completing these steps:

• A new API key appears in the API Keys list under Settings
• Your development team can authenticate against the Arovy API using the key
• All API calls will return data from your current, maintained Data Dictionary

Troubleshooting