Документация API создания видео из изображения#
Базовый URL:
https://api.ideal.house
Версия: v1
Обновлено: 2026-03-25
📖 Обзор#
API создания видео из изображения позволяет генерировать видео с помощью ИИ из одного исходного изображения или, указав изображения первого кадра и последнего кадра, контролировать начало и конец создаваемого видео. Процесс асинхронный и состоит из двух шагов:
- Создание задачи — Отправьте изображение(я), тип модели, длительность и разрешение, после чего получите
taskId. - Опрос результатов — Используйте
taskIdдля запроса статуса задачи и получения сгенерированного видео.
🔐 Аутентификация#
Все запросы API должны проходить аутентификацию с помощью ключа API.
Укажите ваш ключ API в заголовке запроса:
| Заголовок | Значение |
|---|---|
APIKEY | your_api_key_here |
⚠️ Держите ваш ключ API в тайне. Не публикуйте его в клиентском коде или публичных репозиториях.
💰 Списание кредитов#
[!WARNING] 🪙 При успешном создании задачи кредиты списываются в зависимости от
modelType,resolution,durationи того, включён лиgenerateAudio. Если задача в итоге завершится ошибкой, списанные кредиты будут автоматически возвращены на ваш аккаунт.
При недостатке кредитов возвращается код ошибки9051. 📄 См. Справочник по списанию кредитов.
Модель Flash (modelType: "Flash", по умолчанию):
| Разрешение | Длительность | Списанные кредиты |
|---|---|---|
480p | 5s | 10 кредитов |
480p | 10s | 20 кредитов |
720p | 5s | 20 кредитов |
720p | 10s | 40 кредитов |
1080p | 5s | 40 кредитов |
1080p | 10s | 80 кредитов |
Модель Base (modelType: "Base", generateAudio: false):
| Разрешение | Длительность | Списанные кредиты |
|---|---|---|
480p | 5s | 8 кредитов |
480p | 10s | 16 кредитов |
720p | 5s | 16 кредитов |
720p | 10s | 32 кредитов |
1080p | 5s | 32 кредитов |
1080p | 10s | 64 кредитов |
Модель Base с аудио (modelType: "Base", generateAudio: true):
| Разрешение | Длительность | Списанные кредиты |
|---|---|---|
480p | 5s | 16 кредитов |
480p | 10s | 32 кредитов |
720p | 5s | 32 кредитов |
720p | 10s | 64 кредитов |
1080p | 5s | 64 кредитов |
1080p | 10s | 128 кредитов |
📌 Конечные точки API#
1. Создание задачи по созданию видео из изображения#
Создает новую задачу генерации видео из изображения с помощью ИИ и возвращает уникальный taskId для опроса.
Конечная точка
POST /api/v1/imageToVideo/generate
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Content-Type | ✅ Да | application/json |
Тело запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
imageUrl | string | ✅ Да | URL исходного изображения. В режиме «первый-последний кадр» это служит первым кадром |
duration | integer | ✅ Да | Длительность видео в секундах. Перечисление: 5, 10 |
resolution | string | ✅ Да | Разрешение выходного видео. Перечисление: 480p, 720p, 1080p |
modelType | string | ❌ Необязательно | Тип модели для генерации. Перечисление: Flash, Base. По умолчанию: Flash |
generateAudio | boolean | ❌ Необязательно | Генерировать ли фоновое аудио для видео. Применимо только, когда modelType равно Base. По умолчанию: false |
prompt | string | ❌ Необязательно | Текстовый запрос, задающий стиль и движение в генерируемом видео |
lastImageUrl | string | ❌ Необязательно | URL изображения последнего кадра. При указании включается режим «первый-последний кадр»: видео будет переходить от imageUrl (первый кадр) к lastImageUrl (последний кадр) |
💡 Режим «Первый-Последний Кадр»: Если указан
lastImageUrl, API генерирует видео, плавно переходящее от изображения первого кадра (imageUrl) к изображению последнего кадра (lastImageUrl), что дает точный контроль над началом и концом видео.
🖼️ Требования к изображениям: Изображение первого кадра и необязательное изображение последнего кадра должны быть в формате JPG/JPEG, PNG или WebP. Размер файла не должен превышать 20 МБ, а размеры изображения должны находиться в пределах от 128 × 128 пикс. до 6,000 × 6,000 пикс. (включительно). Перед обработкой изображения, превышающие максимальные размеры в пикселях, автоматически уменьшаются с сохранением пропорций до пределов 6,000 × 6,000 пикс. Изображения по указанным URL должны быть напрямую доступны серверу API.
Типы моделей
| Значение | Описание |
|---|---|
Flash | По умолчанию. Более высокая скорость генерации при высоком качестве вывода |
Base | Альтернативная модель — поддерживает необязательную генерацию аудио с ИИ (generateAudio) |
Варианты длительности
| Значение | Описание |
|---|---|
5 | 5-секундное видео |
10 | 10-секундное видео |
Варианты разрешения
| Значение | Описание |
|---|---|
480p | Стандартное разрешение — более быстрая обработка |
720p | Высокое разрешение — более высокое качество вывода |
1080p | Full HD — максимальное качество результата |
📥 Примеры запросов#
cURL
# Flash model (default) — single source image
curl -X POST "https://api.ideal.house/api/v1/imageToVideo/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "720p",
"modelType": "Flash",
"prompt": "Gentle camera zoom in with soft lighting"
}'
# Base model with audio — single source image
curl -X POST "https://api.ideal.house/api/v1/imageToVideo/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "1080p",
"modelType": "Base",
"generateAudio": true,
"prompt": "Peaceful living room ambiance"
}'
# First-last frame mode — specify both first and last frame
curl -X POST "https://api.ideal.house/api/v1/imageToVideo/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room-day.jpg",
"lastImageUrl": "https://example.com/room-night.jpg",
"duration": 10,
"resolution": "720p",
"modelType": "Flash",
"prompt": "Smooth day to night transition"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ImageToVideoApiExample {
private static final String BASE_URL = "https://api.ideal.house";
private static final String API_KEY = "your_api_key_here";
public static void main(String[] args) throws IOException {
OkHttpClient client = new OkHttpClient();
// Flash model — standard mode
String requestBody = """
{
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "720p",
"modelType": "Flash",
"prompt": "Gentle camera zoom in with soft lighting"
}
""";
// Base model with audio
// String requestBody = """
// {
// "imageUrl": "https://example.com/room.jpg",
// "duration": 5,
// "resolution": "1080p",
// "modelType": "Base",
// "generateAudio": true,
// "prompt": "Peaceful living room ambiance"
// }
// """;
// First-last frame mode
// String requestBody = """
// {
// "imageUrl": "https://example.com/room-day.jpg",
// "lastImageUrl": "https://example.com/room-night.jpg",
// "duration": 10,
// "resolution": "720p",
// "modelType": "Flash",
// "prompt": "Smooth day to night transition"
// }
// """;
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/imageToVideo/generate")
.addHeader("APIKEY", API_KEY)
.addHeader("Content-Type", "application/json")
.post(RequestBody.create(requestBody, MediaType.parse("application/json")))
.build();
try (Response response = client.newCall(request).execute()) {
System.out.println("Response: " + response.body().string());
}
}
}
Python (requests)
import requests
BASE_URL = "https://api.ideal.house"
API_KEY = "your_api_key_here"
headers = {
"APIKEY": API_KEY,
"Content-Type": "application/json"
}
# Flash model — single source image
payload = {
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "720p",
"modelType": "Flash",
"prompt": "Gentle camera zoom in with soft lighting"
}
# Base model with audio
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "duration": 5,
# "resolution": "1080p",
# "modelType": "Base",
# "generateAudio": True,
# "prompt": "Peaceful living room ambiance"
# }
# First-last frame mode
# payload = {
# "imageUrl": "https://example.com/room-day.jpg",
# "lastImageUrl": "https://example.com/room-night.jpg",
# "duration": 10,
# "resolution": "720p",
# "modelType": "Flash",
# "prompt": "Smooth day to night transition"
# }
response = requests.post(
f"{BASE_URL}/api/v1/imageToVideo/generate",
headers=headers,
json=payload
)
data = response.json()
task_id = data.get("data")
print(f"Task ID: {task_id}")
Node.js (axios)
const axios = require('axios');
const BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';
async function createVideoTask() {
try {
// Flash model — standard mode
const payload = {
imageUrl: 'https://example.com/room.jpg',
duration: 5,
resolution: '720p',
modelType: 'Flash',
prompt: 'Gentle camera zoom in with soft lighting'
};
// Base model with audio:
// const payload = {
// imageUrl: 'https://example.com/room.jpg',
// duration: 5,
// resolution: '1080p',
// modelType: 'Base',
// generateAudio: true,
// prompt: 'Peaceful living room ambiance'
// };
// First-last frame mode:
// const payload = {
// imageUrl: 'https://example.com/room-day.jpg',
// lastImageUrl: 'https://example.com/room-night.jpg',
// duration: 10,
// resolution: '720p',
// modelType: 'Flash',
// prompt: 'Smooth day to night transition'
// };
const response = await axios.post(
`${BASE_URL}/api/v1/imageToVideo/generate`,
payload,
{
headers: {
'APIKEY': API_KEY,
'Content-Type': 'application/json'
}
}
);
const taskId = response.data.data;
console.log('Task ID:', taskId);
return taskId;
} catch (error) {
console.error('Error:', error.response?.data || error.message);
}
}
createVideoTask();
📤 Ответ#
Успешный ответ
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Поле | Тип | Описание |
|---|---|---|
code | integer | 0 указывает на успех |
message | string | Сообщение в ответе |
data | long | Уникальный идентификатор задачи для опроса результатов |
2. Получение результата задачи#
Получает текущий статус и результат ранее созданной задачи по созданию видео из изображения.
Конечная точка
GET /api/v1/imageToVideo/result
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
taskId | long | ✅ Да | Идентификатор задачи, возвращенный из конечной точки создания задачи |
📥 Примеры запросов#
cURL
curl -X GET "https://api.ideal.house/api/v1/imageToVideo/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class ImageToVideoResultExample {
private static final String BASE_URL = "https://api.ideal.house";
private static final String API_KEY = "your_api_key_here";
public static void main(String[] args) throws IOException {
OkHttpClient client = new OkHttpClient();
long taskId = 1234567890123456789L;
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/imageToVideo/result?taskId=" + taskId)
.addHeader("APIKEY", API_KEY)
.get()
.build();
try (Response response = client.newCall(request).execute()) {
System.out.println("Response: " + response.body().string());
}
}
}
Python (requests)
import requests
import time
BASE_URL = "https://api.ideal.house"
API_KEY = "your_api_key_here"
headers = {
"APIKEY": API_KEY
}
task_id = 1234567890123456789
# Poll until task is complete
while True:
response = requests.get(
f"{BASE_URL}/api/v1/imageToVideo/result",
headers=headers,
params={"taskId": task_id}
)
data = response.json()
result = data.get("data", {})
status = result.get("status")
print(f"Status: {status}, Progress: {result.get('percentage')}%, Queue: {result.get('waitNumber')}")
if status in ("Success", "Failed"):
break
time.sleep(5) # Poll every 5 seconds (video generation takes longer)
if status == "Success":
output = result["output"]
print("Video URL:", output["resultUrl"])
print("Cover Image:", output["cover"])
else:
print("Task failed")
Node.js (axios)
const axios = require('axios');
const BASE_URL = 'https://api.ideal.house';
const API_KEY = 'your_api_key_here';
async function pollResult(taskId) {
const headers = { 'APIKEY': API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/imageToVideo/result`,
{
headers,
params: { taskId }
}
);
const result = response.data.data;
const { status, percentage, waitNumber } = result;
console.log(`Status: ${status} | Progress: ${percentage}% | Queue: ${waitNumber}`);
if (['Success', 'Failed'].includes(status)) {
if (status === 'Success') {
console.log('Video URL:', result.output.resultUrl);
console.log('Cover Image:', result.output.cover);
console.log('Resolution:', result.output.width, 'x', result.output.height);
} else {
console.log('Task failed');
}
break;
}
// Wait 5 seconds before next poll (video tasks take longer)
await new Promise(resolve => setTimeout(resolve, 5000));
}
}
pollResult(1234567890123456789n);
📤 Ответ#
Ответ об успехе (Задача завершена — Стандартный режим)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "720p",
"modelType": "Flash",
"prompt": "Gentle camera zoom in with soft lighting"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/video_result.mp4",
"cover": "https://cdn.ideal.house/output/video_cover.jpg",
"width": 1280,
"height": 720
}
}
}
Ответ об успехе (Задача завершена — Режим «Первый-Последний Кадр»)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room-day.jpg",
"lastImageUrl": "https://example.com/room-night.jpg",
"duration": 10,
"resolution": "720p",
"modelType": "Flash",
"prompt": "Smooth day to night transition"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/video_result.mp4",
"cover": "https://cdn.ideal.house/output/video_cover.jpg",
"width": 1280,
"height": 720
}
}
}
Ответ (обработка задачи / в очереди)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 2,
"percentage": 30,
"input": {
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "720p",
"modelType": "Flash"
},
"output": null
}
}
Ответ (задача завершилась ошибкой)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"duration": 5,
"resolution": "720p",
"modelType": "Flash"
},
"output": null
}
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | long | Уникальный идентификатор задачи |
status | string | Текущий статус задачи (см. Статус задачи) |
waitNumber | integer | Количество задач впереди в очереди (0 означает текущую обработку) |
percentage | integer | Процент завершения задачи (0–100) |
input | object | Исходные входные параметры задачи |
input.imageUrl | string | URL исходного изображения (первый кадр в режиме «первый-последний») |
input.lastImageUrl | string | URL изображения последнего кадра (присутствует только в режиме «первый-последний кадр») |
input.duration | integer | Длительность видео в секундах (5 или 10) |
input.resolution | string | Разрешение видео (480p, 720p или 1080p) |
input.modelType | string | Использованный тип модели (Flash или Base) |
input.generateAudio | boolean | Была ли включена генерация аудио; только для модели Base |
input.prompt | string | Текстовый запрос (если предоставлен) |
output | object | Результат генерации (доступен только когда status равно Success) |
output.resultUrl | string | URL на сгенерированный файл видео |
output.cover | string | URL на обложку / миниатюру видео |
output.width | integer | Ширина видео в пикселях |
output.height | integer | Высота видео в пикселях |
📊 Статус задачи#
| Статус | Описание |
|---|---|
Unprocessed | Задача создана, но еще не начата |
Processing | Задача в настоящее время обрабатывается |
Success | Задача успешно завершена — результат видео доступен |
Failed | Задача не выполнена из-за ошибки |
Опрашивайте каждые 3-5 секунд. См. Лимит задач API.
❌ Ответы об ошибках#
Все ответы об ошибках имеют одинаковую структуру JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Справочник кодов ошибок#
| Код | Название | Описание | Рекомендуемое действие |
|---|---|---|---|
1001 | FAILED | Запрос не выполнен (общая ошибка) | Проверьте поле message для получения конкретных деталей ошибки |
1003 | INTERNAL_ERROR | Внутренняя ошибка сервера | Повторите попытку после короткой задержки; обратитесь в поддержку, если проблема сохраняется |
1011 | PARAM_ERROR | Ошибка параметров запроса: например, недопустимое сочетание modelType, resolution или duration | Убедитесь, что все обязательные параметры переданы в правильном формате |
5002 | API_KEY_INVALID | Недействительный или отсутствующий ключ API | Убедитесь, что заголовок APIKEY присутствует и значение корректно |
9010 | SCAN_TEXT_ERROR | Текстовый запрос не прошёл проверку контента | Удалите из запроса чувствительный или запрещённый контент |
9038 | PROHIBITED_CONTENT | Сгенерированное выходное изображение содержит запрещенный контент | Отрегулируйте промпт/стиль/входные данные и повторите попытку |
9051 | COINS_NOT_ENOUGH | Недостаточно монет / кредитов | Пополните кредиты на аккаунте и повторите попытку |
📄 Для полного списка общих кодов ошибок API см. Справочник кодов ошибок.