API Reference

Complete REST API documentation for ALMA.

Base URL

http://localhost:8000/api/v1

Authentication

Currently no authentication required (development mode). Production will use API keys or OAuth2.

Endpoints

Blueprints

List Blueprints

GET /blueprints/
Query Parameters:
  - skip: int (default: 0)
  - limit: int (default: 100)

Create Blueprint

POST /blueprints/
Body: SystemBlueprintCreate

Get Blueprint

GET /blueprints/{id}

Update Blueprint

PUT /blueprints/{id}
Body: SystemBlueprintUpdate

Delete Blueprint

DELETE /blueprints/{id}

Deploy Blueprint

POST /blueprints/{id}/deploy
Body: {
  "blueprint_id": int,
  "dry_run": bool,
  "engine": string (optional)
}

Conversation (AI)

Chat

POST /conversation/chat
Body: {
  "message": string,
  "context": object (optional)
}

Generate Blueprint

POST /conversation/generate-blueprint
Body: {
  "description": string
}

Describe Blueprint

POST /conversation/describe-blueprint
Body: {
  "blueprint": object
}

Suggest Improvements

POST /conversation/suggest-improvements
Body: {
  "blueprint": object
}

Resource Sizing

POST /conversation/resource-sizing
Body: {
  "workload": string,
  "expected_load": string
}

Security Audit

POST /conversation/security-audit
Body: {
  "blueprint": object
}

Infrastructure Pull Requests (IPR)

Create IPR

POST /ipr/
Body: {
  "title": string,
  "description": string,
  "blueprint_id": int,
  "created_by": string
}

List IPRs

GET /ipr/
Query Parameters:
  - status_filter: string (optional)
  - skip: int
  - limit: int

Get IPR

GET /ipr/{id}

Update IPR

PUT /ipr/{id}

Review IPR

POST /ipr/{id}/review
Body: {
  "approved": bool,
  "reviewed_by": string,
  "review_comments": string (optional)
}

Deploy IPR

POST /ipr/{id}/deploy

Cancel IPR

DELETE /ipr/{id}

Interactive Documentation

Visit /docs for interactive Swagger UI documentation. Visit /redoc for ReDoc documentation.

---

For detailed examples, see Examples.