src/docs/src/Workers.md
Serverless Workers are serverless functions that run JavaScript code in the cloud.
Workers use a router-based system to handle HTTP requests and can integrate with Puter's cloud services like file storage, key-value databases, and AI APIs. Workers are perfect for building backend services, REST APIs, webhooks, and data processing pipelines.
// Simple GET endpoint
router.get("/api/hello", async ({ request }) => {
return { message: "Hello, World!" };
});
router.post("/api/user", async ({ request }) => {
// Get JSON body
const body = await request.json();
return { processed: true };
});
:paramName in route path to capture dynamic segments// Dynamic route with parameters
router.get("/api/posts/:category/:id", async ({ request, params }) => {
const { category, id } = params;
return { category, id };
});
router.get("/api/simple", async ({ request }) => {
return { status: "ok" }; // Automatically converted to JSON
});
router.post("/api/kv/set", async ({ request }) => {
const { key, value } = await request.json();
if (!key || value === undefined) {
return new Response(JSON.stringify({ error: "Key and value required" }), {
status: 400,
headers: { "Content-Type": "application/json" },
});
}
await me.puter.kv.set("myscope_" + key, value); // add a mandatory prefix so this wont blindly read the KV of the user's other data
return { saved: true, key };
});
router.get("/api/kv/get/:key", async ({ request, params }) => {
const key = params.key;
const value = await me.puter.kv.get("myscope_" + key); // use the same prefix
if (!value) {
return new Response(JSON.stringify({ error: "Key not found" }), {
status: 404,
headers: { "Content-Type": "application/json" },
});
}
return { key, value: value };
});
router - The router object for handling HTTP requestsIn addition, the Puter.js Workers API lets you create, manage, and execute these workers programmatically. The API provides comprehensive management features including create, delete, list, get, and execute worker.
These workers management features are supported out of the box when using Puter.js:
puter.workers.create() - Create a new workerputer.workers.delete() - Delete a workerputer.workers.list() - List all workersputer.workers.get() - Get information about a specific workerputer.workers.exec() - Execute a workerYou can see various Puter.js workers management features in action from the following examples: