Dokumentacja Magic Editor API#
Podstawowy URL:
https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-03-06
📖 Przegląd#
Magic Editor API umożliwia inteligentną edycję i transformację obrazów za pomocą AI. Podając obraz źródłowy i opcjonalne polecenie tekstowe, AI zastosuje inteligentne modyfikacje do obrazu na podstawie wybranego trybu modelu. Praca jest asynchroniczna i obejmuje dwa kroki:
- Utworzenie zadania — Prześlij swój obraz i parametry, a następnie otrzymaj
taskId. - Cykliczne sprawdzanie wyników — Użyj
taskId, aby zapytać o status zadania i pobrać edytowany obraz.
🔐 Uwierzytelnianie#
Wszystkie żądania API muszą być uwierzytelniane za pomocą klucza API.
Włącz swój klucz API w nagłówku żądania:
| Nagłówek | Wartość |
|---|---|
APIKEY | your_api_key_here |
⚠️ Zabezpiecz swój klucz API. Nie ujawniaj go w kodzie po stronie klienta ani w publicznych repozytoriach.
💰 Odejmowanie kredytów#
[!WARNING] 🪙 Kredyty są odbierane na podstawie wybranego
modelTypepo pomyślnym utworzeniu zadania. Jeśli zadanie ostatecznie zawiedzie, odebrane kredyty zostaną automatycznie zwrócone na Twoje konto.
Niewystarczające kredyty zwrócą kod błędu9051. 📄 Zobacz Referencja odejmowania kredytów.
Model (modelType) | Odebrane kredyty |
|---|---|
Flash | 1 kredyt |
Base | 3 kredyty |
Pro | 10 kredyty |
📌 Końcówki API#
1. Utworzenie zadania Magic Editor#
Tworzy nowe zadanie magicznej edycji z użyciem AI i zwraca unikalny taskId do cyklicznego sprawdzania.
Końcówka
POST /api/v1/magicEditor/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 | Adres URL obrazu źródłowego do edycji |
prompt | string | ⚠️ Warunkowe | Polecenie tekstowe opisujące pożądane edycje. Wymagane, gdy modelType to Base; opcjonalne dla trybów Flash i Pro |
modelType | string | ❌ Opcjonalne | Typ modelu. Wyliczenie: Flash, Base, Pro. Domyślnie: Flash |
🖼️ Wymagania dotyczące obrazów: Używaj formatu 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ć się w 6,000 × 6,000 px przed przetwarzaniem. Adres URL obrazu musi być bezpośrednio dostępny dla serwera API.
Typy modeli
| Wartość | Opis | Wymagane polecenie |
|---|---|---|
Flash | Domyślny. Szybka edycja z automatyczną, inteligentną generacją opartą na AI | ❌ Opcjonalne |
Base | Edycja kierowana tekstem — używa Twojego polecenia do precyzyjnego sterowania wynikiem | ✅ Wymagane |
Pro | Edycja o wyższej jakości z bardziej szczegółowymi wynikami | ❌ Opcjonalne |
⚠️ Ważne: Gdy
modelTypetoBase, polepromptmusi zostać podane. Żądania zmodelType=Basei bezpromptzwrócą błąd parametru.
📥 Przykłady żądań#
cURL
# Flash mode (default) — prompt is optional
curl -X POST "https://api.ideal.house/api/v1/magicEditor/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
}'
# Base mode — prompt is required
curl -X POST "https://api.ideal.house/api/v1/magicEditor/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"prompt": "Change the wall color to warm beige and add wooden flooring",
"modelType": "Base"
}'
# Pro mode — prompt is optional
curl -X POST "https://api.ideal.house/api/v1/magicEditor/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/room.jpg",
"prompt": "Modern Scandinavian style interior",
"modelType": "Pro"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class MagicEditorApiExample {
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 mode (default) — no prompt needed
String requestBody = """
{
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
}
""";
// Base mode — prompt is required
// String requestBody = """
// {
// "imageUrl": "https://example.com/room.jpg",
// "prompt": "Change the wall color to warm beige and add wooden flooring",
// "modelType": "Base"
// }
// """;
// Pro mode — prompt is optional
// String requestBody = """
// {
// "imageUrl": "https://example.com/room.jpg",
// "prompt": "Modern Scandinavian style interior",
// "modelType": "Pro"
// }
// """;
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/magicEditor/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 mode (default) — no prompt needed
payload = {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
}
# Base mode — prompt is required
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "prompt": "Change the wall color to warm beige and add wooden flooring",
# "modelType": "Base"
# }
# Pro mode — prompt is optional
# payload = {
# "imageUrl": "https://example.com/room.jpg",
# "prompt": "Modern Scandinavian style interior",
# "modelType": "Pro"
# }
response = requests.post(
f"{BASE_URL}/api/v1/magicEditor/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 createMagicEditorTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/magicEditor/generate`,
{
// Flash mode (default) — no prompt needed
imageUrl: 'https://example.com/room.jpg',
modelType: 'Flash'
// Base mode — prompt is required:
// imageUrl: 'https://example.com/room.jpg',
// prompt: 'Change the wall color to warm beige and add wooden flooring',
// modelType: 'Base'
// Pro mode — prompt is optional:
// imageUrl: 'https://example.com/room.jpg',
// prompt: 'Modern Scandinavian style interior',
// modelType: 'Pro'
},
{
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);
}
}
createMagicEditorTask();
📤 Odpowiedź#
Odpowiedź sukcesu
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Pole | Typ | Opis |
|---|---|---|
code | integer | 0 wskazuje sukces |
message | string | komunikat odpowiedzi |
data | long | unikalny identyfikator zadania do cyklicznego sprawdzania wyników |
2. Pobranie wyniku zadania#
Pobiera bieżący status i wynik wcześniej utworzonego zadania Magic Editor.
Końcówka
GET /api/v1/magicEditor/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 końcówki tworzenia zadania |
📥 Przykłady żądań#
cURL
curl -X GET "https://api.ideal.house/api/v1/magicEditor/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class MagicEditorResultExample {
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/magicEditor/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/magicEditor/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", "Termination"):
break
time.sleep(3) # Poll every 3 seconds
if status == "Success":
print("Result URL:", result["output"]["resultUrl"])
else:
print("Task ended with status:", status)
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/magicEditor/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', 'Termination'].includes(status)) {
if (status === 'Success') {
console.log('Result URL:', result.output.resultUrl);
console.log('Size:', result.output.width, 'x', result.output.height);
} else {
console.log('Task ended with status:', status);
}
break;
}
// Wait 3 seconds before next poll
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollResult(1234567890123456789n);
📤 Odpowiedź#
Odpowiedź sukcesu (zadanie zakończone)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/room.jpg",
"prompt": "Change the wall color to warm beige and add wooden flooring",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/magic_editor_result.jpg",
"width": 1024,
"height": 1024
}
}
}
Odpowiedź (zadanie w trakcie przetwarzania / w kolejce)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 40,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
},
"output": null
}
}
Odpowiedź (zadanie niepowodzenie)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"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 bieżące przetwarzanie) |
percentage | integer | procent ukończenia zadania (0–100) |
input | object | oryginalne parametry wejściowe zadania |
input.imageUrl | string | Adres URL obrazu źródłowego |
input.prompt | string | Polecenie tekstowe (jeśli podano) |
input.modelType | string | użyty typ modelu |
output | object | wynik generowania (dostępny tylko, gdy status wynosi Success) |
output.resultUrl | string | Adres URL edytowanego obrazu wyjściowego |
output.width | integer | szerokość wyjścia w pikselach |
output.height | integer | wysokość wyjścia 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 jest dostępny |
Failed | zadanie nie powiodło się z powodu błędu |
Termination | zadanie zostało przerwane lub zakończone |
Cyklicznie sprawdzaj 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 po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem utrzymuje się |
1011 | PARAM_ERROR | Błąd parametru żądania — np., brak prompt przy modelType=Base | Upewnij się, że podano prompt przy użyciu trybu Base |
5002 | API_KEY_INVALID | nieprawidłowy lub brakujący klucz API | Upewnij się, że nagłówek APIKEY jest obecny i wartość jest poprawna |
9010 | SCAN_TEXT_ERROR | prompt tekstowy nie przeszedł weryfikacji treści | Zmodyfikuj prompt, aby usunąć wszelką wrażliwą lub zakazaną treść |
9038 | PROHIBITED_CONTENT | wygenerowany obraz wyjściowy zawiera zakazaną treść | Dostosuj prompt/styl/wejścia i ponów |
9051 | COINS_NOT_ENOUGH | niewystarczające monety / kredyty | Doładuj kredyty na swoim koncie i ponów |
📄 Pełna lista powszechnych kodów błędów API znajduje się w Referencji kodów błędów.