📖
/ THE PRODUCT LLM /
HomePlayground
  • 👋Welcome
  • Getting Started
    • 🏃‍♂️Quickstart
  • Endpoints
    • 🔎/search-products
    • 🧠/match-products
    • 🔎/search-and-match
  • Topics
    • 📖Guidelines for Input Data
    • 📦Product Field
    • ‼️ Error Types
  • 🚨 Alerts
Powered by GitBook
On this page
  • Make your first API request in the playground
  • Making your own request locally
  • Addressing Errors
  • Endpoint documentation
  1. Getting Started

Quickstart

Let's get you to a working API request!

Last updated 22 days ago

Make your first API request in the playground

The easiest way to make a request is from the playground.

Create an account at https://app.theproductllm.com. Once logged in, you can make plenty of free API calls and view the code and the results associated with your API query. Simply toggle between "view code" and "view results."

Making your own request locally

Making your own request is easy with the code provided.

  1. Get your API key from https://app.theproductllm.com

  2. Insert your API key into your request header: {"Authorization": "Bearer <insert api key>"}

  3. Send your payload by copy pasting the playground code or use more advanced options in the Endpoints section

Addressing Errors

Endpoint documentation

See the section and the request structure for the relevant endpoint. 400-499 errors indicate an issue with how the request was made. If you encounter a 401 error, check your api key and/or your account health. To the extent possible, error messages should include details on what caused the error.

🏃‍♂️
errors
/search-products
/match-products