메인 콘텐츠로 건너뛰기

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

이 문서에서는 SeeDream Images Generation API 연동 방법을 소개합니다. 이 API는 사용자 정의 매개변수를 입력하여 SeeDream 공식 이미지를 생성할 수 있습니다.

신청 절차

API를 사용하려면 먼저 SeeDream Images Generation API 해당 페이지에서 서비스를 신청해야 합니다. 페이지에 접속한 후, 「Acquire」 버튼을 클릭합니다. 아래 그림과 같습니다: 로그인 또는 회원가입이 되어 있지 않은 경우 자동으로 로그인 페이지로 이동하여 회원가입 및 로그인을 안내합니다. 로그인 후 자동으로 현재 페이지로 돌아옵니다. 최초 신청 시 무료 할당량이 제공되며, 이 API를 무료로 사용할 수 있습니다.

기본 사용법

먼저 기본 사용법을 이해해야 합니다. 입력할 값은 프롬프트 prompt, 생성 동작 action, 이미지 크기 size이며, 이들을 입력하면 처리된 결과를 받을 수 있습니다. 우선 action 필드를 간단히 전달하는데, 값은 generate입니다. 그리고 프롬프트를 입력해야 합니다. 구체적인 내용은 다음과 같습니다:

여기서 Request Headers를 설정한 것을 볼 수 있습니다:
  • accept: 어떤 형식의 응답 결과를 받을지 지정하며, 여기서는 application/json 즉 JSON 형식으로 설정합니다.
  • authorization: API 호출을 위한 키로, 신청 후 드롭다운에서 선택할 수 있습니다.
또한 Request Body에는 다음이 포함됩니다:
  • prompt: 프롬프트(입력 문구).
  • model: 생성 모델, 기본값은 doubao-seedream-5.0-lite입니다. 지원하는 모델은 doubao-seedream-5.0-lite(최신), doubao-seedream-4.5, doubao-seedream-4.0, doubao-seedream-3.0-t2i, doubao-seededit-3.0-i2i입니다.
  • image: 입력 이미지 정보로 URL 또는 Base64 인코딩을 지원합니다. doubao-seedream-5.0-lite, doubao-seedream-4.5, doubao-seedream-4.0은 단일 또는 다중 이미지 입력을 지원하며, doubao-seededit-3.0-i2i는 단일 이미지 입력만 지원합니다. doubao-seedream-3.0-t2i는 이 매개변수를 지원하지 않습니다.
  • size: 생성 이미지 크기 지정 방법으로 두 가지 방식이 있으며 혼용할 수 없습니다. 방식 1 | 생성 이미지 해상도를 지정하고 프롬프트 내에서 자연어로 이미지 가로세로 비율을 설명합니다. 모델별 지원하는 사전 설정이 다릅니다: doubao-seedream-5.0-lite2K/3K/4K 지원, doubao-seedream-4.52K/4K만 지원, doubao-seedream-4.01K/2K/4K 지원, doubao-seedream-3.0-t2idoubao-seededit-3.0-i2i사전 설정을 지원하지 않으며 방식 2만 허용합니다. 방식 2 | 생성 이미지의 가로세로 픽셀 값을 지정합니다: 기본값은 2048x2048이며, 총 픽셀 수 및 가로세로 비율 범위는 모델에 따라 다릅니다(예: 5.0 / 4.5 총 픽셀 하한 3,686,400, 4.0 하한 921,600, 3.0-t2i / seededit-3.0-i2i 범위는 [512x512, 2048x2048]).
  • seed: 모델 생성 내용의 무작위성을 제어하는 난수 시드입니다. 값 범위는 [-1, 2147483647]입니다. doubao-seedream-3.0-t2i만 지원합니다.
  • sequential_image_generation: 연관된 이미지 그룹 생성 기능입니다. doubao-seedream-5.0-lite, doubao-seedream-4.5, doubao-seedream-4.0이 지원하며 기본값은 disabled입니다.
  • stream: 스트리밍 출력 모드 활성화 여부를 제어합니다. doubao-seedream-5.0-lite, doubao-seedream-4.5, doubao-seedream-4.0이 지원하며 기본값은 false입니다.
  • guidance_scale: 모델 출력 결과와 프롬프트 일치 정도를 나타내며 값이 클수록 관련성이 높습니다. 범위는 [1, 10]입니다. doubao-seedream-3.0-t2i 기본값은 2.5, doubao-seededit-3.0-i2i 기본값은 5.5이며, 다른 모델은 지원하지 않습니다.
  • response_format: 생성 이미지 반환 형식을 지정합니다. 기본값은 url이며 b64_json도 지원합니다.
  • watermark: 생성된 이미지에 워터마크를 추가할지 여부입니다. 기본값은 true입니다.
  • output_format: 생성 이미지 파일 형식을 지정하며 jpeg(기본)와 png를 지원합니다. doubao-seedream-5.0-lite만 지원합니다.
  • tools: 모델이 호출할 도구를 설정하며 현재 web_search(인터넷 검색)를 지원합니다. doubao-seedream-5.0-lite만 지원합니다.
  • callback_url: 결과를 콜백 받을 URL입니다.
