API documentation

Use the Citation Integrity API™ in your workflow.

A plain-language guide to adding Citation Integrity™ scoring, auditing and monitoring to your own application, search engine, chatbot or content platform.

What the API does

One endpoint family, three jobs.

The API lets your software ask CiteAbility™ the same questions our dashboard answers: How well supported is this source? How citeable is this page? Has a source changed since it was last checked?

Score

Send a URL, a claim or an AI answer and receive a structured Citation Integrity Score™ plus dimension breakdowns.

Audit

Request a whole-site or single-page audit and get back findings, recommendations and page-level observations.

Monitor

Register a page or source for rechecking and receive alerts when the integrity picture changes.

Quick start

Get up and running in three steps.

You do not need to be a backend engineer to understand the API. If you can send a web form, you can send an API request.

1

Get an API key

Contact us at hello@citeability.ai or through the contact form. We will create an account, enable the products you need, and issue a secure key.

2

Send a request

Include your key in the request header and send the URL or text you want scored or audited.

cURL example
curl -X POST https://api.citeability.ai/v1/score   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "url": "https://example.com/article",
    "type": "page"
  }'
3

Read the response

The API returns a JSON object with the score, confidence, dimension breakdowns and a plain-language summary.

Example response
{
  "object": "score",
  "id": "score_01JXYZ",
  "url": "https://example.com/article",
  "overall_score": 74.2,
  "confidence": "medium",
  "status": "PARTIAL",
  "dimensions": {
    "source_authority": 82,
    "entity_authority": 65,
    "evidence_citations": 71,
    "first_hand_experience": 58,
    "content_quality": 79,
    "technical_accessibility": 88,
    "integrity_analysis": 81
  },
  "summary": "The page is well sourced but the author is not clearly identified and some claims rely on second-hand reporting."
}

Endpoints

The three main calls.

All endpoints are versioned, use HTTPS, and return JSON. Base URL: https://api.citeability.ai/v1

POST/score

Score a single page, URL, claim or AI-generated answer. This is the fastest way to add a Citation Integrity™ check to a chatbot, search result or review pipeline.

FieldTypeWhat it means
urlstringThe page or source to score.
typepage | answer | claimWhat kind of object you are scoring.
textstring (optional)The answer text when type is answer.
strictnessstandard | strictHow conservative the scoring should be.
POST/audit

Run a Citation Integrity Audit™ on a whole website or a single page. Returns the audit object, pages checked, findings and recommendations.

FieldTypeWhat it means
urlstringThe starting URL of the site or page.
scopesite | pageWhether to crawl the site or check one page.
max_pagesnumber (optional)Maximum pages to audit. Defaults to 10.
POST/watch

Add a page or source to the monitor list. The Citation Integrity Monitor™ will recheck it and notify you when the score changes significantly.

FieldTypeWhat it means
urlstringThe page or source to watch.
notify_emailstring (optional)Where change alerts should be sent.
check_intervaldaily | weeklyHow often to recheck.

Reading responses

What each response field means.

The API is designed to be readable by people, not just machines. Here is what you will see in every score or audit response.

overall_score

A number from 0 to 100. Higher means the source is better supported, attributed and accessible.

confidence

low, medium or high. Tells you how much evidence the engine had to work with.

status

PASS, PARTIAL or REVIEW. A plain decision you can use to route content or flag answers.

dimensions

Seven subscores covering authority, evidence, first-hand experience, quality and accessibility.

summary

A short, human-readable explanation of the main strengths and weaknesses.

findings

In audit responses, a list of specific issues with guidance on what to fix and how.

Errors

What happens when something goes wrong.

The API uses standard HTTP status codes and always returns a JSON error object with a message you can show to a user or log internally.

StatusMeaningWhat to do
200OKThe request succeeded.
400Bad requestCheck the JSON body and required fields.
401UnauthorizedYour API key is missing, expired or invalid.
403ForbiddenThis product is not enabled on your account.
429Too many requestsSlow down and respect the rate limit.
500Server errorRetry once; contact us if it persists.

We never return confidential methodology details, weights or internal gate codes in API responses. What you see is the decision output, not the engine internals.

Responsible use

What the API does not do.

The API is a decision-support tool. It improves how systems evaluate and cite sources, but it does not replace human judgment or make absolute truth claims.

It does not eliminate AI hallucinations. It helps you spot when a source is too weak to support an answer.

It does not guarantee truth. It scores evidence, attribution and accessibility so you can decide what to rely on.

It is not a legal or compliance seal on its own. For certified claims, use Citation Integrity Certified™.

Ready to add Citation Integrity™ to your API stack?

Tell us what you are building and we will set up the right endpoints, rate limits and integration support.

Request access