Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goenhance.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Video Effects API

The GoEnhance Video Effects API suite provides developers with powerful tools to programmatically transform static images into dynamic, engaging videos. Our AI-powered technology enables a wide range of creative effects, from facial animations and dance movements to visual transformations and special effects.

​
Key Features

  • High-Quality Transformations: Convert static images into realistic video animations
  • Diverse Effect Library: Access 35+ unique video effects for different use cases
  • Simple Integration: Straightforward REST API with consistent request/response patterns
  • Scalable Performance: Handle high-volume requests with reliable processing
  • Developer-Friendly: Comprehensive documentation and examples for easy implementation

​
How It Works

  1. Select an Effect: Choose from our library of video effect templates
  2. Upload an Image: Provide a reference image via URL or base64 encoding
  3. Generate Video: Our AI processes your image and applies the selected effect
  4. Check Status: Monitor the processing status using the job identifier
  5. Retrieve Result: Access the generated video for use in your application

​
Available Effects

Our Video Effects API includes a diverse collection of templates, including:
  • Social Interactions: Hug, Kiss, French Kiss, Blow Kiss
  • Dance Animations: Twerk Dance, Hip Shake, Jiggle Dance, Squat Shake, Phut Hon Dance
  • Visual Transformations: Turning Metal, Anime2Real, Muscle Show, Mermaid Spell
  • Special Effects: Thunder God, Spitfire, Set On Fire, Alien Kidnap
  • And many more!

​
Example: Hug Effect

Here’s an example of how to use our Hug effect API: 
// Request example for the Hug effect
fetch('https://api.goenhance.ai/api/v2/videoeffect/generate/hug', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    "args": {
      "reference_img": "https://example.com/your-image.jpg"
    }
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
The API will process your image and return a response containing a unique identifier (img_uuid) that you can use to check the status and access the generated video.

​
Monitoring Job Status

Video effect generation is an asynchronous process. After submitting your request, you’ll receive an img_uuid that you can use to check the status of your job: 
// Check job status example
fetch(`https://api.goenhance.ai/api/v1/jobs/detail?img_uuid=YOUR_IMG_UUID`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(data => {
  // Check the status
  if (data.data.status === "success") {
    // Job completed, access the result URL from data.data.json[0].value
    console.log("Video URL:", data.data.json[0].value);
  } else if (data.data.status === "pending" || data.data.status === "processing") {
    // Job still in progress
    console.log("Job in progress, check again later");
  } else {
    // Job failed
    console.log("Job failed");
  }
})
.catch(error => console.error('Error:', error));
When the job status is “success”, you can find the generated video URL in the data.json[0].value field of the response.

​
Integration Guide

For detailed information on integrating specific effects, please refer to the individual API documentation pages. Each effect has its own endpoint and may support additional parameters for customization. To get started with the Hug effect, see the AI Hug Video Generator API documentation.

​
Video Effects List

For a complete list of available effects and their capabilities, see the Video Effects List API documentation.

​
Job Status API

For detailed information on checking the status of your video generation jobs, see the Get Job Status API documentation.