Introduction
Artifact Miner provides a REST API for analyzing git repositories, extracting skills, generating portfolio content, and managing project metadata. The API powers the Artifact Miner TUI and can be integrated into custom applications.Base URL
The API runs locally on:Health Check
Verify API connectivity with the health endpoint:Overall service health indicator. One of:
ok, degraded, unhealthyUTC timestamp when the status was generated
Interactive Documentation
The API includes auto-generated interactive documentation:- Swagger UI:
http://127.0.0.1:8000/docs - ReDoc:
http://127.0.0.1:8000/redoc
API Categories
The API is organized into these functional groups:- Consent - Manage user consent for LLM usage
- ZIP Upload - Upload and manage project archives
- Analysis - Analyze repositories and extract insights
- Projects - CRUD operations for projects
- Skills - Retrieve skill data and chronology
- Resume - Generate and manage resume items
- Portfolio - Generate portfolio content
Request Format
All endpoints accept JSON request bodies where applicable:Content-Type header to application/json for POST/PUT requests.
Response Format
All responses return JSON with appropriate HTTP status codes:200- Success201- Resource created400- Bad request (validation error)404- Resource not found422- Unprocessable entity500- Internal server error