freeWriter API Documentation

This document outlines the API endpoints for the freeWriter application. These endpoints are implemented as serverless functions on Vercel.

Base URL

All API requests should be prefixed with: https://your-vercel-app-url.vercel.app/api

Authentication

Most endpoints require authentication. Include the JWT token in the Authorization header:

Authorization: Bearer YOUR_JWT_TOKEN

Endpoints

User Management

Register a new user

• POST /api/users/register
• Body:

  {
    "username": "string",
    "email": "string",
    "password": "string",
    "writingMode": "Plotter" | "Pantser"
  }
  

• Response: JWT token

Login

• POST /api/users/login
• Body:

  {
    "email": "string",
    "password": "string"
  }
  

• Response: JWT token

Stories

Get all stories for a user

• GET /api/stories
• Response: Array of story objects

Create a new story

• POST /api/stories/create
• Body:

  {
    "title": "string",
    "content": "string"
  }
  

• Response: Created story object

AI Interactions

Get All Conversations

• GET /api/ai/interaction
• Description: Retrieves all conversations for the authenticated user
• Response:

  {
    "conversations": [
      {
        "id": "string",
        "title": "string",
        "lastUpdate": "date"
      }
    ]
  }
  

Get Conversation History

• GET /api/ai/interaction/:id
• Description: Retrieves the history of a specific conversation
• Parameters:
  • id: Conversation ID (string)
• Response:

  {
    "history": [
      {
        "role": "system" | "user" | "assistant",
        "content": "string",
        "timestamp": "date"
      }
    ]
  }
  

Send Message to Conversation

• POST /api/ai/interaction
• Description: Sends a message to start a new conversation or continue an existing one
• Body:

  {
    "message": "string",
    "conversationId": "string" // optional - if not provided, creates new conversation
  }
  

• Response:

  {
    "response": "string",
    "conversationId": "string",
    "title": "string"
  }
  

Recovery password

• POST: /.netlify/functions/forgetPassword
• Body:

{
  "email": string
}

IA conversation

• POST: .netlify/functions/api/ai/interaction
• Body:

{
  "message": string,
}

Generating new prompt

• POST: .netlify/functions/api/ai/generate-Promt
• Body:

{
  "title": string,
  "WritingMode": "Plotter | Pantser",
}

New feedback

• POST: .netlify/functions/api/ai/submit-feedback
• Body:

{
  "storyId": string, 
  "promptId": string, 
  "guidanceId": string, 
  "rating": number, 
  "comments": string
}