선택 후 오른쪽에 해당 코드가 생성된 것을 확인할 수 있습니다. 아래 그림과 같습니다:

「Try」 버튼을 클릭하면 테스트할 수 있으며, 위 그림과 같이 다음과 같은 결과를 얻었습니다:
{
  "success": true,
  "task_id": "25027ba3-0430-4a1b-91c8-d2297f19ba73",
  "trace_id": "8043a9e9-692f-43b0-82f7-5890f798be38",
  "data": [
    {
      "prompt": "a white siamese cat",
      "size": "2048x2048",
      "image_url": "https://platform.cdn.xhuoapi.ai/seedream/3c060029-69b1-406f-a957-fcd55ddc9386.jpg"
    }
  ]
}
반환 결과에는 여러 필드가 있으며, 설명은 다음과 같습니다:
  • success: 이미지 생성 작업 상태.
  • task_id: 이미지 생성 작업 ID.
  • trace_id: 이미지 생성 추적 ID.
  • data: 이미지 생성 작업 결과 목록.
    • image_url: 생성된 이미지 링크.
    • prompt: 프롬프트.
    • size: 생성 이미지 픽셀 크기.
만족스러운 이미지 정보를 얻었으며, 결과 내 data의 이미지 링크 주소를 통해 생성된 SeeDream 이미지를 가져올 수 있습니다. 또한 연동 코드를 생성하고 싶다면 바로 복사할 수 있습니다. 예를 들어 CURL 코드는 다음과 같습니다:
curl -X POST 'https://api.xhuoapi.ai/v1/seedream/images' \
-H 'accept: application/json' \
-H 'authorization: Bearer ${token}' \
-H 'content-type: application/json' \
-d '{
  "action": "generate",
  "model": "doubao-seedream-4-0-250828",
  "prompt": "a white siamese cat"
}'

이미지 편집 작업

특정 이미지를 편집하려면, 먼저 image 매개변수에 편집할 이미지 링크를 전달해야 합니다.
  • model: 이번 편집 작업에 사용할 모델로, doubao-seedream-5.0-lite, doubao-seedream-4.5, doubao-seedream-4.0은 단일 또는 다중 이미지 입력을 지원하며, doubao-seededit-3.0-i2i는 단일 이미지 입력만 지원합니다.
  • image: 편집할 이미지 한 장 또는 여러 장을 업로드합니다.
작성 예시는 다음과 같습니다:

해당 코드 예시는 다음과 같습니다:
import requests

