Reference all enums with their values, meanings, and usage examples for easy integration.
ProgressStatusEnum - Project Processing Status
Complete reference for all project processing statuses:
| Status | ID | Name | Description | Duration | Action Required |
|---|---|---|---|---|---|
init | 1 | Initial Setup | Project created, starting document analysis | 30-60s | Wait |
preparation | 10 | Document Analysis | Processing and analyzing uploaded document | 1-3min | Wait |
editing | 20 | Ready for Export | Project prepared, ready for video export | - | Call export-video |
error | 99 | Processing Failed | An error occurred during processing | - | Check error details |
AiRecommendStatusEnum - AI Processing Status
Status tracking for AI-powered content analysis and recommendations:
| Status | ID | Name | Description | Use Case |
|---|---|---|---|---|
normal | 1 | Normal | Standard processing, no special AI tasks active | Default state |
processing | 2 | AI Processing | General AI analysis in progress | Content optimization |
failure | 3 | AI Failed | AI processing encountered an error | Error handling required |
processing_blog | 4 | Blog Conversion | Converting document to blog-style format | Content restructuring |
processing_translation | 5 | Translation | Translating content to different language | Multi-language support |
processing_voice_align | 6 | Voice Alignment | Synchronizing voice narration with content | Audio optimization |
processing_create_video | 7 | Video Creation | AI actively creating video from processed content | Video generation |
ProjectVideoFormatEnum - Video Aspect Ratios
Supported video formats and their technical specifications:
| Format | ID | Name | Aspect Ratio | Common Resolutions | Best For |
|---|---|---|---|---|---|
16:9 | 1 | Widescreen | 16:9 | 1920×1080, 1280×720, 854×480 | YouTube, webinars, presentations |
9:16 | 2 | Vertical | 9:16 | 1080×1920, 720×1280, 540×960 | TikTok, Instagram Stories, mobile |
1:1 | 3 | Square | 1:1 | 1080×1080, 720×720, 512×512 | Instagram feed, LinkedIn, social media |
4:3 | 4 | Traditional | 4:3 | 1024×768, 800×600, 640×480 | Legacy content, some presentations |
custom | 9 | Custom | Variable | User-defined | Special requirements, unique layouts |
Format Selection Guidelines:
- 16:9 (Landscape): Best for desktop viewing, professional presentations, YouTube content
- 9:16 (Portrait): Optimized for mobile consumption, social media stories, TikTok
- 1:1 (Square): Universal format for social media feeds, LinkedIn posts, Instagram
- 4:3 (Traditional): Legacy format, some educational content, older presentation standards
ClipStatusEnum - Video Export Status
Status tracking for video export and processing operations:
| Status | Description | Typical Duration | Next Action |
|---|---|---|---|
init | Export request received, preparing for processing | 10-30s | Wait |
downloading | Downloading source content from storage | 30s-2min | Wait |
uploading | Uploading processed content to storage | 1-5min | Wait |
processing | Encoding and rendering video | 2-15min | Wait |
publishing | Finalizing export, generating download links | 30s-1min | Wait |
completed | Export finished, download link available | - | Download ready |
failed | Export failed due to error | - | Check error details |
Webhook Event Types
Complete reference for webhook event notifications based on OpenApiWebhookTypeEnum:
| Event Type | Target Type | Description | Trigger Condition |
|---|---|---|---|
project_generation | project | Video generation finished (success or failure) | After doc-to-video processing completes |
project_export | clip | Video export completed (success or failure) | After export-video completes |