VibeKit Documentation

Sign in with GitHub

The fastest way to get started. Sign in via the web to get your API key and access the Dashboard.

https://vibekit.bot/auth/github

Or register via API:

curl -X POST https://vibekit.bot/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

Submit a Task

curl -X POST https://vibekit.bot/api/v1/task \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Build a todo app with dark mode"}'

Check Status & Get URL

curl https://vibekit.bot/api/v1/task/TASK_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Your app will be live at {name}.vibekit.bot

Register via API

Create an account and receive an API key. No authentication required.

Request Body

{
  "email": "[email protected]"
}

Response

{
  "apiKey": "vk_xxx...",
  "plan": "free",
  "balance": 0.25
}

Exchange API Key for JWT

Exchange an API key for a short-lived JWT. Useful for frontend apps that need token-based auth.

Request Body

{
  "apiKey": "vk_xxx"
}

Response

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expiresIn": 86400
}

GitHub OAuth

Redirects to GitHub OAuth for sign-in. On success, issues a JWT and redirects to the Dashboard.

Submit Task

Request Body

{
  "prompt": "Build a landing page",
  "skills": ["solana"],        // optional: domain skills
  "projectId": "abc123",      // optional: iterate on existing
  "repo": "owner/repo",       // optional: target repo
  "database": true,          // optional: enable Postgres database
  "template": "landing",      // optional: project template
  "callbackUrl": "https://...", // optional: webhook
  "anthropicApiKey": "sk-ant-..." // optional: BYOK (free)
}

Get Task Status

Response

{
  "taskId": "task_abc123",
  "status": "complete",  // pending | running | complete | error
  "deployUrl": "https://myapp.vibekit.bot",
  "projectId": "abc123",
  "repo": "vibekit-apps/project-abc123"
}

List Tasks

Returns your recent tasks with status and deploy URLs.

Cancel Task

Cancel a running or starting task. Only tasks with status running or starting can be cancelled.

Deploy App

Deploy a new app from a GitHub repository.

{
  "repo": "owner/repo",
  "subdomain": "my-app",      // optional
  "runtime": "node",          // optional (default: node)
  "memoryLimit": 256,         // optional: MB
  "envVars": {"KEY": "value"} // optional
}

Response

{
  "id": "app_abc123",
  "url": "https://my-app.vibekit.bot",
  "status": "running"
}

List Apps

Returns all hosted apps for the authenticated user.

Response

{
  "apps": [{
    "id": "app_abc123",
    "name": "my-app",
    "repo": "owner/repo",
    "url": "https://my-app.vibekit.bot",
    "status": "running",
    "memory": 256
  }]
}

Create App (Template or Repo)

Create a new app from a template or GitHub repo. The AI agent is auto-provisioned and starts building immediately.

// From template
{
  "template": "landing",
  "subdomain": "my-app"
}

// From GitHub repo
{
  "repo": "owner/repo-name",
  "subdomain": "my-app"
}

Templates: landing dashboard saas crud-api ecommerce portfolio blog form

App Details

Returns full app details including infrastructure topology, resource usage, and domain config.

{
  "id": "app_abc123",
  "name": "my-app",
  "url": "https://my-app.vibekit.bot",
  "status": "running",
  "stats": { "cpu": 2.1, "memory": 128, "memoryLimit": 256 },
  "infra": {
    "nodes": [{ "id", "type", "label" }],
    "edges": [{ "source", "target", "label" }]
  }
}

App Lifecycle

Control your app's lifecycle. Available actions:

curl -X POST https://vibekit.bot/api/v1/hosting/app/APP_ID/restart \
  -H "Authorization: Bearer YOUR_API_KEY"

Delete App

Permanently delete an app and its container. This action cannot be undone.

Resize Container

Change the container's memory allocation. See Container Memory Add-ons for pricing.

{
  "memoryLimit": 512
}

Set Custom Domain

Attach a custom domain to your app. Returns DNS records to configure at your registrar.

{
  "domain": "mysite.com"
}

Response

{
  "domain": "mysite.com",
  "dnsRecords": [
    { "type": "A", "name": "@", "value": "76.76.21.21" }
  ]
}

Container Logs

Retrieve container stdout/stderr logs.

Deploy Progress

Check the current deployment status and build progress for an app.

Execute Command

Execute a shell command inside the app's container.

{
  "command": "ls -la /app"
}

Response

{
  "output": "total 48\ndrwxr-xr-x 6 node node ..."
}

Enable Database

