{"openapi":"3.1.0","info":{"title":"Verdoc","version":"1.0.0","description":"Deterministic GitHub repository analysis and AGENTS.md generation. No language model is used: every command is quoted from a manifest in the repository and every path is checked against the git tree, so results are reproducible for a given commit.","x-guidance":"Pass a public GitHub repository as ?repo=owner/name. Use /agents-md when you want a ready-to-commit AGENTS.md for a repository you are about to work in; use /scan when you want structured facts (toolchain, entry points, documentation health, and paths the README cites that do not exist). Payment is x402 USDC on Base.","contact":{"url":"https://verdoc.dev"}},"servers":[{"url":"https://verdoc.dev"}],"paths":{"/scan":{"get":{"operationId":"scanRepository","summary":"Deterministic analysis of a public GitHub repository","description":"Returns layout, language breakdown, toolchain commands with their source manifest, test and CI presence, a 0-100 documentation-health score, and phantom_paths (file paths the README cites that do not exist).","tags":["developer-tools"],"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.010000"},"protocols":[{"x402":{}}]},"parameters":[{"name":"repo","in":"query","required":true,"description":"Public GitHub repository as owner/name or a github.com URL. Private repositories are rejected, as are repositories over 20,000 tracked files (GitHub truncates the git tree above that, and complete-tree verification is the point of this service).","schema":{"type":"string"},"example":"expressjs/express"}],"responses":{"200":{"description":"Analysis produced","content":{"application/json":{"schema":{"type":"object","properties":{"repo":{"type":"string"},"primary_language":{"type":"string"},"files_tracked":{"type":"integer"},"doc_health":{"type":"integer","description":"0-100"},"commands":{"type":"array","items":{"type":"object","properties":{"task":{"type":"string"},"command":{"type":"string"},"source":{"type":"string","description":"manifest the command was quoted from"}}}},"phantom_paths":{"type":"array","items":{"type":"string"},"description":"paths the README cites that do not exist in the git tree"}}}}}},"402":{"description":"Payment Required"},"404":{"description":"Repository not found or not public"}}}},"/agents-md":{"get":{"operationId":"generateAgentsMd","summary":"Generate an AGENTS.md for a public GitHub repository","description":"The context an agent needs before it can work in a repository it has never seen, for $0.02 instead of tens of thousands of tokens spent reading it. Build and test commands are quoted from the repository's own manifests with the source file named, and every path is checked against the git tree. Ambiguous areas are marked unverified rather than guessed. Returns JSON with the AGENTS.md document in `agents_md` plus the provenance behind it; add ?format=markdown for the raw file.","tags":["developer-tools"],"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.020000"},"protocols":[{"x402":{}}]},"parameters":[{"name":"repo","in":"query","required":true,"description":"Public GitHub repository as owner/name or a github.com URL. Private repositories are rejected, as are repositories over 20,000 tracked files (GitHub truncates the git tree above that, and complete-tree verification is the point of this service).","schema":{"type":"string"},"example":"sindresorhus/got"},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["json","markdown"],"default":"json"},"description":"'json' (default) returns the document plus its provenance; 'markdown' returns the raw AGENTS.md file."}],"responses":{"200":{"description":"Analysis produced","content":{"application/json":{"schema":{"type":"object","required":["repo","agents_md","provenance"],"properties":{"repo":{"type":"string"},"url":{"type":"string"},"default_branch":{"type":"string"},"generated_at":{"type":"string","format":"date-time"},"analyzer_version":{"type":"string"},"agents_md":{"type":"string","contentMediaType":"text/markdown"},"provenance":{"type":"object","properties":{"manifests":{"type":"array","items":{"type":"string"}},"commands":{"type":"array","items":{"type":"object","properties":{"task":{"type":"string"},"command":{"type":"string"},"raw":{"type":"string"},"source":{"type":"string","description":"manifest the command was quoted from"}}}},"phantom_paths":{"type":"array","items":{"type":"string"},"description":"paths the README cites that do not exist in the git tree"},"file_count":{"type":["integer","null"]}}}}}},"text/markdown":{"schema":{"type":"string","description":"Returned only with ?format=markdown"}}}},"402":{"description":"Payment Required"},"404":{"description":"Repository not found or not public"}}}}}}