n8n-nodes-jiemeng/README.md

n8n node for Jiemeng AI video generation using Volcengine Doubao Seedance model. Generate videos from images and text prompts.

# n8n-nodes-jiemeng

![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-logo.png)

An n8n community node for AI video generation using Volcengine's Doubao Seedance model. Transform images into dynamic videos with text prompts.

## 🎯 Features

- **Image to Video**: Generate videos from static images using AI
- **Text Prompts**: Guide video generation with descriptive text
- **Volcengine Integration**: Powered by Doubao Seedance 1.0 Lite model
- **Structured Output**: Returns video URL and metadata in JSON format
- **Error Handling**: Comprehensive error messages and suggestions

## 📦 Installation

### Option 1: Install via npm (Recommended)

```bash
npm install n8n-nodes-jiemeng
```

### Option 2: Manual Installation

1. Navigate to your n8n installation directory
2. Install the package:
   ```bash
   npm install n8n-nodes-jiemeng
   ```
3. Restart n8n

### Option 3: Community Nodes (n8n Cloud/Self-hosted)

1. Go to **Settings** → **Community Nodes**
2. Click **Install a community node**
3. Enter: `n8n-nodes-jiemeng`
4. Click **Install**

## 🚀 Quick Start

### 1. Prerequisites

- **Volcengine Account**: Sign up at [Volcengine Console](https://console.volcengine.com/)
- **Model Access**: Enable Seedance video generation model in [Model Management](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement)
- **API Key**: Create an API key in [API Key Management](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey)

### 2. Configure Credentials

1. In n8n, create new **Jiemeng API** credentials
2. Enter your Volcengine API Key
3. Save the credentials

### 3. Use the Node

1. Add **Jiemeng** node to your workflow
2. Configure:
   - **Resource**: Video Generation
   - **Operation**: Image to Video
   - **Image URL**: Public accessible image URL
   - **Prompt**: Descriptive text for video generation
3. Connect your credentials
4. Execute the workflow

## 📋 Node Configuration

### Input Parameters

| Parameter | Type   | Required | Description                                |
| --------- | ------ | -------- | ------------------------------------------ |
| Image URL | String | Yes      | Public URL of the source image             |
| Prompt    | String | Yes      | Text description to guide video generation |

### Output Format

```json
{
	"success": true,
	"taskId": "cgt-xxx",
	"status": "succeeded",
	"videoUrl": "https://generated-video-url.mp4",
	"model": "doubao-seedance-1-0-lite-i2v-250428",
	"usage": {
		"completion_tokens": 110110,
		"total_tokens": 110110
	},
	"createdAt": 1751547452,
	"updatedAt": 1751547472
}
```

### Key Output Fields

- `videoUrl`: **Main output** - Direct link to generated video
- `success`: Boolean indicating operation success
- `taskId`: Unique identifier for the generation task
- `status`: Task completion status
- `usage`: Token consumption information

## 🛠️ Troubleshooting

### Common Errors

#### ModelNotOpen Error

```
Error: Your account has not activated the model doubao-seedance-1-0-lite-i2v
```

**Solution**:

1. Visit [Volcengine Model Management](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement)
2. Find "Seedance" under "Visual Models"
3. Enable the video generation service
4. Ensure sufficient account balance

#### Unauthorized Error

```
Error: Unauthorized
```

**Solution**:

1. Verify API Key is correct
2. Check API Key permissions
3. Ensure API Key hasn't expired

## 📚 Resources

- [Volcengine Doubao Documentation](https://www.volcengine.com/docs/82379/1366799)
- [n8n Community Nodes Guide](https://docs.n8n.io/integrations/community-nodes/)
- [Seedance Model Information](https://www.volcengine.com/docs/82379/1553576)

## 📄 License

MIT License