Windframe API Documentation

Base URLs

Production: https://windframe-api.fly.dev/

The Windframe API provides endpoints for authentication, user data retrieval, and project management. All secured endpoints require a valid Bearer Token (JWT) in the Authorization header.

🔐 Authentication Endpoints

POST /login

Authenticate a user and obtain access + refresh tokens.

Request Body

1{
2    "email": "user@example.com"
3}

Responses

• 200 OK

  JSON

  1{
  2    "accessToken": "string",
  3    "refreshToken": "string"
  4}

• 500 Internal Server Error

Notes

• This endpoint issues new tokens for authenticated access.
• The accessToken is used for authorized requests, while the refreshToken allows you to renew it.

POST /token

Get a new access token using a valid refresh token.

Request Body

1{
2    "refreshToken": "string"
3}

Responses

• 200 OK

  JSON

  1{
  2    "accessToken": "string"
  3}

• 401 Unauthorized — No or invalid token provided.

• 500 Server Error

Notes

• Use this endpoint to refresh your access token without logging in again.

DELETE /logout

Log the user out and invalidate the refresh token.

Request Body

1{
2    "refreshToken": "string"
3}

Responses

• 200 OK — Logout successful.
• 401 Unauthorized — Token missing or invalid.
• 500 Server Error

Notes

• Always call this endpoint to properly end a user session and invalidate the refresh token.

👤 User Data Endpoints

⚠️ All the following endpoints require an Authorization header:

Authorization: Bearer <accessToken>

GET /exports?r=ref

Retrieve a user's most recent export by reference.

Query Parameters

| Name | Type | Required | Description | | ---- | ------ | -------- | -------------------------- | | r | string | ✅ | Exported project reference |

Responses

• 200 OK

  JSON

  1[
  2    // Array of user project export data
  3]

• 404 Not Found

GET /projects

Fetch the authenticated user's projects.

Responses

• 200 OK

  JSON

  1[
  2    // Array of user's projects
  3]

• 404 Not Found

Notes

• Lists all the user’s created projects.
• Requires valid JWT.

GET /templates

Retrieve the user’s custom templates.

Responses

• 200 OK

  JSON

  1[
  2    // Array of templates
  3]

• 404 Not Found

GET /ui-libraries

Get the authenticated user's custom UI libraries.

Responses

• 200 OK

  JSON

  1[
  2    // Array of UI libraries
  3]

• 404 Not Found

🧩 Schemas

User

1{
2    "email": "string"
3}

Tokens

1{
2    "accessToken": "string",
3    "refreshToken": "string"
4}

AccessToken

1{
2    "accessToken": "string"
3}

RefreshToken

1{
2    "refreshToken": "string"
3}

UserProjects

An array of user project or resource data.

1[
2    {
3        /* project object */
4    }
5]

🔒 Authentication Scheme

Type: HTTP Bearer Authentication Format: JWT Header Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...

📞 Contact

Windframe 🌐 https://windframe.dev ✉️ contact@devwares.com

Version: 1.0 Last updated: Oct 2025