Puter.js API Layer

This server acts as an API layer between puterjs AI services and your frontend.

Getting Started

1. First, visit the Auth Page to get your token
2. Use the token to make API calls to puterjs AI services
3. 📚 Interactive API Docs

Available Endpoints

AI Services

• GET /api/models - Get list of available AI models
• POST /api/chat - Chat with AI models
• POST /api/generate-image - Generate images with AI
• POST /api/extract-text - Extract text from images (OCR)
• POST /api/text-to-speech - Convert text to speech

Cloud Storage

• POST /api/storage/write - Write files to cloud storage
• POST /api/storage/read - Read files from cloud storage
• POST /api/storage/mkdir - Create directories
• POST /api/storage/readdir - List directory contents
• POST /api/storage/delete - Delete files/directories
• POST /api/storage/stat - Get file information

Hosting

• POST /api/hosting/create - Create hosting subdomains
• GET /api/hosting/list - List hosting deployments
• POST /api/hosting/delete - Delete hosting deployments

Key-Value Store

• POST /api/kv/set - Set key-value pairs
• POST /api/kv/get - Get values by key
• POST /api/kv/list - List all keys
• POST /api/kv/delete - Delete keys
• POST /api/kv/flush - Clear all data

Networking

• POST /api/net/fetch - Make HTTP requests

Serverless Workers

• POST /api/workers/create - Create serverless workers
• GET /api/workers/list - List all workers
• POST /api/workers/delete - Delete workers

Apps Management

• POST /api/apps/create - Create Puter apps
• GET /api/apps/list - List all apps
• POST /api/apps/delete - Delete apps

Authentication & System

• GET /auth - Authentication page to get your token
• GET /health - Health check endpoint

Example Usage

// Chat with AI
POST /api/chat
{
    "message": "Hello, how are you?",
    "model": "gpt-4.1-nano"
}

// Generate image
POST /api/generate-image
{
    "prompt": "A beautiful sunset over mountains"
}