Contract status badge
The latest run's verdict as an SVG badge, for a README or a directory listing: green with the number of checks that passed, red with the number that failed, or grey when nothing has been run. Drawn by this API from the same record GET /v1/contract serves, so the badge and the page cannot disagree. Cached for five minutes.
- stringheader
Optional. Without a key this endpoint answers under the public policy; a key raises your limits and unlocks plan-gated fields.
Authorization: Bearer <key>is accepted in its place.
- string
Which product to report:
apifor this REST API,mcpfor the hosted MCP server,fitmentfor the attachment compatibility suite.- Accepts
- string
Which environment's run to report. Production unless asked otherwise.
- Accepts
- string
The wording on the grey half. Defaults to
api contractormcp health. Bounded because it is drawn into an image.- Max length
- 40
- Example
- string
Set
0to draw the badge without the mark, for a row of badges that carry their own.- Accepts
- Example
- 400
VALIDATION_ERROR - 429
RATE_LIMITED - 500
INTERNAL_ERROR
- Minimum tier
- Explorer+
- Monthly quota
- 200/mo
- Rate limit
- 10/min
- Daily cap
- 50
Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.