Mux

High-performance Node.js API wrapper for Puter.js

---

Mux is a high-performance, pure Node.js API wrapper for Puter.js. It provides direct access to over 250 AI models including Claude 3.7, GPT-4o, and DeepSeek-R1 with native streaming, vision, and function calling support.

Features

• High Performance: Optimized HTTP communication that bypasses browser overhead
• 250+ AI Models: Access models from OpenAI, Anthropic, Google, Meta, DeepSeek, and others
• Advanced Streaming: Real-time token streaming with reasoning support
• Vision Support: Multimodal requests via image URL processing
• Function Calling: Native tool/function calling with parallel execution
• Model Rotation: Automatic load balancing across model endpoints
• Secure Storage: Local authentication token management

Quick Start

Installation

npm install

Launch Server

npm start

Authentication

On first run, provide your puter.auth.token from the Puter Playground.

API Overview

The API server runs on port 1862 by default.

Basic Usage

curl -X POST http://localhost:1862/chat \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Hello, how are you?",
    "model": "gpt-4o-mini"
  }'

Response

{
  "success": true,
  "response": "Hello! I'm here and ready to help you. How can I assist you today?",
  "model": "openrouter:openai/gpt-4o-mini"
}

Key Endpoints

Endpoint	Method	Description
/chat	POST	Chat completion with streaming, vision, and function calling
/api/models	GET	List all available models
/api/categories	GET	List provider categories
/api/models/:category	GET	Get models by provider (e.g. anthropic, openai)

Core Capabilities

Chat Completion

curl -X POST http://localhost:1862/chat \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Explain quantum computing",
    "model": "claude-3.5-sonnet"
  }'

Streaming

curl -X POST http://localhost:1862/chat \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Write a poem",
    "options": { "stream": true }
  }' --no-buffer

Vision / Image Analysis

curl -X POST http://localhost:1862/chat \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is in this image?",
    "model": "gpt-4o",
    "imageUrl": "https://example.com/image.jpg"
  }'

Function Calling

curl -X POST http://localhost:1862/chat \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is the weather in NYC?",
    "model": "gpt-4o",
    "options": {
      "tools": [{
        "type": "function",
        "function": {
          "name": "get_weather",
          "parameters": { }
        }
      }]
    }
  }'

Request Parameters

Parameter	Type	Description
query	string	Single text prompt
messages	array	Structured chat messages
model	string	Model identifier (default: gpt-4o-mini)
imageUrl	string	Single image URL
imageUrls	array	Multiple image URLs
options.stream	boolean	Enable streaming
options.tools	array	Function/tool definitions
options.tool_choice	string	auto, required, or none
options.parallel_tool_calls	boolean	Enable parallel calls
options.temperature	number	Sampling temperature (0–2)
options.top_p	number	Nucleus sampling
options.frequency_penalty	number	Reduce repetition
options.presence_penalty	number	Encourage diversity
options.response_format	object	Force JSON output
options.reasoning_effort	string	low, medium, high

Response Format

Standard Response

{
  "success": true,
  "response": "The AI response text",
  "reasoning": "Optional reasoning output",
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 20,
    "total_tokens": 30
  },
  "tool_calls": [],
  "model": "openrouter:openai/gpt-4o-mini"
}

Streaming Response Plain text token stream.

Documentation

Complete API Examples - Detailed examples with curl commands for all features

Popular Models

• OpenAI: gpt-4o, gpt-4o-mini, o1, o1-mini
• Anthropic: claude-3.7-sonnet, claude-3.5-sonnet, claude-3-opus
• Google: gemini-2.0-flash, gemini-1.5-pro
• DeepSeek: deepseek-r1, deepseek-v3
• Meta: llama-3.3-70b, llama-3.1-405b
• xAI: grok-2, grok-beta

View all available models:

curl http://localhost:1862/api/models