url = "https://api.xhuoapi.ai/v1/flux/images"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "model": "doubao-seedream-4-0-250828",
  "prompt": "Keep the model pose and the liquid garment flowing shape unchanged. Change the clothing material from silver metal to completely transparent water (or glass). Through the liquid flow, the details of the model skin are visible. The light and shadow effect shifts from reflection to refraction.",
  "image": ["https://ark-project.tos-cn-beijing.volces.com/doc_image/seedream4_5_imageToimage.png"],
  "size": "2K",
  "watermark": False
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
실행하면 즉시 다음과 같은 결과를 얻을 수 있습니다:
{
    "success": true,
    "task_id": "c9aaffa2-b8ac-40ff-8468-43e77cb9ddde",
    "trace_id": "131a40c3-2eaf-44c9-af28-c9b408577286",
    "data": [
        {
            "prompt": "Keep the model pose and the liquid garment flowing shape unchanged. Change the clothing material from silver metal to completely transparent water (or glass). Through the liquid flow, the details of the model skin are visible. The light and shadow effect shifts from reflection to refraction.",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/3e88db7e-4771-4f6a-adbd-5ae4590c5d59.jpg"
        }
    ]
}
생성된 결과는 원본 이미지를 편집한 효과이며, 이전과 유사한 결과입니다.

비동기 콜백

SeeDream Images Generation API의 생성 시간은 약 1-2분으로 비교적 길기 때문에, API가 장시간 응답하지 않으면 HTTP 요청이 계속 연결되어 시스템 자원이 추가로 소모될 수 있습니다. 이에 본 API는 비동기 콜백을 지원합니다. 전체 흐름은 다음과 같습니다: 클라이언트가 요청 시 추가로 callback_url 필드를 지정하면, API는 즉시 task_id를 포함한 결과를 반환합니다. 작업 완료 후 생성된 이미지 결과를 JSON 형태로 클라이언트가 지정한 callback_url로 POST 전송하며, 이때 task_id도 포함되어 작업 결과를 ID로 연동할 수 있습니다. 아래 예제를 통해 구체적인 작동 방식을 살펴봅니다. 실행하면 즉시 다음과 같은 결과를 얻을 수 있습니다:
{
  "task_id": "c9aaffa2-b8ac-40ff-8468-43e77cb9ddde"
}
내용은 다음과 같습니다:
{
    "success": true,
    "task_id": "c9aaffa2-b8ac-40ff-8468-43e77cb9ddde",
    "trace_id": "131a40c3-2eaf-44c9-af28-c9b408577286",
    "data": [
        {
            "prompt": "Keep the model pose and the liquid garment flowing shape unchanged. Change the clothing material from silver metal to completely transparent water (or glass). Through the liquid flow, the details of the model skin are visible. The light and shadow effect shifts from reflection to refraction.",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/3e88db7e-4771-4f6a-adbd-5ae4590c5d59.jpg"
        }
    ]
}
결과에 task_id 필드가 포함되어 있으며, 다른 필드는 이전과 유사합니다. 이 필드를 통해 작업을 연동할 수 있습니다.

오류 처리

API 호출 시 오류가 발생하면, API는 해당 오류 코드와 메시지를 반환합니다. 예를 들면:
  • 400 token_mismatched: 잘못된 요청, 매개변수 누락 또는 잘못된 경우.
  • 400 api_not_implemented: 잘못된 요청, 매개변수 누락 또는 잘못된 경우.
  • 401 invalid_token: 인증 실패, 유효하지 않거나 누락된 토큰.
  • 429 too_many_requests: 요청 과다, 속도 제한 초과.
  • 500 api_error: 서버 내부 오류.

오류 응답 예시

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

결론

이 문서를 통해 SeeDream Images Generation API를 사용하여 프롬프트 입력으로 이미지를 생성하는 방법을 이해하셨습니다. 본 문서가 API 연동 및 사용에 도움이 되길 바랍니다. 문의 사항이 있으시면 언제든지 기술 지원팀에 연락해 주십시오.