🔌 Overview

The PromptWeb API will allow you to create, update, and manage websites programmatically. Perfect for:

💡 Current Option: While the REST API is in development, you can integrate PromptWeb via Telegram Bot API. We treat agents just like humans — use @promptweb_bot programmatically with any Telegram bot library.

📋 Planned Endpoints

The following endpoints are planned for the initial API release:

POST /api/v1/sites
Create a new website from a natural language description. Returns site URL and metadata.

Request Body

{
  "name": "My Portfolio",
  "description": "Create a portfolio with dark theme and project grid",
  "subdomain": "john-portfolio"  // optional
}

Response

{
  "id": "site_abc123",
  "name": "My Portfolio",
  "url": "https://john-portfolio.promptweb.ai",
  "status": "live",
  "created_at": "2026-02-25T14:30:00Z"
}
PATCH /api/v1/sites/:id
Update an existing site with natural language edits. Returns updated site info.

Request Body

{
  "edit": "Make the header blue and add a contact form"
}
GET /api/v1/sites/:id
Retrieve site information including URL, status, creation date, and metadata.
GET /api/v1/sites
List all sites for the authenticated user. Supports pagination and filtering.
DELETE /api/v1/sites/:id
Permanently delete a site and all associated files. Cannot be undone.

🔑 Authentication

The API will support multiple authentication methods:

API Keys (Recommended for Agents)

Generate API keys in your dashboard. Include in the Authorization header:

Authorization: Bearer sk_live_abc123...

OAuth 2.0 (For Third-Party Integrations)

Standard OAuth flow for user-authorized integrations. Supports authorization code and client credentials grants.

⚡ Rate Limits

API rate limits will be based on your pricing tier:

Free Tier

Free
  • 100 requests/hour
  • 1,000 requests/day
  • 5 sites max
  • Community support

Enterprise

Custom
  • Unlimited requests
  • Dedicated infrastructure
  • SLA guarantee
  • White-label option
  • On-premise available

Pricing shown above is preliminary and subject to change before launch.

📚 SDKs & Libraries

Official client libraries will be available for popular languages:

Example Usage (JavaScript)

import { PromptWeb } from '@promptweb/sdk';

const client = new PromptWeb({ apiKey: 'sk_live_...' });

// Create a new site
const site = await client.sites.create({
  name: 'My Portfolio',
  description: 'Portfolio with dark theme and project grid'
});

console.log(`Site live at: ${site.url}`);

// Update the site
await client.sites.update(site.id, {
  edit: 'Add a contact form with email field'
});

// Take screenshot
const screenshot = await client.sites.screenshot(site.id);
console.log(screenshot.url);

🎯 Use Cases

For AI Agent Developers

Give your agent the ability to create websites:

// User: "Create a landing page for my new product"
// Your agent:
const site = await promptweb.sites.create({
  name: "Product Landing",
  description: userRequest
});
await agent.reply(`Your landing page is live: ${site.url}`);

For SaaS Platforms

Offer website generation as a feature:

// When user signs up, create their profile page
const site = await promptweb.sites.create({
  name: `${user.name}'s Profile`,
  description: `Professional profile page for ${user.bio}`
});
await db.users.update(user.id, { profileUrl: site.url });

For Automation Tools

Batch-create landing pages from a spreadsheet:

for (const row of spreadsheet) {
  const site = await promptweb.sites.create({
    name: row.campaignName,
    description: row.pageDescription
  });
  row.landingPageUrl = site.url;
}

📬 Join the Waitlist

Want early access to the API? We're onboarding partners in phases.

🎁 Early Access Benefits:

To join the waitlist:

  1. Send a message to @promptweb_bot
  2. Describe your use case and expected volume
  3. We'll reach out when your spot is available

🔗 Current Integration Option

While waiting for the REST API, you can integrate PromptWeb today using our Telegram bot:

Telegram Bot API Integration

Use any Telegram bot library to interact with @promptweb_bot programmatically:

// Example with grammY (Node.js)
import { Bot } from "grammy";

const userBot = new Bot("YOUR_BOT_TOKEN");

// Forward user requests to PromptWeb bot
userBot.on("message", async (ctx) => {
  await ctx.api.sendMessage(
    "@promptweb_bot", 
    ctx.message.text
  );
});

userBot.start();

Advantages: Available now, same features as human users, no separate API key needed.

Limitations: Requires Telegram bot token, less structured than REST API, rate limits apply.

💡 Remember: We treat agents just like humans. The Telegram integration gives you full access to all PromptWeb features today, while you wait for the dedicated API.

Ready to integrate PromptWeb?

Start with Telegram integration today, or join the API waitlist

Get Started →