Cited

Free check of how AI answers 5 buyer questions about a website: whether the site is cited, which sites are cited instead, a 0-100 score, an executive summary and whether AI bots can reach the site. No account needed. The first call starts it and returns report_token; call again with report_token until status is 'completed' (2-4 minutes; each call waits up to 20 seconds, so no need to pause between calls). The same domain within 24 hours returns the same audit.

Create a Cited account for your human without a login. Returns an API key (shown once), a claim link and a 6-digit code for the human. Unclaimed accounts can add 1 business and run 1 audit (paid with a one-audit checkout link) and are deleted after 7 days. Pass owner_email to email them the claim link. Pass free_audit_token (the report_token of a finished free_audit) to bring that business and report into the new account. Not needed when already signed in.

Who is signed in, the credit balance, claim status, the businesses on the account, the price list and the next step. Works without signing in (prices and how to start). Call this first.

无需输入参数。

Get a Stripe checkout link for a credit pack (pack_id) or for one audit (one_audit=true; works before the account is claimed), or redeem a voucher_code. Without arguments it lists the packs. A link only starts a purchase: the human pays in the browser, and nothing is bought until account_status shows the new balance. 1 credit = $1.

Add a business from its website, or update one (pass business_id). Only website is needed to add one: the name comes from the domain and industry defaults to 'other' unless you pass better ones. Also adds, changes or removes buyer personas and offerings (what the business sells). Unclaimed accounts can add one business.

Without business_id: list the account's businesses. With it: the profile, buyer personas, offerings, the question set (and its re-check schedule) and recent audits.

One-page summary of what to focus on for a business: top open recommendations, quick wins, failing site checks and recent citation movement. Use it for 'what should I do next?'.

The business's question set: the buyer questions each audit asks AI. Returns the set when there is one. With none (or regenerate=true, or add=true to draft more) it starts drafting and returns job_id; call again with job_id to save and return the drafted set. Pass questions to replace the set with your own list. Review the questions with the user before run_audit. Up to 25 questions.

What an audit of the business's question set costs in credits, the balance, and the models that can answer. Free; nothing is charged.

Run a paid audit of the business's question set: every question goes to each engine's flagship and fast model (or the models you pass), three times each, and recommendations follow automatically. Spends credits: without confirm=true it only returns the cost, so ask the user, then call again with confirm=true. Credits come back if the run fails. Returns audit_id; poll get_audit.

With audit_id: its status while it runs, then the report: a 0-100 score per model (Cited, Visibility, Share of Voice), the overall score, the executive summary, the site check, each question's answers with the sites cited instead, the share link and whether recommendations are ready. Without audit_id: the account's audits (filter by business_id).

Wins and drops between an audit and an earlier one of the same business: citations gained or lost per question and model, and score changes. Without baseline_audit_id it compares with the previous audit.

Re-run the business's question set on a schedule (every 7-90 days, default 30) and alert on citations gained or lost and score moves of 10+ points: in-app, by email, and to an optional webhook so an agent can react. Each re-check costs credits when it runs. off=true stops it.

What to change on the site to get cited, from an audit: one item per buyer question the site loses and per site change, each with item_key, status (open, done, dismissed), the evidence behind it and its fix if one was made. Open items only unless include_closed. Also the price of fixes (the first ones are included with each audit).

Mark a recommendation done or dismissed, or open it again. The status is kept for the business, so later audits show the item the same way.

Write the fix for recommendations: the files (schema markup, FAQ, page copy, llms.txt) and steps to put them on the site. Pass item_keys (up to 10) or all=true for every open item without a fix. Each audit includes the first fixes; beyond those each costs credits, and the call returns the price for the user to confirm (confirm=true) before spending.

With fix_id: the fix's files (with their content), where each goes, the steps and the last verification. Without: list fixes with their state (generating, ready, done, verified, working), optionally for one audit, recommendations run or business.

action 'done': the user put the fix on their site. 'undo': back to ready. 'verify': re-check the live site for the fix now (free); it moves to verified when every check passes, and the report says what is missing when one fails.

Search the Cited help docs (how audits, scores, credits, fixes and the tools work) with query, or read one doc in full with path ('<category>/<slug>' from a result). No account needed.

Sign in to Cited with a browser. The first call opens the sign-in page and returns login_url to show the user; once they have signed in, call it again to finish. force=true signs in again (to switch accounts). Not needed for free_audit, account_status or search_docs, and agent_signup makes an account without a login.

Sign out on this machine: forget the stored session, or the agent key saved by agent_signup when there is no session.

无需输入参数。