DocsThe API

Reference3 min readUpdated

The API

Every answer clickd gives is JSON under /api/v1, and the MCP tools at /mcp are written on top of it. The same figures a person sees, for scripts and agents.

Every call, in full

The API reference at /docs/reference lists every call with its arguments, who may make it, and an example to copy, and lets you try each one with your key. It is also at /docs/reference.md for an agent and /docs/openapi.json for anything that reads OpenAPI.

How do I call the API?

Send your key as a bearer token to an address under /api/v1, such as /api/v1/sites/example.com for a site’s latest read. Every reply is JSON, and a site is named by its domain. To read what one tool is for before its arguments, each has a page of its own.

Keys

A key starts mk_ and is shown once, when it is made. It reaches the sites you have claimed, their reads and jobs, your account and the rulebook. With no key, an agent may list the tools over MCP, sign its person up with mttr_signup, and read what the website shows anyone: the rulebook, the leaderboard, a site’s public report and the free checks, 60 calls an hour from one address. Everything else needs a key.

Asking

Example
curl https://clickd.com/api/v1/sites/example.com \
  -H "Authorization: Bearer $CLICKD_KEY"

Calls

CallWhat it returns
GET /rulesEvery rule, with its stage, weight and fix
GET /sitesThe sites read, 25 at a time, sorted by score unless sort says otherwise
GET /sites/{site}The latest read: score, stages, and every fix with the pages failing it
GET /sites/{site}/briefThe fix list as Markdown, to hand to an agent
GET /sites/{site}/planThe fixes worth the most as steps, each with its pages and points, and the words to hand an agent
GET /sites/{site}/citationsWhat assistants were found to cite, question by question, and the credits left
GET /sites/{site}/pagesEvery page read, with its status, depth, words and failing rules
GET /sites/{site}/changesWhat the latest read changed against the one before
GET /sites/{site}/compare?with={other}Two sites rule by rule; add view=content to set their pages side by side by meaning
GET /sites/{site}/competitorsSites near it doing similar work, and similar sites elsewhere
GET /sites/{site}/tellsPages with signs of generated text, such as hidden characters
POST /sites/{site}/rescanPuts the site in line to be read again, with an optional reason

Two rules every reply keeps

  • A score never travels without what it does not mean: every reply that carries one carries caveat, which says “A score says pages are well formed. It does not say an assistant cites the site.”
  • Words that came from a scanned site travel only under a key that says so, such as quoted, so a site cannot steer the agent that is fixing it.

Errors

StatusWhen
400The address cannot be read, such as a private one, or an argument is missing
401Visits were sent without the site’s visits key. Over MCP a call with no key is not a 401: a tool open to anyone answers, and any other answers with isError and says to sign up
403The key does not reach that call, or the site was removed from clickd
404The site was never read or is not yours, there is no such call, or no key was sent. Without a key the API says nothing more, not even that a call exists
405The call needs another method, such as POST for a fresh read
409It cannot be done yet, such as a claim whose record or file is not found, or a brief whose page is not live
413The body is too large
422The page was read but lacks what the check needs, and the reply says what
429Too many at once, or a read asked for too soon; the reply says when to try again
502clickd could not reach the site to read it; the reply says why
503This server cannot do that, such as sending a link when it signs none

Limits

  • A site is read at most once every 10 minutes, whoever asks.
  • A key asks for fresh reads of sites it has not claimed within an hourly allowance. Reports already kept are not limited, and a claimed site is read whenever it is asked for.
  • The free checks of one page, such as the product check, share the free tools’ hourly allowance for each key.

Sources

This page as Markdown