Documentação da Magic Editor API#
URL Base:
https://api.ideal.house
Versão: v1
Atualizado: 2026-03-06
📖 Visão Geral#
A Magic Editor API permite editar e transformar imagens de forma inteligente usando IA. Ao fornecer uma imagem de origem e um prompt de texto opcional, a IA aplicará modificações inteligentes na imagem com base no modo de modelo selecionado. O fluxo de trabalho é assíncrono e envolve duas etapas:
- Criar uma tarefa — Envie sua imagem e parâmetros, então receba um
taskId. - Consultar resultados — Use o
taskIdpara consultar o status da tarefa e recuperar a imagem editada.
🔐 Autenticação#
Todas as requisições da API devem ser autenticadas usando uma Chave API.
Inclua sua Chave API no cabeçalho da requisição:
| Cabeçalho | Valor |
|---|---|
APIKEY | your_api_key_here |
⚠️ Mantenha sua Chave API segura. Não a exponha em código do lado do cliente ou repositórios públicos.
💰 Dedução de Créditos#
[!WARNING] 🪙 Os créditos são deduzidos com base no
modelTypeselecionado após a criação bem-sucedida da tarefa. Se a tarefa eventualmente falhar, os créditos deduzidos serão automaticamente reembolsados para sua conta.
Créditos insuficientes retornarão o código de erro9051. 📄 Consulte Referência de Dedução de Créditos.
Modelo (modelType) | Créditos Deduzidos |
|---|---|
Flash | 1 crédito |
Base | 3 créditos |
Pro | 10 créditos |
📌 Endpoints da API#
1. Criar Tarefa Magic Editor#
Cria uma nova tarefa de editor mágico por IA e retorna um taskId único para consulta.
Endpoint
POST /api/v1/magicEditor/generate
Cabeçalhos da Solicitação
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
APIKEY | ✅ Sim | Sua chave de autenticação API |
Content-Type | ✅ Sim | application/json |
Corpo da Solicitação
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
imageUrl | string | ✅ Sim | URL da imagem de origem a ser editada |
prompt | string | ⚠️ Condicional | Prompt de texto descrevendo as edições desejadas. Obrigatório quando modelType é Base; opcional para modos Flash e Pro |
modelType | string | ❌ Opcional | Tipo de modelo. Enum: Flash, Base, Pro. Padrão é Flash |
🖼️ Requisitos da imagem: Use JPG/JPEG, PNG ou WebP. Cada imagem não pode ter mais de 20 MB, com dimensões de 128 × 128 px até 6,000 × 6,000 px (incluso). Imagens que excedam as dimensões máximas de pixels são automaticamente dimensionadas proporcionalmente para caber dentro de 6,000 × 6,000 px antes do processamento. A URL da imagem deve ser diretamente acessível pelo servidor API.
Tipos de Modelo
| Valor | Descrição | Prompt Obrigatório |
|---|---|---|
Flash | Padrão. Edição rápida com geração automática inteligente por IA | ❌ Opcional |
Base | Edição guiada por texto — usa seu prompt para controlar precisamente a saída | ✅ Obrigatório |
Pro | Edição de maior qualidade com resultados mais detalhados | ❌ Opcional |
⚠️ Importante: Quando
modelTypeéBase, o campopromptdeve ser fornecido. Requisições commodelType=Basee sempromptretornarão um erro de parâmetro.
📥 Exemplos de Solicitação#
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();
📤 Resposta#
Resposta de Sucesso
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
| Campo | Tipo | Descrição |
|---|---|---|
code | integer | 0 indica sucesso |
message | string | Mensagem de resposta |
data | long | O ID único da tarefa para consulta dos resultados |
2. Obter Resultado da Tarefa#
Recupera o status atual e a saída de uma tarefa de editor mágico criada anteriormente.
Endpoint
GET /api/v1/magicEditor/result
Cabeçalhos da Solicitação
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
APIKEY | ✅ Sim | Sua chave de autenticação API |
Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
taskId | long | ✅ Sim | O ID da tarefa retornado pelo endpoint de criação da tarefa |
📥 Exemplos de Solicitação#
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);
📤 Resposta#
Resposta de Sucesso (Tarefa Concluída)
{
"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
}
}
}
Resposta (Tarefa em Processamento / Em Fila)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 40,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
},
"output": null
}
}
Resposta (Tarefa Falhou)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/room.jpg",
"modelType": "Flash"
},
"output": null
}
}
Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | long | Identificador único da tarefa |
status | string | Status atual da tarefa (consulte Status da Tarefa) |
waitNumber | integer | Número de tarefas à frente na fila (0 significa em processamento atual) |
percentage | integer | Percentual de conclusão da tarefa (0–100) |
input | object | Os parâmetros de entrada originais da tarefa |
input.imageUrl | string | URL da imagem de origem |
input.prompt | string | Prompt de texto (se fornecido) |
input.modelType | string | Tipo de modelo utilizado |
output | object | Resultado da geração (disponível apenas quando status é Success) |
output.resultUrl | string | URL para a imagem de saída editada |
output.width | integer | Largura de saída em pixels |
output.height | integer | Altura de saída em pixels |
📊 Status da Tarefa#
| Status | Descrição |
|---|---|
Unprocessed | A tarefa foi criada mas ainda não iniciou |
Processing | A tarefa está atualmente em processamento |
Success | Tarefa concluída com sucesso — a saída está disponível |
Failed | A tarefa falhou devido a um erro |
Termination | A tarefa foi interrompida ou encerrada |
Consulte a cada 3-5 segundos. Consulte Limite de Tarefas da API.
❌ Respostas de Erro#
Todas as respostas de erro compartilham a mesma estrutura JSON:
{
"code": 5002,
"message": "Invalid API Key",
"data": null
}
Referência de Códigos de Erro#
| Código | Nome | Descrição | Ação Sugerida |
|---|---|---|---|
1001 | FAILED | Falha na solicitação (erro genérico) | Verifique o campo message para detalhes específicos do erro |
1003 | INTERNAL_ERROR | Erro interno do servidor | Tente novamente após um curto atraso; entre em contato com o suporte se persistir |
1011 | PARAM_ERROR | Erro de parâmetro da requisição — por exemplo, prompt ausente quando modelType=Base | Certifique-se de fornecer prompt ao usar o modo Base |
5002 | API_KEY_INVALID | Chave API inválida ou ausente | Garanta que o cabeçalho APIKEY esteja presente e que o valor esteja correto |
9010 | SCAN_TEXT_ERROR | O prompt de texto falhou na revisão de conteúdo | Modifique o prompt para remover qualquer conteúdo sensível ou proibido |
9038 | PROHIBITED_CONTENT | A imagem de saída gerada contém conteúdo proibido | Ajuste o prompt/estilo/entradas e tente novamente |
9051 | COINS_NOT_ENOUGH | Moedas/créditos insuficientes | Adicione créditos à sua conta e tente novamente |
📄 Para a lista completa de códigos de erro comuns da API, consulte a Referência de Códigos de Erro.