Developer Resources
Machine-readable interfaces for agents and developers integrating with saimshafique.com. Everything here is public, unauthenticated, and read-only. The full API surface is described in the OpenAPI specification.
When to use these resources
- You are an AI agent asked about Saim Shafique and need citable facts — fetch llms.txt, then the page-level markdown mirrors listed there.
- You render pages without executing JavaScript — request any URL with an
Accept: text/markdownheader, or fetch the.mdpath directly. - You want the whole API surface in one file — fetch
/openapi.json. - You hit a broken link — unmatched paths return a real HTTP 404 with markdown recovery links,
and JSON errors under
/api/*.
Endpoints
| Resource | URL | Format |
|---|---|---|
| Agent site guide | /llms.txt | text/plain |
| Status & discovery | /api/v1/status (alias: /api/status) | application/json |
| OpenAPI specification | /openapi.json | application/json |
| Page content API | /api/v1/markdown?url=… (&format=json for structured output) | markdown / JSON |
| Markdown negotiation | GET / with Accept: text/markdown | text/markdown |
| Markdown mirrors | /projects/skillcheck.md (+ every page) | text/markdown |
| Structured 404 errors | any /api/* path | application/json |
| Sitemap index | /sitemap.xml | XML |
Versioning, rate limits & stability
- Version 1, addressable as
/api/v1/*(preferred) or via unversioned aliases (/api/status,/api/markdown) that track the latest stable version. Every response carriesX-API-Version. - Breaking changes ship only under a new path version; deprecations are announced
here and signalled with a standard
Sunsetheader before anything is switched off. - Rate limit: 600 requests per 60 s per serving instance. Responses include
RateLimit-Policy,RateLimit-Limit,RateLimit-Remaining, andRateLimit-Reset; exceeding it returns HTTP 429 with aRetry-Afterheader and a structured JSON error.
Example requests
# Ask for markdown instead of HTML
curl -H "Accept: text/markdown" https://saimshafique.com/
# Fetch the OpenAPI spec
curl https://saimshafique.com/openapi.json
# Service status with resource discovery
curl https://saimshafique.com/api/status
# Structured JSON error from an unknown API path
curl https://saimshafique.com/api/no-such-endpoint
CLI tool
The official CLI published under this name is SkillCheck —
@sx4im/skillcheck on npm. It A/B tests AI-agent skill files through
blind-graded trials and returns a HELPS, PLACEBO, or HARMS verdict.
npm install -g @sx4im/skillcheck
Usage and case study: SkillCheck project page.