Cloud Vision API Setup

Optional guide for enhanced text recognition

The first 1,000 scans per month are always free. This is more than enough for normal use.

Do not share your API key with others. Any usage of your key counts against your quota and may result in charges to your account.

Why use Cloud Vision?

The built-in on-device text recognition works well for most items. However, if you're experiencing issues with certain items or want potentially better accuracy, you can optionally enable Google Cloud Vision for cloud-based text recognition.

This is completely optional — the app works perfectly fine without it.

Setup Instructions

Sign in to Google Cloud Console

Go to console.cloud.google.com and sign in with your Google account.

If you don't have a Google account, you can create one for free.

Create a new project

In the top navigation bar, click on the project dropdown and select "New Project".

Enter any name, for example exile-companion, and click "Create".

Enable Cloud Vision API

In the left menu, go to "APIs & Services" → "Library".

Search for Cloud Vision API and click on it.

Click the "Enable" button.

Set up billing

Google requires an active billing account to use Cloud Vision, even for the free tier. You will not be charged as long as you stay within 1,000 scans per month.

  1. Go to Billing in Google Cloud Console
  2. If you don't have a billing account, click "Create account"
  3. Enter a name for your billing account and select your country, then click "Continue"
  4. Add a payment method (credit card), then click "Submit and enable billing"
  5. Go to the "My projects" tab, find your project
  6. Click the Actions menu (⋮) → "Change billing"
  7. Select your billing account and click "Set account"

Create an API key

Go to "APIs & Services" → "Credentials".

Click "+ Create Credentials" → "API Key".

Your key will be created and displayed. Copy it.

Paste the key in the app

Open Exile Companion and go to Settings → Recognition.

Enable the Cloud Vision toggle and tap "Configure".

Paste your API key and tap "Save".

Done! Cloud Vision is now enabled for text recognition.

Frequently Asked Questions

How much does it cost?

The first 1,000 scans per month are free. This is more than enough for most players. After that, it costs $1.50 per 1,000 scans.

Is it secure?

Yes. Your API key is stored only on your device. We do not have access to your key or Google account.

Can I use one key on multiple devices?

Yes, you can use the same key on all your devices. The 1,000 request limit is shared across all devices.

How do I remove the key?

In the app, go to Settings → Recognition → Cloud Vision section and tap "Remove".

How do I check my usage?

Go to Google Cloud Console → "APIs & Services" → "Dashboard" to view your usage statistics.

Forgot your key or need a new one?

In Google Cloud Console → "APIs & Services" → "Credentials" you can view existing keys or create a new one.

Troubleshooting

"API access denied" error

If you see this error, check the following:

  1. Is the Cloud Vision API enabled? (Step 3)
  2. Is billing set up and linked to your project? (Step 4)
  3. Does your API key have restrictions that block Cloud Vision?