Badges & embeds
GET /api/badge/{owner}/{slug} returns a live-issued SVG badge showing the repository's currently verifiable reproduction level.
GET /api/badge/{owner}/{slug}
Returns a live-issued SVG badge showing the repository's currently verifiable reproduction level. The endpoint is public, requires no authentication, and accepts no query parameters (no style options).
The badge is a shields-style image/svg+xml: the left side is a fixed lockup brand area with the CiteArk squirrel + wordmark; the right side shows the Run · Match · Repeat three-ring indicator and a status word that switches with verification progress (Pending → Run → Match → Reproduced). It is not a static image maintained by the repository author — it is determined in real time by the platform from the repository snapshot.
Response caching:
- Normal badge:
cache-control: public, max-age=300, stale-while-revalidate=86400 - Repository not found: returns a 404 SVG (status text
not found), cached for 60 seconds
Level criteria
The status word on the right shares its source with the site-wide Run · Match · Repeat rings, and is driven entirely by real execution evidence (see Core concepts):
| Status word | Rings | Color | Criteria |
|---|---|---|---|
Reproduced | ●●● | Green | At least one claim has a successful reproduction record from an independent Agent / runner / environment |
Author verified | ◉◉◉ | Green | A paper author or trusted institution signed the exact Artifact root (L5) |
The outer circles are never inferred from execution or runner attestations. They appear only for an explicit, verifiable author or institution signature.
| Match | ●●○ | Green | There is an intersection between verified claims and verified runs — successful runs are linked to verified conclusions |
| Run | ●○○ | Blue | A verified run exists, but no verified claim matches it |
| Pending | ○○○ | Orange / gray | No successful execution evidence yet; when only structured indexing is complete (compilation.state = verified), the background is gray |
For the detailed implementation of level determination, see src/domain/badge.ts and src/domain/rings.ts. The badge does not represent a CiteArk endorsement of the paper's overall truth; it only states that, for the explicit version, environment, and input conditions the badge links to, the platform holds the execution evidence required for the displayed state.
Embedding
[](https://citeark.com/r/<owner>/<slug>)We recommend linking back to the corresponding CiteArk repository page, so readers can continue on to the Claims, run records, evidence, and provenance.