Документация API интеллектуального редактора#
Базовый URL:
https://api.ideal.house
Версия: v1
Обновлено: 2026-03-06
📖 Обзор#
API интеллектуального редактора редактирует и преобразует изображения с помощью ИИ. Вы передаёте исходное изображение и необязательный текстовый запрос, а ИИ вносит изменения в соответствии с выбранным режимом модели. Процесс асинхронный и состоит из двух шагов:
- Создание задачи — Отправьте изображение и параметры, затем получите
taskId. - Опрос результатов — Используйте
taskIdдля запроса статуса задачи и получения отредактированного изображения.
🔐 Аутентификация#
Все запросы API должны проходить аутентификацию с помощью ключа API.
Укажите ваш ключ API в заголовке запроса:
| Заголовок | Значение |
|---|---|
APIKEY | your_api_key_here |
⚠️ Держите ваш ключ API в тайне. Не публикуйте его в клиентском коде или публичных репозиториях.
💰 Списание кредитов#
[!WARNING] 🪙 При успешном создании задачи кредиты списываются в зависимости от выбранного
modelType. Если задача в итоге завершится ошибкой, списанные кредиты будут автоматически возвращены на ваш аккаунт.
При недостатке кредитов возвращается код ошибки9051. 📄 См. Справочник по списанию кредитов.
Модель (modelType) | Списанные кредиты |
|---|---|
Flash | 1 кредит |
Base | 3 кредита |
Pro | 10 кредитов |
📌 Конечные точки API#
1. Создание задачи интеллектуального редактора#
Создаёт новую задачу ИИ для интеллектуального редактора и возвращает уникальный taskId для опроса.
Конечная точка
POST /api/v1/magicEditor/generate
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Content-Type | ✅ Да | application/json |
Тело запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
imageUrl | string | ✅ Да | URL исходного изображения для редактирования |
prompt | string | ⚠️ Условное | Текстовый запрос, описывающий желаемые правки. Обязателен, если modelType равен Base; необязателен для режимов Flash и Pro |
modelType | string | ❌ Необязательно | Тип модели. Перечисление: Flash, Base, Pro. По умолчанию: Flash |
🖼️ Требования к изображениям: Используйте JPG/JPEG, PNG или WebP. Размер файла не должен превышать 20 МБ, а размеры изображения должны находиться в пределах от 128 × 128 пикс. до 6,000 × 6,000 пикс. (включительно). Перед обработкой изображения, превышающие максимальные размеры в пикселях, автоматически уменьшаются с сохранением пропорций до пределов 6,000 × 6,000 пикс. Изображение по указанному URL должно быть напрямую доступно серверу API.
Типы моделей
| Значение | Описание | Обязательность текстового запроса |
|---|---|---|
Flash | По умолчанию. Быстрое редактирование с автоматической интеллектуальной генерацией на базе ИИ | ❌ Необязательно |
Base | Редактирование по тексту — использует ваш запрос для точного управления результатом | ✅ Обязательно |
Pro | Редактирование более высокого качества с более детализированным результатом | ❌ Необязательно |
⚠️ Важно: Если
modelTypeравноBase, полеpromptобязательно. Запросы сmodelType=Baseи безpromptвернут ошибку параметров.
📥 Примеры запросов#
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();
📤 Ответ#
Успешный ответ
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Поле | Тип | Описание |
|---|---|---|
code | integer | 0 указывает на успех |
message | string | Сообщение в ответе |
data | long | Уникальный идентификатор задачи для опроса результатов |
2. Получение результата задачи#
Получает текущий статус и результат ранее созданной задачи интеллектуального редактора.
Конечная точка
GET /api/v1/magicEditor/result
Заголовки запроса
| Заголовок | Обязательный | Описание |
|---|---|---|
APIKEY | ✅ Да | Ваш ключ аутентификации API |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
taskId | long | ✅ Да | Идентификатор задачи, возвращенный из конечной точки создания задачи |
📥 Примеры запросов#
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);
📤 Ответ#
Успешный ответ (задача завершена)
{
"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
}
}
}
Ответ (обработка задачи / в очереди)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 40,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
},
"output": null
}
}
Ответ (задача завершилась ошибкой)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
},
"output": null
}
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
id | long | Уникальный идентификатор задачи |
status | string | Текущий статус задачи (см. Статус задачи) |
waitNumber | integer | Количество задач впереди в очереди (0 означает текущую обработку) |
percentage | integer | Процент завершения задачи (0–100) |
input | object | Исходные входные параметры задачи |
input.imageUrl | string | URL исходного изображения |
input.prompt | string | Текстовый запрос (если предоставлен) |
input.modelType | string | Использованный тип модели |
output | object | Результат генерации (доступен только когда status равно Success) |
output.resultUrl | string | URL на отредактированное изображение |
output.width | integer | Ширина результата в пикселях |
output.height | integer | Высота результата в пикселях |
📊 Статус задачи#
| Статус | Описание |
|---|---|
Unprocessed | Задача создана, но еще не начата |
Processing | Задача в настоящее время обрабатывается |
Success | Задача успешно завершена — результат доступен |
Failed | Задача не выполнена из-за ошибки |
Termination | Выполнение задачи было прервано или прекращено |
Опрашивайте каждые 3-5 секунд. См. Лимит задач API.
❌ Ответы об ошибках#
Все ответы об ошибках имеют одинаковую структуру JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Справочник кодов ошибок#
| Код | Название | Описание | Рекомендуемое действие |
|---|---|---|---|
1001 | FAILED | Запрос не выполнен (общая ошибка) | Проверьте поле message для получения конкретных деталей ошибки |
1003 | INTERNAL_ERROR | Внутренняя ошибка сервера | Повторите попытку после короткой задержки; обратитесь в поддержку, если проблема сохраняется |
1011 | PARAM_ERROR | Ошибка параметров запроса: например, отсутствует prompt при modelType=Base | Убедитесь, что при использовании режима Base передан prompt |
5002 | API_KEY_INVALID | Недействительный или отсутствующий ключ API | Убедитесь, что заголовок APIKEY присутствует и значение корректно |
9010 | SCAN_TEXT_ERROR | Текстовый запрос не прошёл проверку контента | Удалите из запроса чувствительный или запрещённый контент |
9038 | PROHIBITED_CONTENT | Сгенерированное выходное изображение содержит запрещенный контент | Отрегулируйте промпт/стиль/входные данные и повторите попытку |
9051 | COINS_NOT_ENOUGH | Недостаточно монет / кредитов | Пополните кредиты на аккаунте и повторите попытку |
📄 Для полного списка общих кодов ошибок API см. Справочник кодов ошибок.