Dokumentacja API generowania filmów z obrazów#
Podstawowy URL:
https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-03-25
📖 Przegląd#
API generowania filmów z obrazów pozwala generować filmy oparte na AI z pojedynczego obrazu źródłowego lub przez podanie zarówno obrazu pierwszej klatki, jak i obrazu ostatniej klatki, aby kontrolować początek i koniec generowanego filmu. Przepływ pracy jest asynchroniczny i obejmuje dwa kroki:
- Utwórz zadanie — Wyślij swój obraz(y), typ modelu, czas trwania i rozdzielczość, a następnie otrzymasz
taskId. - Cyklicznie sprawdzaj wyniki — Użyj
taskId, aby zapytać o status zadania i pobrać wygenerowany film.
🔐 Uwierzytelnianie#
Wszystkie żądania API muszą być uwierzytelniane za pomocą klucza API Key.
Włącz swój klucz API Key w nagłówku żądania:
| Nagłówek | Wartość |
|---|---|
APIKEY | your_api_key_here |
⚠️ Zachowaj swój klucz API Key w tajemnicy. Nie ujawniaj go w kodzie po stronie klienta ani w publicznych repozytoriach.
💰 Odejmowanie kredytów#
[!WARNING] 🪙 Kredyty są pobierane w oparciu o wybrany
modelType,resolution,durationoraz o to, czygenerateAudiojest włączone przy pomyślnym utworzeniu zadania. Jeśli zadanie ostatecznie zawiedzie, pobrane kredyty zostaną automatycznie zwrócone na Twoje konto.
Niewystarczające kredyty spowodują zwrócenie kodu błędu9051. 📄 Zobacz Referencja odejmowania kredytów.
Model Flash (modelType: "Flash", domyślny):
| Rozdzielczość | Czas trwania | Pobrane kredyty |
|---|---|---|
480p | 5s | 10 kredytów |
480p | 10s | 20 kredytów |
720p | 5s | 20 kredytów |
720p | 10s | 40 kredytów |
1080p | 5s | 40 kredytów |
1080p | 10s | 80 kredytów |
Model Base (modelType: "Base", generateAudio: false):
| Rozdzielczość | Czas trwania | Pobrane kredyty |
|---|---|---|
480p | 5s | 8 kredytów |
480p | 10s | 16 kredytów |
720p | 5s | 16 kredytów |
720p | 10s | 32 kredytów |
1080p | 5s | 32 kredytów |
1080p | 10s | 64 kredytów |
Model Base z dźwiękiem (modelType: "Base", generateAudio: true):
| Rozdzielczość | Czas trwania | Pobrane kredyty |
|---|---|---|
480p | 5s | 16 kredytów |
480p | 10s | 32 kredytów |
720p | 5s | 32 kredytów |
720p | 10s | 64 kredytów |
1080p | 5s | 64 kredytów |
1080p | 10s | 128 kredytów |
📌 Endpoints API#
1. Utwórz zadanie generowania filmu z obrazu#
Tworzy nowe zadanie generowania obrazu do wideo oparte na AI i zwraca unikalny taskId do cyklicznego sprawdzania.
Endpoint
POST /api/v1/imageToVideo/generate
Nagłówki żądania
| Nagłówek | Wymagany | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Content-Type | ✅ Tak | application/json |
Ciało żądania
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
imageUrl | string | ✅ Tak | URL obrazu źródłowego. W trybie pierwszej i ostatniej klatki służy jako pierwsza klatka |
duration | integer | ✅ Tak | Czas trwania wideo w sekundach. Wyliczenie: 5, 10 |
resolution | string | ✅ Tak | Rozdzielczość wyjściowa wideo. Wyliczenie: 480p, 720p, 1080p |
modelType | string | ❌ Opcjonalnie | Typ modelu do użycia w generowaniu. Wyliczenie: Flash, Base. Domyślnie Flash |
generateAudio | boolean | ❌ Opcjonalnie | Czy generować dźwięk tła dla wideo. Dotyczy tylko, gdy modelType to Base. Domyślnie false |
prompt | string | ❌ Opcjonalnie | Tekst podpowiedzi kierujący stylem i ruchem generowania wideo |
lastImageUrl | string | ❌ Opcjonalnie | URL obrazu ostatniej klatki. Jeśli zostanie podany, włącza tryb pierwszej i ostatniej klatki: wideo będzie przechodzić od imageUrl (pierwsza klatka) do lastImageUrl (ostatnia klatka) |
💡 Tryb pierwszej i ostatniej klatki: Jeśli podano
lastImageUrl, API generuje wideo, które płynnie przechodzi od obrazu pierwszej klatki (imageUrl) do obrazu ostatniej klatki (lastImageUrl), dając Ci precyzyjną kontrolę nad początkiem i końcem wideo.
🖼️ Wymagania dotyczące obrazów: Obrazy pierwszej klatki i opcjonalnej ostatniej klatki muszą być w formacie JPG/JPEG, PNG lub WebP. Każdy obraz nie może być większy niż 20 MB, a jego wymiary muszą mieścić się w przedziale od 128 × 128 px do 6,000 × 6,000 px (włącznie). Obrazy przekraczające maksymalne wymiary pikseli są automatycznie skalowane proporcjonalnie, aby zmieściły się w 6,000 × 6,000 px przed przetwarzaniem. Adresy URL obrazów muszą być bezpośrednio dostępne dla serwera API.
Typy modeli
| Wartość | Opis |
|---|---|
Flash | Domyślny. Szybsza prędkość generowania przy wysokiej jakości wyjścia |
Base | Alternatywny model — obsługuje opcjonalne generowanie dźwięku AI (generateAudio) |
Opcje czasu trwania
| Wartość | Opis |
|---|---|
5 | Wideo 5-sekundowe |
10 | Wideo 10-sekundowe |
Opcje rozdzielczości
| Wartość | Opis |
|---|---|
480p | Standardowa definicja — szybsze przetwarzanie |
720p | Wysoka definicja — wyższa jakość wyjścia |
1080p | Pełny HD — najwyższa jakość wyjścia |
📥 Przykłady żądań#
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();
📤 Odpowiedź#
Odpowiedź sukcesu
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Pole | Typ | Opis |
|---|---|---|
code | integer | 0 oznacza sukces |
message | string | Komunikat odpowiedzi |
data | long | Unikalny identyfikator zadania do sprawdzania wyników |
2. Pobierz wynik zadania#
Pobiera bieżący status i wynik wcześniej utworzonego zadania generowania filmu z obrazu.
Endpoint
GET /api/v1/imageToVideo/result
Nagłówki żądania
| Nagłówek | Wymagany | Opis |
|---|---|---|
APIKEY | ✅ Tak | Twój klucz uwierzytelniający API |
Parametry zapytania
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
taskId | long | ✅ Tak | Identyfikator zadania zwrócony z endpointu tworzenia zadania |
📥 Przykłady żądań#
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);
📤 Odpowiedź#
Odpowiedź sukcesu (Zadanie zakończone — Tryb standardowy)
{
"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
}
}
}
Odpowiedź sukcesu (Zadanie zakończone — Tryb pierwszej i ostatniej klatki)
{
"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
}
}
}
Odpowiedź (Zadanie w trakcie przetwarzania / W kolejce)
{
"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
}
}
Odpowiedź (Zadanie nie powiodło się)
{
"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
}
}
Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
id | long | Unikalny identyfikator zadania |
status | string | Bieżący status zadania (zobacz Status zadania) |
waitNumber | integer | Liczba zadań przed Tobą w kolejce (0 oznacza, że zadanie jest obecnie przetwarzane) |
percentage | integer | Procent ukończenia zadania (0–100) |
input | object | Oryginalne parametry wejściowe zadania |
input.imageUrl | string | URL obrazu źródłowego (pierwsza klatka w trybie pierwszej i ostatniej) |
input.lastImageUrl | string | URL obrazu ostatniej klatki (pojawia się tylko w trybie pierwszej i ostatniej klatki) |
input.duration | integer | Czas trwania wideo w sekundach (5 lub 10) |
input.resolution | string | Rozdzielczość wideo (480p, 720p lub 1080p) |
input.modelType | string | Użyty typ modelu (Flash lub Base) |
input.generateAudio | boolean | Czy generowanie dźwięku było włączone (tylko model Base) |
input.prompt | string | Tekst podpowiedzi (jeśli podany) |
output | object | Wynik generacji (dostępny tylko, gdy status wynosi Success) |
output.resultUrl | string | URL do wygenerowanego pliku wideo |
output.cover | string | URL do okładki / miniatury wideo |
output.width | integer | Szerokość wideo w pikselach |
output.height | integer | Wysokość wideo w pikselach |
📊 Status zadania#
| Status | Opis |
|---|---|
Unprocessed | Zadanie zostało utworzone, ale nie zostało jeszcze rozpoczęte |
Processing | Zadanie jest obecnie przetwarzane |
Success | Zadanie zakończyło się pomyślnie — wynik wideo jest dostępny |
Failed | Zadanie nie powiodło się z powodu błędu |
Wykonuj cykliczne sprawdzanie stanu co 3-5 sekund. Zobacz Limit zadań API.
❌ Odpowiedzi błędów#
Wszystkie odpowiedzi błędów mają tę samą strukturę JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Referencja kodów błędów#
| Kod | Nazwa | Opis | Sugerowane działanie |
|---|---|---|---|
1001 | FAILED | Żądanie nie powiodło się (błąd ogólny) | Sprawdź pole message, aby uzyskać szczegółowe informacje o błędzie |
1003 | INTERNAL_ERROR | Wewnętrzny błąd serwera | Ponów próbę po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem utrzymuje się |
1011 | PARAM_ERROR | Błąd parametru żądania — e.g. nieprawidłowa kombinacja modelType, resolution lub duration | Zweryfikuj, czy wszystkie wymagane parametry zostały podane i poprawnie sformatowane |
5002 | API_KEY_INVALID | Nieprawidłowy lub brakujący klucz API | Upewnij się, że nagłówek APIKEY jest obecny i ma poprawną wartość |
9010 | SCAN_TEXT_ERROR | Wskazówka tekstowa nie przeszła weryfikacji treści | Zmodyfikuj wskazówkę, aby usunąć wszelkie treści wrażliwe lub zakazane |
9038 | PROHIBITED_CONTENT | Wygenerowany obraz wyjściowy zawiera treści zakazane | Dostosuj wskazówkę/styl/wejścia i ponów próbę |
9051 | COINS_NOT_ENOUGH | niewystarczające monety / kredyty | Doładuj kredyty na swoim koncie i ponów |
📄 Pełną listę wspólnych kodów błędów API znajdziesz w Referencji kodów błędów.