Windframe API Documentation

Windframe API Docs page


Base URL:

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

json
{
"email": "user@example.com"
}

Responses

  • 200 OK
    json
    {
    "accessToken": "string",
    "refreshToken": "string"
    }
  • 500 Internal Server Error

Notes

  • This endpoint issues new tokens for authenticated access.
  • accessToken is used for authorized requests; refreshToken allows renewal.

POST /token

Get a new access token using a valid refresh token.

Request Body

json
{
"refreshToken": "string"
}

Responses

  • 200 OK
    json
    {
    "accessToken": "string"
    }
  • 401 Unauthorized — No or invalid token
  • 500 Internal 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

json
{
"refreshToken": "string"
}

Responses

  • 200 OK — Logout successful
  • 401 Unauthorized — Token missing or invalid
  • 500 Internal 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:
Authorization: Bearer <accessToken>

GET /exports?r=ref

Retrieve a user's most recent export by reference.

Query Parameters

NameTypeRequiredDescription
rstringExported project's reference

Responses

  • 200 OK
    json
    [
    // Array of project's export data
    ]
  • 404 Not Found
  • 500 Internal Server Error

GET /projects

Fetch the authenticated user's projects.

Responses

  • 200 OK
    json
    [
    // Array of user's projects
    ]
  • 404 Not Found
  • 500 Internal Server Error

Notes

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

GET /templates

Retrieve the user's custom templates.

Responses

  • 200 OK
    json
    [
    // Array of user's custom templates
    ]
  • 404 Not Found
  • 500 Internal Server Error

GET /ui-libraries

Get the authenticated user's custom UI libraries.

Responses

  • 200 OK
    json
    [
    // Array of user's custom UI libraries
    ]
  • 404 Not Found
  • 500 Internal Server Error

🧩 Schemas

User

json
{
"email": "string"
}

Tokens

json
{
"accessToken": "string",
"refreshToken": "string"
}

AccessToken

json
{
"accessToken": "string"
}

RefreshToken

json
{
"refreshToken": "string"
}

UserProjects

An array of user project or resource data.

json
[
{
/* project object */
}
]

🔒 Authentication Scheme

Type: HTTP Bearer Authentication


Format: JWT

Header Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...


📞 Contact

Windframe

🌐

https://windframe.dev

✉️

contact@devwares.com


Version: 1.2

Last updated: Nov 2025