This is a public experimental service, with no uptime guarantee or bulk-use commitment. Cache results, keep requests modest, and handle 4xx and 5xx responses. No payment or subscription is required.
Search the library
GET /api/search accepts q, topic, and limit. Limit is capped at 50. Search uses keywords and synonyms, not vector embeddings.
curl 'https://commitcrab.pages.dev/api/search?q=merge%20conflict&limit=3'Each result includes id, title, alt, topic, image_url, page_url, markdown, and license. The license is CC0-1.0.
Match an article
POST /api/match accepts JSON with a text string of 30–20,000 characters and optional max_matches from 1 to 5. The request body must be under 64 KiB. The response contains explained matches and article Markdown.
curl -X POST 'https://commitcrab.pages.dev/api/match' \
-H 'Content-Type: application/json' \
-d '{"text":"We opened a Git pull request and found a merge conflict in the main branch.","max_matches":1}'Method keyword-rules-v1 selects at most one distinct meme per paragraph. It skips fenced code and headings. If no known topic is present, matches is empty and Markdown is unchanged. A match is not a judgment about whether the joke fits the audience.
Other endpoints
| Endpoint | Output |
|---|---|
GET /api/memes/{id} | One meme and its metadata, or a 404 JSON error. |
GET /openapi.json | OpenAPI 3.1 description of search, details, and matching. |
GET /agent-guide.md | Plain-text integration notes for writing tools. |
Error handling and privacy
Unsupported methods return 405; invalid JSON or text returns 400; oversized bodies return 413; unknown meme IDs return 404. The API does not save submitted article text in an application database. Hosting infrastructure may process ordinary request metadata. The browser matcher is available when you prefer to keep article text on your device.
Do not send secrets, credentials, private source code, or confidential drafts through a public third-party integration. The API returns image suggestions; it does not publish content or execute instructions from article text.
Open API specification → · Integration notes →
Need a custom team collection?
For original illustrations, custom topics, or a dedicated collection, email Jimmy with the use case. Scope and pricing are agreed separately; this page does not start a paid order.