Skip to main content
The BugViper REST API gives you programmatic access to all platform features: ingesting repositories into the knowledge graph, searching code by name or natural language, analyzing change impact, and configuring GitHub webhook integrations. Every endpoint lives under a versioned prefix so future releases stay backward-compatible.

​
Base URL

BugViper is self-hosted. Replace your-bugviper-instance with the hostname where you deployed the service: 
https://your-bugviper-instance
All API endpoints are prefixed with /api/v1/. For example: 
https://your-bugviper-instance/api/v1/repos/

​
Authentication

Every request (except webhook endpoints) requires a Firebase ID token passed as a Bearer token in the Authorization header: 
Authorization: Bearer <FIREBASE_ID_TOKEN>
Tokens expire after one hour. See Authentication for details on obtaining and refreshing tokens.

​
Content type

All POST and PUT requests that include a body must set: 
Content-Type: application/json

​
Interactive docs

When the BugViper server is running, you can explore all endpoints interactively at:
  • Swagger UI — https://your-bugviper-instance/docs
  • ReDoc — https://your-bugviper-instance/redoc
Both interfaces let you authenticate with your Firebase token and test requests directly in the browser.

​
Endpoint groups

Ingestion

Ingest GitHub repositories into the knowledge graph and generate semantic embeddings. Start here to index a new repository.

Ingestion jobs

Poll the status of asynchronous ingestion jobs. Track progress from pending through running to completed or failed.

Repositories

List all indexed repositories and delete them along with their graph data when they are no longer needed.

Full-text search

Search functions, classes, variables, and file content. Find callers, usages, class hierarchies, and change impact across the graph.

Semantic search

Ask questions in plain English. BugViper embeds your query and returns code ranked by vector cosine similarity.

Code Finder

Precise lookup endpoints for functions, classes, variables, modules, and imports. Includes cyclomatic complexity analysis and file peeking.

Webhooks

Single GitHub webhook endpoint that routes push, pull request, and issue comment events to automated ingestion and AI review.

Webhook events

Reference for the three event types BugViper handles, including required GitHub App permissions and response shapes.