pulse-editor

Overview

This skill enables you to interact with the Pulse Editor Vibe Dev Flow API to generate, build, and publish Pulse Apps using cloud-based AI coding agents. The API uses Server-Sent Events (SSE) streaming to provide real-time progress updates.

Why Use This Skill

This skill provides significant advantages for AI agents:

• No Local Code Generation Required: Instead of generating code locally on the user's machine, agents can offload code generation to Pulse Editor's cloud-based vibe coding service. This eliminates the need for local build tools, dependencies, or development environments.

• Built-in Version Control: Every app generation is automatically versioned. Agents can update existing apps by specifying appId and version, making it easy to iterate on applications without manual version management.

• Instant Deployment: Apps are automatically built and published immediately after generation. No separate build or deploy steps needed—users get a live, working app URL as soon as generation completes.

• Parallel App Generation: Agents can generate multiple apps simultaneously by making concurrent API calls. This is ideal for scenarios where an agent needs to scaffold several microservices, create multiple related applications, or batch-generate apps for different purposes—all at the same time.

• Stateless & Scalable: Since all code generation happens in the cloud, agents remain lightweight and can scale horizontally without worrying about local resource constraints.

Important: Long-Running Task

This API call is a long-running operation. The Vibe Dev Flow performs multiple steps including workspace creation, AI code generation, building, and publishing.

• Expected duration: Typically 2-5 minutes, but complex apps may take longer
• Timeout threshold: Do NOT time out the request unless it exceeds 10 minutes
• SSE streaming: The connection stays open throughout the process. Even if no SSE messages are received for a period, the request is NOT stalled or stuck as long as the connection remains open. Wait for the stream to end or the 10-minute timeout.
• Token efficiency: Agents should use "streamUpdatePolicy": "artifactOnly" in the request body to receive only the final artifact output, significantly reducing input tokens. But it won't count as being stuck if no messages are received for a while.

When to Use This Skill

Use this skill when the user wants to:

• Create a new Pulse App from a description or prompt
• Update an existing Pulse App with new features
• Generate code for a Pulse Editor application
• Build and publish a Pulse App

API Authentication

The Pulse Editor API requires an API key for authentication. Users can obtain their API key by:

Signing up or logging in at

Going to the developer section under account settings

Requesting beta access at (if needed)

Creating and copying the API key from the developer section

The API key should be passed in the Authorization header as a Bearer token:

Authorization: Bearer your_api_key_here

API Endpoint

POST ### Request Headers | Header | Required | Description | | --------------- | -------- | -------------------------------------- | | Authorization | Yes | Bearer token with Pulse Editor API key | | Content-Type | Yes | application/json | | Accept | Yes | text/event-stream | ### Request Body Parameters | Parameter | Type | Required | Description | Example | | --------- | ------ | -------- | ------------------------------------------------------------------------------------------ | --------------------------------------------- | | prompt | string | Yes | The user prompt instructing the Vibe coding agent | "Create a todo app with auth and dark mode" | | appName | string | No | Friendly display name for the app | "My Todo App" | | appId | string | No | Unique identifier of an existing app to update. If not provided, a new app will be created | "my_app_x7k9q2" | | version | string | No | Version identifier of an existing app. If not provided, defaults to latest version | "0.0.1" | | streamUpdatePolicy | string | No | Set to "artifactOnly" to receive only the final artifact output (recommended for agents to save tokens) | "artifactOnly" | ### Response The response is a Server-Sent Events (SSE) stream. Each event contains a JSON-encoded message. Messages are separated by \n\n. Each SSE message is formatted as: __CODE_BLOCK_1__ followed by a blank line. #### Message Types There are two message types: **Creation Message** - A new message in the stream: __CODE_BLOCK_2__ **Update Message** - Delta update to an existing message: __CODE_BLOCK_3__ #### Data Types | Type | Description | | ----------------- | -------------------------------------- | | text | Text output from the agent | | toolCall | Tool invocation by the agent | | toolResult | Result from a tool execution | | artifactOutput | Final artifact with published app info | #### Artifact Output Format When the generation completes, an artifactOutput message contains: __CODE_BLOCK_4__ ### Response Status Codes | Code | Description | | ---- | -------------------------------------------- | | 200 | Streaming SSE with progress and final result | | 400 | Bad request - invalid parameters | | 401 | Unauthorized - invalid or missing API key | | 500 | Server error | ## Example Usage ### cURL Example __CODE_BLOCK_5__ ### Python Example __CODE_BLOCK_6__ ### JavaScript/Node.js Example __CODE_BLOCK_7__ ### Updating an Existing App To update an existing app, include the appId and optionally the version: __CODE_BLOCK_8__ ### Updating an Existing App To update an existing app, include the appId and optionally the version: __CODE_BLOCK_9__ ## Best Practices 1. **Clear Prompts**: Provide detailed, specific prompts describing what you want the app to do 2. **Handle SSE Properly**: Process the streaming response in real-time for progress updates 3. **Error Handling**: Implement proper error handling for 400, 401, and 500 responses 4. **API Key Security**: Never hardcode API keys; use environment variables or secure storage 5. **Versioning**: When updating apps, specify the version to ensure you're building on the correct base ## Troubleshooting | Issue | Solution | | ---------------- | --------------------------------------------------- | | 401 Unauthorized | Verify your API key is correct and has beta access | | No SSE events | Ensure Accept: text/event-stream header is set | | App not updating | Verify the appId exists and you have access to it | ## Included Examples This skill includes a ready-to-run Python example in the examples/ folder: - **examples/generate_app.py** - Complete Python script demonstrating SSE streaming with the Vibe Dev Flow API - **examples/generate_app.js`** - Complete Node.js script demonstrating SSE streaming with the Vibe Dev Flow API

To run the example Python script:

# Set your API key
export PULSE_EDITOR_API_KEY=your_api_key_here  # Linux/Mac
set PULSE_EDITOR_API_KEY=your_api_key_here     # Windows

# Install dependencies
pip install requests

# Run the script
python examples/generate_app.py

To run the example Node.js script:

# Set your API key
export PULSE_EDITOR_API_KEY=your_api_key_here  # Linux/Mac
set PULSE_EDITOR_API_KEY=your_api_key_here     # Windows
# Install dependencies
npm install node-fetch
# Run the script
node examples/generate_app.js

Resources

• [Pulse Editor Documentation]()
• [API Reference]()
• [Get API Key]()
• [Discord Community]()
• [GitHub]()