Using API Explorer

This quickstart steps you through the process of:

  • Creating a Cloud Storage bucket.
  • Uploading your image to Cloud Storage and making it public.
  • Making a request to the Vision API with that image.

These steps should take about 5 minutes to complete. You can store up to 5GB of data in Cloud Storage for free and make up to 1000 feature requests to the Vision API for free per month.

Before you begin

If you haven't done so already, set up your project and create a Google Cloud Storage bucket, as explained below.

Set up your project

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.

  4. Enable the Cloud Vision API.

    Enable the API

Create a Cloud Storage bucket

  1. In the Cloud Console, go to the Cloud Storage Browser page.

    Go to Browser

  2. Click Create bucket.
  3. On the Create a bucket page, enter your bucket information. To go to the next step, click Continue.
    • For Name your bucket, enter a unique bucket name. Don't include sensitive information in the bucket name, because the bucket namespace is global and publicly visible.
    • For Choose where to store your data, do the following:
      • Select a Location type option.
      • Select a Location option.
    • For Choose a default storage class for your data, select the following: Standard.
    • For Choose how to control access to objects, select an Access control option.
    • For Advanced settings (optional), specify an encryption method, a retention policy, or bucket labels.
  4. Click Create.

Make a request to the Cloud Vision API service

  1. Download demo-img.jpg. (You may need to right-click the link.)

  2. Open the Cloud Console Storage Browser.

  3. Select the bucket you created in the previous section.

  4. Click Upload Files and select the demo-img.jpg file to upload from your local machine to your Cloud Storage bucket.

    This is the image file that you just uploaded:
    women biking in Jakarta image
    Image credit: Rohiim Ariful on Unsplash.

  5. After the file is uploaded and listed in the Cloud Storage Browser, share the image publicly.

  6. Complete the interactive API Explorer template, below, by replacing cloud-samples-data/vision in the image.source.imageUri field with the name of the Cloud Storage bucket where you uploaded the demo-img.jpg file. The request body should look like the following:

    {
      "requests": [
        {
          "features": [
            {
              "type": "LABEL_DETECTION"
            }
          ],
          "image": {
            "source": {
              "imageUri": "gs://cloud-samples-data/vision/demo-img.jpg"
            }
          }
        }
      ]
    }

  7. Click Execute to send the request to the service. The JSON response appears above.

Congratulations! You've made your first images.annotate request to the Cloud Vision API service.

Clean up

To avoid unnecessary Google Cloud Platform charges, use the Cloud Console to delete your Cloud Storage bucket (and your project) if you do not need them.

What's next

  • See a list of all feature types and their uses.
  • Get started with the Vision API in your language of choice by using a Vision API Client Library.
  • Use the How-to guides to learn more about specific features, see example annotations, and get annotations for an individual file or image.
  • Learn about batch image and file (PDF/TIFF/GIF) annotation.
  • Browse through a comprehensive list of client library code samples.
  • Browse more specific use cases on the community tutorials page.