Overview

This guide will help you get started with the Cloro API to monitor AI responses about your brand across different providers and regions.

Prerequisites

Before you begin, make sure you have:
  • A Cloro API key (contact [email protected] to get yours)
  • A tool to make HTTP requests (curl, Postman, Bruno or your favorite programming language)

Step 1: Get Your API Key

To get your API key, please contact us at [email protected]. We’ll set up your account and provide you with your API key.
Keep your API key secure and never expose it in client-side code or public repositories.

Step 2: Make Your First Request

Here’s a simple example to monitor what ChatGPT says about your brand:
curl -X POST https://api.cloro.com/v1/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "What do you know about Acme Corp?",
    "model": "CHATGPT",
    "country": "US"
  }'

Step 3: Understanding the Response

A successful response will look like this:
{
  "success": true,
  "result": "Acme Corp is a technology company known for...",
  "metadata": {
    "provider": "CHATGPT",
    "region": "US",
    "response_time": 2.1,
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Step 4: Monitor AI Providers

Currently, the API supports monitoring responses from:
  • CHATGPT - OpenAI’s ChatGPT
Additional providers will be added in future updates.

Step 5: Track Across Regions

Monitor how AI responses vary by region using the country parameter with ISO 3166-1 alpha-2 country codes:
  • US - United States
  • GB - United Kingdom
  • DE - Germany
  • JP - Japan
  • AU - Australia
  • CA - Canada
  • FR - France
For the complete list of 254 supported countries, see our API reference.

Next Steps