How to Use the Product Studio Text API

Product Studio is a suite of generative-AI tools that aims to simplify merchant workflows. This document is focused on title and description generation and explains how to use the alpha version of the Product Studio Text (Titles and Descriptions) API to generate or optimize titles and descriptions.

What can you use the API for?

  • You can get a suggested product title and description using ONLY your product image.
  • Generating SEO optimized titles for your products.
  • Generating customly formatted titles for your products.
  • Generating product descriptions from your product feed.

For more detailed examples, see the cookbook.

Example TiDe generations

Quickstart

Already have your Google Cloud account configured? Add your info to this Colab to get started.

Example integration for the Text API

Configuration settings for the Text API

Full Integration Guide

To get started with the Product Studio Text API a few things need to be true:

  1. You need an active Google Cloud Account
  2. You need an active Google Cloud Project
  3. We have enabled the API for the email address associated with your Google Cloud account
  4. You have enabled the API under "APIs & Services" on your Google Cloud Project - link
  5. You have provisioned an API key under "APIs & Services > Credentials"
  6. You have a programming environment you can send HTTP requests from - Colab example

Create a Google Cloud Account and Project

You likely already have an active Google Cloud account and project, but if you don't, navigate to https://cloud.google.com/ and follow the sign-up flow.

alt-text

Getting Added to the API Allowlist

Contact us with the email address associated with your Google Cloud account. If you are signed in to Google Cloud, you can find the associated email here:

alt-text

Once we have added you to the allowlist, you can move continue to the next step.

Enable the API under "APIs & Services"

Visit your console API settings or navigate to the "APIs & Services > Enable APIS AND SERVICES" on your Google Cloud Console.

alt-text

Then search for "Product Studio".

alt-text

And enable the API.

alt-text

Provision an API Key

Navigate to "APIs & Services > Credentials" to add a new API key credential to your Google Cloud Project.

alt-text

Click "Create Credentials > Create API Key", and you will see this screen.

alt-text

Copy and save the API key in a secure location for usage in the API.

Set up Your Programming Environment

Set it up however you want. We have a Colab that you can use as a starting block for your integration. If you prefer not to use Colab, we have also created a GitHub gist.

alt-text

Congratulations!

You have on boarded to the Product Studio Text API. Proceed to the Code Examples section to learn how to use the API in more detail.