API Reference - Documentation

API Reference

Complete API documentation with endpoints, request/response models, authentication, and code examples.

API Endpoints

Public Endpoints

GET /api/v1/docs/get-all-projects

Retrieve a list of all available documented projects.

GET /api/v1/docs/get-project/{project}

Fetch metadata and file list for a specific project.

GET /api/v1/docs/download-project/{project}

Download the original project ZIP file.

Protected Endpoints

TOKEN REQUIRED
POST /api/v1/docs/upload-project

Upload a new documentation ZIP file.

POST /api/v1/docs/extract-project

Manually trigger extraction for an uploaded ZIP.

DELETE /api/v1/docs/project/{project}

Permanently delete a project and its files.

Data Models

Project Summary

{
  "name": "string",
  "file_count": "number",
  "size_mb": "number",
  "zip_size_mb": "number",
  "total_size_mb": "number"
}

File Metadata

{
  "file_path": "string",
  "file_name": "string",
  "extension": "string",
  "size": "number"
}