Quickstart

Request access

Access is reviewed before a key is issued. To request one, POST your email to /v1/keys/request as shown on API keys.

Receive your key after review

Your key arrives by email as a single-use claim link. The key is shown exactly once, so store it somewhere safe.

Export the key

Every request carries your API key as a bearer token. Keys look like ck_....

export CLASSIFY_API_KEY=ck_your_key_here

Run the curl

Up to 1000 URLs per request.

curl -s -X POST https://api.classify.ai/v1/classify \
  -H "Authorization: Bearer $CLASSIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": ["https://en.wikipedia.org/wiki/Electric_vehicle"]}'

Read the response

{
  "results": [{
    "url": "https://en.wikipedia.org/wiki/Electric_vehicle",
    "status": "classified",
    "classifications": [
      { "iab_code": "22",
        "iab_name": "Automotive > Auto Type > Green Vehicles",
        "confidence": 0.87 }
    ]
  }],
  "count": 1,
  "latency_ms": 13
}

Each result carries url, status, and classifications. status is classified when the index holds the URL. URLs the index does not hold return status unknown. Each classification carries its classification path in iab_name, the path id in iab_code, and confidence, higher being better. count and latency_ms describe the call.

Try search

curl -s -X POST https://api.classify.ai/v1/search \
  -H "Authorization: Bearer $CLASSIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "electric vehicle tax credits", "limit": 10}'

{
  "query": "electric vehicle tax credits",
  "results": [
    { "url": "https://www.example.com/ev-incentives",
      "title": "EV incentives explained",
      "description": "A short summary of the page." }
  ],
  "count": 1,
  "latency_ms": 640
}

Results carry url, title, and description; title and description may be null. See Search for the full shape.

Getting started

Guides

Account