조경 API 문서#
기본 URL:
https://api.ideal.house
버전: v1
갱신일: 2026-05-21
📖 개요#
조경 API는 원본 이미지를 바탕으로 야외 조경 공간을 개선하거나 다시 설계합니다. 선택적 텍스트 지침, 정원 스타일 옵션, 조경 요소 및 모델 모드를 지원합니다.
작업 흐름은 비동기 방식입니다.
- 작업 생성 —
imageUrl과 선택 매개변수를 제출하고taskId를 받습니다. - 결과 폴링 —
taskId로 작업 상태와 생성된 이미지를 조회합니다.
🔐 인증#
| 헤더 | 값 |
|---|---|
APIKEY | your_api_key_here |
💰 크레딧 차감#
[!WARNING] 크레딧은 작업이 성공적으로 생성될 때 차감됩니다. 작업이 최종적으로 실패하면 차감된 크레딧은 자동 환불됩니다.
크레딧이 부족하면 오류 코드9051을 반환합니다. 크레딧 차감 참조를 참고하세요.
모델 (modelType) | 차감 크레딧 |
|---|---|
Flash | 1크레딧 |
Base | 3크레딧 |
Pro | 10크레딧 |
modelType을 제공하지 않으면 기본값으로 Base를 사용합니다.
🎨 스타일 옵션#
이 API는 API 스타일 설정 엔드포인트가 반환하는 선택적 스타일 매개변수를 지원합니다.
사용 항목:
GET /api/v1/style/landscaping/getStyles
| 스타일 그룹 | 요청 필드 | 설명 |
|---|---|---|
gardenStyle | sceneId | 정원 또는 조경 스타일 옵션 |
elements | sceneElementId | 조경 요소 옵션입니다. id1,id2처럼 여러 옵션 ID를 쉼표로 구분하여 사용할 수 있습니다. |
각 옵션에는 name, id 및 url이 포함됩니다. 옵션의 id를 해당 요청 필드에 전달하세요.
📌 API 엔드포인트#
1. 조경 작업 생성#
엔드포인트
POST /api/v1/landscaping/generate
요청 헤더
| 헤더 | 필수 여부 | 설명 |
|---|---|---|
APIKEY | ✅ 예 | API 인증 키 |
Content-Type | ✅ 예 | application/json |
요청 본문
| 필드 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
imageUrl | string | ✅ 예 | 원본 조경 이미지 URL |
prompt | string | ❌ 선택 | 원하는 결과에 대한 텍스트 지침 |
sceneId | string | ❌ 선택 | gardenStyle 스타일 옵션의 정원 스타일 ID |
sceneElementId | string | ❌ 선택 | elements 스타일 옵션의 조경 요소 ID입니다. id1,id2처럼 여러 ID를 쉼표로 구분하여 사용할 수 있습니다. |
modelType | string | ❌ 선택 | 열거형: Flash, Base, Pro. 기본값 Base |
imageUrl만 필수입니다. 나머지 필드는 모두 선택 사항입니다.
🖼️ 이미지 요건: 모든 원본 및 참조 이미지는 JPG/JPEG, PNG 또는 WebP여야 합니다. 각 이미지는 20 MB 이하여야 하며 크기는 128 × 128 px부터 6,000 × 6,000 px까지 허용됩니다(경계값 포함). 최대 픽셀 크기를 초과하는 이미지는 처리 전에 6,000 × 6,000 px 안에 들어오도록 비율을 유지하여 자동 축소됩니다. 이미지 URLs는 API 서버에서 직접 접근할 수 있어야 합니다.
📥 요청 예제#
cURL
curl -X POST "https://api.ideal.house/api/v1/landscaping/generate" \
-H "APIKEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"imageUrl": "https://example.com/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
}'
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class LandscapingApiExample {
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();
String requestBody = """
{
"imageUrl": "https://example.com/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
}
""";
Request request = new Request.Builder()
.url(BASE_URL + "/api/v1/landscaping/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"
}
payload = {
"imageUrl": "https://example.com/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
}
response = requests.post(
f"{BASE_URL}/api/v1/landscaping/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 createLandscapingTask() {
try {
const response = await axios.post(
`${BASE_URL}/api/v1/landscaping/generate`,
{
imageUrl: 'https://example.com/backyard.jpg',
prompt: 'lush modern garden with clean stone paths',
sceneId: 'Landscape Design_Landscape Style_Mid-Century Modern Pool',
sceneElementId: 'Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover',
modelType: 'Base'
},
{
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);
}
}
createLandscapingTask();
📤 응답#
{
"code": 0,
"message": "success",
"data": 1234567890123456789
}
2. 작업 결과 조회#
엔드포인트
GET /api/v1/landscaping/result
요청 헤더
| 헤더 | 필수 여부 | 설명 |
|---|---|---|
APIKEY | ✅ 예 | API 인증 키 |
쿼리 매개변수
| 매개변수 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
taskId | long | ✅ 예 | 생성 엔드포인트가 반환한 작업 ID |
📥 요청 예제#
cURL
curl -X GET "https://api.ideal.house/api/v1/landscaping/result?taskId=1234567890123456789" \
-H "APIKEY: your_api_key_here"
Java (OkHttp)
import okhttp3.*;
import java.io.IOException;
public class LandscapingResultExample {
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/landscaping/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
while True:
response = requests.get(
f"{BASE_URL}/api/v1/landscaping/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(3)
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 pollLandscapingResult(taskId) {
const headers = { APIKEY: API_KEY };
while (true) {
const response = await axios.get(
`${BASE_URL}/api/v1/landscaping/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('Result URL:', result.output.resultUrl);
console.log('Size:', result.output.width, 'x', result.output.height);
} else {
console.log('Task ended with status:', status);
}
break;
}
await new Promise(resolve => setTimeout(resolve, 3000));
}
}
pollLandscapingResult(1234567890123456789n);
📤 응답 예제#
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Success",
"waitNumber": 0,
"percentage": 100,
"input": {
"imageUrl": "https://example.com/backyard.jpg",
"prompt": "lush modern garden with clean stone paths",
"sceneId": "Landscape Design_Landscape Style_Mid-Century Modern Pool",
"sceneElementId": "Landscape Design_Scene Elements_Natural Elements_Flower,Landscape Design_Scene Elements_Natural Elements_Ground Cover",
"modelType": "Base"
},
"output": {
"resultUrl": "https://cdn.ideal.house/output/landscaping_result.jpg",
"width": 1024,
"height": 1024
}
}
}
응답 (작업 처리 중 / 대기열에 있음)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Processing",
"waitNumber": 1,
"percentage": 45,
"input": {
"imageUrl": "https://example.com/backyard.jpg",
"modelType": "Base"
},
"output": null
}
}
응답 (작업 실패)
{
"code": 0,
"message": "success",
"data": {
"id": 1234567890123456789,
"status": "Failed",
"waitNumber": 0,
"percentage": 0,
"input": {
"imageUrl": "https://example.com/backyard.jpg",
"modelType": "Base"
},
"output": null
}
}
📊 작업 상태#
| 상태 | 설명 |
|---|---|
Unprocessed | 작업이 생성되어 대기열에서 기다리는 중 |
Processing | 작업이 현재 실행 중 |
Success | 작업이 성공적으로 완료됨 |
Failed | 작업이 실패하여 출력이 생성되지 않음 |
3-5초마다 폴링하세요. API 작업 제한을 참고하세요.
❌ 오류 응답#
| 코드 | 이름 | 설명 |
|---|---|---|
1011 | PARAM_ERROR | 요청 매개변수 오류 |
5002 | API_KEY_INVALID | 유효하지 않거나 누락된 API 키 |
9010 | SCAN_TEXT_ERROR | 프롬프트가 콘텐츠 검토를 통과하지 못함 |
9038 | PROHIBITED_CONTENT | 생성된 이미지에 금지된 콘텐츠가 포함됨 |
9051 | COINS_NOT_ENOUGH | 크레딧 부족 |
전체 공통 오류 정의는 오류 코드 참조를 참고하세요.