{"uid":"cap_wMdpRDk6owZ6r3UdPlA-X","slug":"2s-io-github-readme-fetcher-c3008970","name":"2s.io GitHub README Fetcher","description":"Fetch a repository's README, decoded to UTF-8 text (name, path, size, content, URL). Optionally pin to a branch/tag/sha via ref. Useful for summarizing or indexing a project. Read-only; no caller key needed.","url":"https://2s.io/api/github/readme","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method","queryParams"],"properties":{"type":{"const":"http"},"method":{"const":"GET"},"queryParams":{"type":"object","required":["owner","repo"],"properties":{"ref":{"type":"string","maxLength":120},"repo":{"type":"string","maxLength":120,"minLength":1},"owner":{"type":"string","maxLength":100,"minLength":1}},"additionalProperties":false}}}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.0025","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.0025/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.0025","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.0025","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_D8nPBtl0hGfycQbPEV3R9","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.0025","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Fetches and decodes a GitHub repository's README file as UTF-8 text, optionally pinned to a specific branch, tag, or commit SHA.","exampleAgentPrompt":"Can you fetch the README for the vercel/next.js GitHub repo on the main branch and summarize what the project does?","exampleUseCases":null,"resultDescription":"Returns a JSON object with the README's filename, path within the repo, size in bytes, fully decoded UTF-8 content, and a direct URL to the file on GitHub.","failureModes":["Repository not found (invalid owner or repo name) — 404 error","No README file exists in the repository — empty or error response","Invalid ref specified (branch/tag/SHA does not exist) — 404 or error response","Repository is private and inaccessible — authorization error","Rate limiting by upstream GitHub API — throttled or error response"],"whenToPreferThis":"Use this endpoint when you need quick, no-auth, pay-per-call access to a GitHub repository's README content — ideal for agents summarizing open source projects, indexing documentation, or comparing project descriptions without managing GitHub API credentials.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-15T19:00:34.545Z","isFirstParty":false}