API Reference › Introduction › Quickstart

Quickstart

Send your first request to the cloro API in a couple of minutes, from generating a key to reading back a structured monitoring result.

Overview

This walkthrough takes you from a fresh account to a working call against the AI monitoring endpoints. You will provision an API key, submit a prompt to a target model, and inspect the JSON payload that comes back. Everything here uses standard HTTPS and a bearer token, so any HTTP client will work.

1. Provision an API key

Sign in to your cloro dashboard and open the API keys section. Create a key, copy it once, and store it somewhere safe — it is shown in full only at creation time. Every request must carry this key in the Authorization header.

2. Send a monitoring request

The example below asks ChatGPT what it knows about a brand and returns the model's answer together with any cited sources. Swap in your own key and prompt.

POST https://api.cloro.cloud/v1/monitor/chatgpt

curl -X POST "https://api.cloro.cloud/v1/monitor/chatgpt" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "What do you know about Acme Corp?",
    "country": "US"
  }'

Request parameters

Field	Type	Description
prompt	string	The question or instruction sent to the target model. This is the text whose response cloro captures.
country	string	Two-letter country code that sets the geographic context for the query, letting you observe region-specific answers.

3. Read the response

A successful call returns a top-level status flag alongside a result object. The result holds the model's answer text and, when available, the list of sources it referenced.

{
  "success": true,
  "result": {
    "text": "Acme Corp is a fictional corporation that appears in many cartoons.",
    "sources": []
  }
}

Response fields

Field	Type	Description
success	boolean	Indicates whether the request completed without error.
result	object	Container for the captured answer and its supporting data.
result.text	string	The response text produced by the target model for your prompt.
result.sources	array	Citations or reference links surfaced in the answer; empty when none were provided.

Notes

Keep your API key server-side and never expose it in client applications. If a request fails, check that the header reads Bearer YOUR_API_KEY and that the JSON body is well formed. For help getting set up, reach us at [email protected].