Configuration

After installation, configure your license and AI settings to unlock the full power of Cartographer. All configuration is done within the Cartographer app itself.

License Activation

Your license key ties your Cartographer installation to your specific Dataverse environment and unlocks the features for your plan tier.

  1. 1Open the Cartographer app and navigate to License & Billing in the sidebar
  2. 2Enter your license key in the input field (format: CARTO-XXXXX-XXXXX-XXXXX-XXXXX)
  3. 3Click Activate — Cartographer validates the key against our licensing server
  4. 4On success, the page displays your plan tier, component limit, and expiration date
The license key is bound to your Dataverse Org ID on first activation. If you need to move your license to a different environment, deactivate it first from the current environment, then activate in the new one.
Free plan users: No license key is required. Simply install Cartographer and start using it. You are limited to 20 components and BYOK AI summaries.
Screenshot: License & Billing configuration page

AI Mode

AI Summaries are one of Cartographer's most powerful features. They use large language models to read component metadata and produce plain-English descriptions of what each component does. You need to choose an AI mode before generating summaries.

BYOK

Bring Your Own Key. You provide your own OpenAI or Azure OpenAI API key. Cartographer sends component metadata directly to your AI endpoint. You pay OpenAI or Azure for token usage.

  • Available on all plans (including Free)
  • You control costs and model selection
  • Data goes directly to your OpenAI account

Hosted AI

We handle the AI infrastructure. No API key needed. Component metadata is sent to our secure API which proxies the request to OpenAI. Responses are returned directly to your environment.

  • $149/mo add-on for Professional and Enterprise
  • No API key management needed
  • Unlimited AI summaries included

BYOK Setup: OpenAI

To use your own OpenAI API key with Cartographer:

  1. 1

    Get an OpenAI API key

    Go to platform.openai.com/api-keys and create a new secret key. Copy it immediately — OpenAI only shows it once.

  2. 2

    Ensure you have access to a supported model

    Cartographer works with GPT-4o and GPT-4o-mini. GPT-4o-mini is recommended for cost efficiency. Verify your OpenAI account has access to one of these models.

  3. 3

    Enter the key in Cartographer

    Open Cartographer, go to Configuration, select BYOK as the AI mode, and paste your API key in the OpenAI API Key field.

  4. 4

    Set the endpoint URL

    For standard OpenAI, use the default endpoint:https://api.openai.com/v1/chat/completions

  5. 5

    Select your model

    Choose between gpt-4o (best quality, higher cost) and gpt-4o-mini (good quality, lower cost). For most environments, gpt-4o-mini is sufficient.

  6. 6

    Test the connection

    Click the Test Connection button to verify Cartographer can reach your OpenAI endpoint successfully.

Never share your OpenAI API key publicly. The key is stored securely in the Cartographer configuration record in Dataverse and is only used server-side by the Cartographer plugins.

BYOK Setup: Azure OpenAI

If your organization uses Azure OpenAI Service instead of OpenAI directly, you can configure Cartographer to use your Azure endpoint.

  1. 1

    Deploy a model in Azure OpenAI Studio

    Create a deployment of gpt-4o or gpt-4o-mini in your Azure OpenAI resource. Note the deployment name.

  2. 2

    Get your API key and endpoint

    In the Azure Portal, go to your Azure OpenAI resource and copy the Key and Endpoint from the Keys and Endpoint section.

  3. 3

    Enter the Azure endpoint in Cartographer

    The endpoint format for Azure OpenAI is different from standard OpenAI:https://YOUR_RESOURCE.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT/chat/completions?api-version=2024-02-01Replace YOUR_RESOURCE with your Azure resource name and YOUR_DEPLOYMENT with your model deployment name.

  4. 4

    Enter your Azure API key

    Paste the Azure OpenAI key (not a standard OpenAI key) into the API Key field.

  5. 5

    Test the connection

    Click Test Connection to verify the configuration works.

Azure OpenAI uses a different authentication header (api-key) compared to standard OpenAI (Authorization: Bearer). Cartographer handles this automatically based on the endpoint URL format.

Hosted AI Setup

Hosted AI is the simplest option — no API key management required. We handle the AI infrastructure for you.

How it works

  1. Cartographer sends component metadata to the VerseBlocks API over HTTPS
  2. Our API proxies the request to OpenAI using our own API key
  3. The AI-generated summary is returned directly to your environment
  4. We do not store your component data — it is processed in transit and discarded

Enabling Hosted AI

  1. Ensure you have a Professional or Enterprise plan
  2. Subscribe to the Hosted AI add-on ($149/mo) from your billing portal
  3. In Cartographer Configuration, select Hosted AI as the AI mode
  4. No further configuration needed — summaries will use our hosted service

Pricing

The Hosted AI add-on costs $149/month and includes unlimited AI summary generation. There are no per-token charges — the flat fee covers all usage.

Supported Models

ModelProviderQualityCost
gpt-4oOpenAI / Azure OpenAIExcellent~$0.005 per component
gpt-4o-miniOpenAI / Azure OpenAIGood~$0.0003 per component
For most users, gpt-4o-mini provides excellent results at a fraction of the cost. We recommend starting with gpt-4o-mini and upgrading to gpt-4o only if you need more detailed or nuanced summaries.

Next Steps

With your license activated and AI configured, you are ready to start crawling solutions.