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. Ohne Schlüssel antwortet dieser Endpunkt nach der öffentlichen Richtlinie; ein Schlüssel erhöht Ihre Limits und schaltet planabhängige Felder frei.
Authorization: Bearer <key>wird ebenfalls akzeptiert.
- string
Which product to report:
apifor this REST API,mcpfor the hosted MCP server,fitmentfor the attachment compatibility suite.- Akzeptiert
- string
Which environment's run to report. Production unless asked otherwise.
- Akzeptiert
- string
The wording on the grey half. Defaults to
api contractormcp health. Bounded because it is drawn into an image.- Max. Länge
- 40
- Beispiel
- string
Set
0to draw the badge without the mark, for a row of badges that carry their own.- Akzeptiert
- Beispiel
- 400
VALIDATION_ERROR - 429
RATE_LIMITED - 500
INTERNAL_ERROR
- Mindeststufe
- Explorer+
- Monatskontingent
- 200/mo
- Anfragerate
- 10/min
- Tageslimit
- 50
Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.