deepwiki-api
This skill enables GitHub repository documentation exploration using DeepWiki API directly via curl. Use when researching repository structure, understanding library APIs, or asking questions about open-source projects. MCP server not required.
When & Why to Use This Skill
The DeepWiki API skill empowers developers to explore and query GitHub repository documentation using AI-driven insights. By providing direct access to repository structures and contents via simple API calls, it enables users to understand complex codebases, research library APIs, and get instant answers to technical questions without requiring an MCP server setup.
Use Cases
- Codebase Onboarding: Quickly grasp the high-level architecture and organizational structure of a new or complex GitHub repository.
- API Documentation Research: Efficiently explore library APIs and usage patterns to accelerate integration and development workflows.
- Technical Troubleshooting: Ask specific questions about repository implementation details, such as 'How are WebView panels implemented?', to receive AI-generated explanations based on actual documentation.
- Open-Source Exploration: Analyze public projects and their wikis to understand best practices and design patterns used by major software projects like VS Code or xterm.js.
| name | deepwiki-api |
|---|---|
| description | This skill enables GitHub repository documentation exploration using DeepWiki API directly via curl. Use when researching repository structure, understanding library APIs, or asking questions about open-source projects. MCP server not required. |
DeepWiki API (Direct)
Overview
DeepWiki provides AI-powered documentation exploration for GitHub repositories. This skill uses the API directly via curl - no MCP server required.
Base URL
https://api.deepwiki.com
Read Wiki Structure
Get a list of documentation topics for a repository.
Endpoint
GET https://api.deepwiki.com/wiki/{owner}/{repo}/structure
Usage
curl -s "https://api.deepwiki.com/wiki/microsoft/vscode/structure" \
-H "Accept: application/json" | jq '.'
Read Wiki Contents
Get full documentation content for a repository.
Endpoint
GET https://api.deepwiki.com/wiki/{owner}/{repo}/contents
Usage
curl -s "https://api.deepwiki.com/wiki/xtermjs/xterm.js/contents" \
-H "Accept: application/json" | jq '.'
Ask Question
Ask a question about a repository and get AI-generated answers.
Endpoint
POST https://api.deepwiki.com/wiki/{owner}/{repo}/ask
Usage
curl -s -X POST "https://api.deepwiki.com/wiki/microsoft/vscode/ask" \
-H "Content-Type: application/json" \
-d '{"question": "How does the terminal handle PTY integration?"}'
Common Workflows
Research a Library
# Get structure first
curl -s "https://api.deepwiki.com/wiki/xtermjs/xterm.js/structure" | jq '.topics[]'
# Then ask specific questions
curl -s -X POST "https://api.deepwiki.com/wiki/xtermjs/xterm.js/ask" \
-H "Content-Type: application/json" \
-d '{"question": "How to implement custom key handling?"}'
Understand VS Code Patterns
curl -s -X POST "https://api.deepwiki.com/wiki/microsoft/vscode/ask" \
-H "Content-Type: application/json" \
-d '{"question": "How are WebView panels implemented?"}'
Explore Repository Architecture
curl -s -X POST "https://api.deepwiki.com/wiki/anthropics/claude-code/ask" \
-H "Content-Type: application/json" \
-d '{"question": "What is the overall architecture?"}'
Response Processing
# Extract answer only
| jq '.answer'
# Get with sources
| jq '{answer, sources}'
Notes
- No API key required for public repositories
- Rate limits may apply
- Responses are AI-generated based on repository content