# API Documentation

## Overview

The Headquarter API is a RESTful API built with FastAPI. All endpoints (except auth) require authentication via session cookie.

## Base URL

- Development: `http://localhost:8000`
- Production: `https://api.yourdomain.com`

## Authentication

Most endpoints require authentication. Include the session cookie in requests:

```bash
curl http://api.example.com/endpoint \
  -H "Cookie: session=your_session_cookie"
```

## Response Format

All responses are JSON. Error responses follow this format:

```json
{
  "detail": "Error message"
}
```

## API Sections

- [Auth](auth.md) - Authentication endpoints
- [Projects](projects.md) - Project management
- [Repositories](repositories.md) - Git repositories and file operations
- [Config Profiles](config-profiles.md) - Config profile management with git mounts
- [Users](users.md) - User management and settings
- [Tool Types](tool-types.md) - Tool type management
- [SSH Keys](ssh-keys.md) - SSH key management

## Testing

Interactive API documentation is available at `/docs` when running the backend:

```
http://localhost:8000/docs
```

This provides:
- Interactive endpoint testing
- Request/response schemas
- Authentication via "Authorize" button