메인 콘텐츠로 건너뛰기

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.

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

​
신청 절차

API를 사용하려면 먼저 Flux 이미지 생성 API 해당 페이지에서 서비스를 신청해야 합니다. 페이지에 들어가면 “Acquire” 버튼을 클릭합니다. 아래 그림과 같이: 로그인 또는 등록이 되어 있지 않으면 자동으로 로그인 페이지로 이동하여 등록 및 로그인을 요청합니다. 로그인 및 등록 후에는 자동으로 현재 페이지로 돌아옵니다. 첫 신청 시 무료 한도가 제공되어 해당 API를 무료로 사용할 수 있습니다.

​
기본 사용

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

여기서 요청 헤더를 설정한 것을 볼 수 있습니다. 포함된 내용은 다음과 같습니다:
  • accept: 어떤 형식의 응답 결과를 받고 싶은지, 여기서는 application/json으로 작성하여 JSON 형식으로 설정합니다.
  • authorization: API 호출에 필요한 키로, 신청 후 드롭다운에서 직접 선택할 수 있습니다.
또한 요청 본문을 설정했습니다. 포함된 내용은 다음과 같습니다:
  • action: 이번 이미지 생성 작업의 행동.
  • size: 이미지 생성 결과의 크기.
  • count: 생성할 이미지의 수, 기본값은 1이며, 이 매개변수는 이미지 생성 작업에서만 유효하고 편집 작업에서는 무효입니다.
  • prompt: 프롬프트.
  • model: 생성 모델, 기본값은 flux-dev입니다.
  • callback_url: 결과를 회신받을 URL입니다.
매개변수 size에는 몇 가지 특별한 제한이 있으며, 주로 width x height 비율과 x:y 이미지 비율 두 가지 유형으로 나뉩니다. 구체적인 내용은 다음과 같습니다:
모델범위
flux-2-flex지원하는 비율 x >= 64, 32의 배수여야 함
flux-2-pro지원하는 비율 x >= 64, 32의 배수여야 함
flux-2-max지원하는 비율 x >= 64, 32의 배수여야 함
flux-pro-1.1지원하는 비율 256 <= x <= 1440, 32의 배수여야 함
flux-dev지원하는 비율 256 <= x <= 1440, 32의 배수여야 함
flux-pro-1.1-ultra비율 지원하지 않음, 이미지 비율 지원
flux-kontext-pro비율 지원하지 않음, 이미지 비율 지원
flux-kontext-max비율 지원하지 않음, 이미지 비율 지원
참고할 이미지 비율: “1:1”, “16:9”, “21:9”, “3:2”, “2:3”, “4:5”, “5:4”, “3:4”, “4:3”, “9:16”, “9:21”, 선택 후 오른쪽에서도 해당 코드가 생성된 것을 확인할 수 있습니다. 아래 그림과 같이:

“Try” 버튼을 클릭하면 테스트를 진행할 수 있으며, 위 그림과 같이 다음과 같은 결과를 얻을 수 있습니다: 
{
  "success": true,
  "task_id": "226eb763-9eab-4d06-ad57-d59753a03307",
  "trace_id": "089f8b46-0167-4f25-88ee-3c3f88d80e84",
  "data": [
    {
      "prompt": "a white siamese cat",
      "image_url": "https://fal.media/files/lion/NVhtlwwGYQD6HrGaEfrzu_341484fad6d84b21b73f4f8824a3f98a.png",
      "timings": 1752743801
    },
    {
      "prompt": "a white siamese cat",
      "image_url": "https://fal.media/files/monkey/8UEQpFbQCYVOK1wKP3aV0_9bbc26fad64049b18d0244b99ef66ad1.png",
      "timings": 1752743801
    }
  ]
}
반환된 결과는 여러 필드를 포함하고 있으며, 설명은 다음과 같습니다:
  • success: 현재 비디오 생성 작업의 상태.
  • task_id: 현재 비디오 생성 작업 ID.
  • trace_id: 현재 비디오 생성 추적 ID.
  • data: 현재 이미지 생성 작업의 결과 목록.
    • image_url: 현재 이미지 생성 작업의 링크.
    • prompt: 프롬프트.
만족스러운 이미지 정보를 얻었으며, 결과의 data에서 이미지 링크 주소를 통해 생성된 Flux 이미지를 가져올 수 있습니다. 또한 해당 연동 코드를 생성하고 싶다면 직접 복사하여 생성할 수 있습니다. 예를 들어 CURL 코드의 경우 다음과 같습니다: 
curl -X POST 'https://api.xhuoapi.ai/v1/flux/images' \
-H 'authorization: Bearer {token}' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
  "action": "generate",
  "prompt": "a white siamese cat",
  "model": "flux-kontext-pro",
  "count": 2
}'