Provisions an isolated Postgres schema and user for the app. DATABASE_URL is automatically injected into the container on the next deploy or redeploy.

Response

{
  "success": true,
  "schema": "app_8b0eb119",
  "message": "Database provisioned. DATABASE_URL will be injected on next deploy."
}

Database Stats

{
  "tables": 3,
  "sizeMB": "0.02",
  "schema": "app_8b0eb119",
  "connections": 1
}

Export Database

Downloads a full SQL dump of the app's database. Use for backups or migration.

Remove Database

Permanently deletes the database schema and all data. This action cannot be undone. Export first if you need a backup.

Isolation & Security

Each app gets its own Postgres schema and database user with strict isolation:

• • Separate schema per app (app_{id})
• • Dedicated user locked to own schema
• • public schema access revoked
• • 10 connection limit per app
• • 30s statement timeout

Send Message to Agent

Send a message to the app's AI agent. Supports sync and async modes.

// Sync — waits for response
{
  "message": "Add a health check endpoint at /api/health"
}

// Async — returns 202, POSTs result to callbackUrl
{
  "message": "Refactor the auth module",
  "callbackUrl": "https://your-server.com/webhook"
}

Response (sync)

{
  "response": "Added health check endpoint at /api/health...",
  "engine": "openclaw"
}

Chat History

Retrieve the agent's conversation history.

Response

{
  "messages": [
    { "role": "user", "content": "...", "timestamp": "..." },
    { "role": "assistant", "content": "...", "timestamp": "..." }
  ]
}

Agent Activity

Check if the agent is currently working on something.

{
  "status": "idle",  // idle | working
  "lastActivity": "2026-02-12T20:30:00Z"
}

Workspace Changes

View the git diff of changes the agent has made in the workspace.

{
  "files": [{ "path": "src/index.ts", "status": "M" }],
  "diff": "--- a/src/index.ts\n+++ b/src/index.ts\n...",
  "summary": "1 modified"
}

Token Usage

Check the agent's context window usage.

{
  "used": 45000,
  "limit": 200000,
  "percent": 23,
  "compactions": 1
}

Build Preview

Serve the agent's build output. Useful for iframe embedding and previewing changes before deploying.

{
  "available": true,
  "buildDir": "build",
  "files": ["index.html", "static/js/main.js"]
}

Reset Agent Session

Clear the agent's conversation history and context. Useful when the agent's context window is full or you want a fresh start.

Compact Context

Clear the agent's session files and context window. Useful when the context is bloated and you want a lighter agent without a full reset.

Clear Agent Memory

Reset the agent's MEMORY.md file. The agent loses all long-term context about the project.

Restart Agent

Restart the agent's gateway process. Useful if the agent is stuck or unresponsive.

Agent Status

Full agent status including context usage, model, and app info.

{
  "context": { "used": 45000, "limit": 200000, "percent": 23 },
  "model": "claude-opus-4-6",
  "app": { "name": "my-app", "status": "running" }
}

Change Agent Model

Switch the AI model the agent uses.

{
  "model": "claude-sonnet-4-20250514"
}

Upload File to Agent

Upload a file to the agent's workspace. Use multipart form data.

curl -X POST https://vibekit.bot/api/v1/hosting/app/APP_ID/agent/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@./design.png"

Text-to-Speech

Convert text to speech audio. Returns audio buffer. Requires OpenAI key.

{
  "text": "Hello world",
  "voice": "alloy"
}

Character Config

Get or set the agent's pixel character appearance. Species: 0=Human, 1=Robot, 2=Cat, 3=Alien, 4=Skeleton, 5=Slime, 6=Mech, 7=Ghost.

{
  "species": 1,
  "palette": 0,
  "color": "#a78bfa"
}

Agent Avatar

Get or set a custom agent avatar image. PUT accepts base64-encoded image data (max 500KB).

Deploy from Workspace

Rebuild and redeploy the container from the agent workspace's app/ directory. Used for template-based apps where the agent writes code directly.

Update OpenClaw

Update the agent runtime (OpenClaw) to the latest version. Returns the new version number.

Account Info

Returns your plan, balance, usage limits, and Claude key status.

{
  "plan": "builder",
  "sessionsUsed": 12,
  "sessionsLimit": 50,
  "balance": 3.50,
  "hostedApps": 2,
  "maxApps": 3
}

Available Plans

List all available plans and top-up options with pricing.

Start Checkout

Get a Stripe checkout URL to upgrade your plan or add balance.

