Skip to content

api.md

Latest commit

 

History

History
69 lines (50 loc) · 1.53 KB

api.md

File metadata and controls

69 lines (50 loc) · 1.53 KB
Raw

API & AI Service Integration

To keep the frontend and backend synced, use the following mapping:

Feature Frontend Call (app.js) API Endpoint (app.py) Logic Provider (ai_service.py)
Book Vibe POST /api/v1/generate-note handle_generate_note() generate_book_note()

Endpoint: Generate Book Note

Method: POST
URL: /api/v1/generate-note
Description: Generates an AI-powered "bookseller note" based on the book's vibe, mood, and metadata.

Example Request

Headers:

{
  "Content-Type": "application/json"
}

Body:

{
  "title": "The Night Circus",
  "author": "Erin Morgenstern",
  "mood": "mysterious, magical, slow-burn romance"
}

Example Response

Success (200 OK):

{
  "status": "success",
  "note": "A dreamlike duel unfolds in a wandering circus of shadows and light. Perfect for readers who crave atmospheric magic and quiet intensity."
}

Error (400 Bad Request):

{
  "status": "error",
  "message": "Missing required fields: title or mood"
}

API Flow Explanation

  1. Frontend sends a POST request from app.js to /api/v1/generate-note.
  2. The Flask backend (app.py) receives the request via handle_generate_note().
  3. Input data (title, author, mood) is validated.
  4. The request is passed to generate_book_note() in ai_service.py.
  5. The AI model generates a contextual "bookseller note".
  6. The backend returns the generated note as a JSON response.
  7. Frontend displays the note in the book popup UI.