​
이미지 편집 작업

특정 이미지를 편집하고 싶다면, 먼저 매개변수 image_url에 편집할 이미지 링크를 전달해야 하며, 이때 action은 edit만 지원합니다. 다음과 같은 내용을 지정할 수 있습니다:
  • model: 이번 편집 이미지 작업에 사용되는 모델로, 현재 flux-kontext-max, flux-kontext-pro를 지원합니다.
  • image_url: 편집할 이미지를 업로드합니다.
작성 예시는 다음과 같습니다:

작성 완료 후 자동으로 생성된 코드는 다음과 같습니다:

해당 코드: 
import requests

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

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

payload = {
    "action": "edit",
    "prompt": "a white siamese cat",
    "model": "flux-kontext-pro",
    "image_url": "https://cdn.xhuoapi.ai/ytj2qy.png"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
실행 버튼을 클릭하면 즉시 결과를 얻을 수 있습니다. 결과는 다음과 같습니다: 
{
  "success": true,
  "task_id": "2a7979ff-1f77-4380-92c6-a2dc37c3b4c8",
  "trace_id": "732b65c0-48d9-49f7-b568-64e5acffe4c0",
  "data": [
    {
      "prompt": "a white siamese cat",
      "image_url": "https://fal.media/files/monkey/aEUXJZ6Faj9YXUCQVs01Q_af0cea56c558441c9ba8df67b200812d.png",
      "timings": 1752744073
    }
  ]
}
생성된 효과는 원본 이미지를 편집한 효과이며, 결과는 위와 유사합니다.

​
비동기 콜백

由于 Flux Images Generation API 생성의 시간은 상대적으로 길어 약 1-2 분이 소요되며, API가 오랜 시간 동안 응답하지 않으면 HTTP 요청이 계속 연결을 유지하여 추가적인 시스템 자원 소모를 초래하므로, 본 API는 비동기 콜백 지원도 제공합니다. 전체 프로세스는: 클라이언트가 요청을 시작할 때 추가로 callback_url 필드를 지정하고, 클라이언트가 API 요청을 시작한 후 API는 즉시 결과를 반환하며, 현재 작업 ID를 나타내는 task_id 필드 정보를 포함합니다. 작업이 완료되면 생성된 이미지 결과가 POST JSON 형식으로 클라이언트가 지정한 callback_url로 전송되며, 여기에도 task_id 필드가 포함되어 있어 작업 결과를 ID로 연관시킬 수 있습니다. 아래 예제를 통해 구체적으로 어떻게 작업하는지 알아보겠습니다. 먼저, Webhook 콜백은 HTTP 요청을 수신할 수 있는 서비스로, 개발자는 자신이 구축한 HTTP 서버의 URL로 교체해야 합니다. 여기서는 편리한 시연을 위해 공개 Webhook 샘플 사이트인 https://webhook.site/를 사용하며, 해당 사이트를 열면 Webhook URL을 얻을 수 있습니다. 아래와 같이 표시됩니다: 이 URL을 복사하면 Webhook으로 사용할 수 있으며, 여기서의 샘플은 https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab입니다. 다음으로, 필드 callback_url을 위의 Webhook URL로 설정하고, 해당 매개변수를 입력합니다. 구체적인 내용은 아래와 같습니다:

실행 버튼을 클릭하면 즉시 결과를 얻을 수 있습니다. 아래와 같습니다: 
{
  "task_id": "6a97bf49-df50-4129-9e46-119aa9fca73c"
}
잠시 기다리면 https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab에서 생성된 이미지 결과를 확인할 수 있습니다. 아래와 같이 표시됩니다: 내용은 다음과 같습니다: 
{
  "success": true,
  "task_id": "6a97bf49-df50-4129-9e46-119aa9fca73c",
  "trace_id": "9b4b1ff3-90f2-470f-b082-1061ec2948cc",
  "data": [
    {
      "prompt": "a white siamese cat",
      "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/f4f8d407-377a-408a-82d0-427a5a836f09_0.png",
      "seed": 1698551532,
      "timings": {
        "inference": 3.328
      }
    }
  ]
}
결과에서 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"
}

​
결론

이 문서를 통해 Flux Images Generation API를 사용하여 입력 프롬프트를 통해 이미지를 생성하는 방법을 이해하셨습니다. 이 문서가 API를 더 잘 연동하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 기술 지원 팀에 문의해 주시기 바랍니다.