{
  "product": "pro"  // builder | pro | topup_5 | topup_15 | topup_50
}

Response

{
  "url": "https://checkout.stripe.com/...",
  "sessionId": "cs_xxx"
}

Claude API Key

Manage your own Claude API key for free usage (BYOK). Pass your key and skip platform costs entirely.

{
  "connected": true,
  "hasKey": true,
  "expired": false
}

{
  "claudeKey": "sk-ant-api03-xxx"
}

{ "success": true, "message": "Claude API key saved and verified." }

OpenAI API Key

Connect your OpenAI API key to use Codex as your AI agent. Switch between Claude and OpenAI anytime.

{
  "connected": false,
  "provider": "anthropic"
}

{
  "openaiKey": "sk-..."
}

{ "success": true, "message": "OpenAI API key saved and verified." }

Provider Selection

Switch your AI agent between Claude and OpenAI Codex. Requires both keys to be connected.

{
  "provider": "openai"
}

{ "success": true, "provider": "openai" }

GitHub Connection

Link your GitHub account for repo access and automatic deployments.

Create Schedule

{
  "prompt": "Update dependencies and fix any breaking changes",
  "repo": "user/my-app",
  "interval": "weekly",   // hourly | daily | weekly | cron expression
  "deploy": true          // auto-commit & push (default: true)
}

Response

{
  "scheduleId": "abc-123",
  "status": "active",
  "interval": "0 9 * * 1",
  "nextRun": "2026-02-19T09:00:00.000Z"
}

List Schedules

{
  "schedules": [{
    "scheduleId": "abc-123",
    "name": "Update dependencies and fix any br...",
    "repo": "user/my-app",
    "interval": "0 9 * * 1",
    "enabled": true,
    "lastRun": null,
    "nextRun": "2026-02-19T09:00:00.000Z",
    "runCount": 0
  }]
}

Delete Schedule

Cancels and removes a scheduled task.

List Templates

Optional query: ?category=web to filter by category.

{
  "templates": [{
    "id": "landing",
    "name": "Landing Page",
    "description": "Modern landing page with hero, features, CTA",
    "category": "web",
    "suggestedFeatures": ["Hero section", "Feature grid"],
    "estimatedTime": "2-3 min"
  }],
  "usage": "Include \"template\": \"<id>\" in POST /api/v1/task to use a template"
}

Get Template

Returns full template details including file structure and config.

Webhook Triggers

Connect external services to trigger your app's AI agent automatically. When GitHub opens an issue, Stripe processes a payment, or your uptime monitor detects downtime — your agent reacts.

Endpoints

Create Webhook

{
  "slug": "github-issues",
  "prompt_template": "A GitHub issue was opened:\n\n<webhook_payload>\n{{payload}}\n</webhook_payload>\n\nAnalyze and fix if possible.",
  "cooldown_seconds": 60,
  "filters": { "action": "opened" }
}

Response

{
  "id": "wh-abc123",
  "url": "https://vibekit.bot/hook/randomtoken123",
  "secret": "hmac-secret-for-verification",
  "enabled": true
}

Trigger a Webhook

External services POST here. No authentication required — the URL token is the credential. Returns 202 immediately; agent processes asynchronously.

# GitHub sends this automatically when an issue is opened
curl -X POST https://vibekit.bot/hook/randomtoken123 \
  -H "Content-Type: application/json" \
  -H "X-Hub-Signature-256: sha256=..." \
  -d '{"action":"opened","issue":{"title":"Bug in login"}}'

Security

Templates

Pre-built templates available in the dashboard Webhooks tab:

Outbound Callbacks

Get notified when tasks or agent messages complete. Include callbackUrl in your request.

{
  "event": "task.complete",
  "taskId": "task_abc123",
  "status": "complete",
  "result": {
    "summary": "Built landing page with hero and email form",
    "deployUrl": "https://project.vibekit.bot"
  }
}

Headers

Get VAPID Key

Returns the server's VAPID public key for Web Push subscription.

Subscribe

Register a push subscription. Body: Web Push subscription object from PushManager.subscribe().

{
  "subscription": {
    "endpoint": "https://fcm.googleapis.com/...",
    "keys": { "p256dh": "...", "auth": "..." }
  }
}

Unsubscribe

Remove a push subscription. Body: {"endpoint": "..."}

Preferences

Get or update notification channel preferences.

// PUT body
{
  "channels": ["agent", "deploy", "crash"]
}

Test Notification

Send a test push notification to all your subscribed devices.