> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-willie-des-1087-router-migration-block.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy Router에서 Starfish 사용하기

> Comfy Router를 통해 heygen/starfish를 호출합니다: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답을 설명합니다.

HeyGen이 Comfy Router를 통해 제공하는 `heygen/starfish`에 대한 API 레퍼런스입니다.

## 빠른 시작

[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys)에서 키를 생성한 뒤 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 raw HTTP로 수행합니다.

**모델 ID:** `heygen/starfish`

**엔드포인트:** `POST https://api.comfy.org/v2/models/heygen/starfish`

<Tabs>
  <Tab title="결과를 기다리기">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "heygen/starfish",
              {
                  "text": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
                  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0",
              },
          )

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("heygen/starfish", {
        text: "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
        voice_id: "d2f4f24783d04e22ab49ee8fdc3715e0",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/heygen/starfish \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"text\": \"Hello from Comfy. This voice is generated with the HeyGen Starfish engine.\", \"voice_id\": \"d2f4f24783d04e22ab49ee8fdc3715e0\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="대기열에 제출하고 나중에 수집">
    동일한 본문을 `POST https://api.comfy.org/v2/models/heygen/starfish/requests`로 전송합니다. Router는 실행이 접수되는 즉시 `201`과 `request_id`로 응답하며, 결과는 준비가 완료되면 이 프로세스에서든 다른 프로세스에서든 수집할 수 있습니다. [대기열 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 과정을 자세히 다룹니다.

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "heygen/starfish",
              {
                  "text": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
                  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0",
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("heygen/starfish", {
        text: "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
        voice_id: "d2f4f24783d04e22ab49ee8fdc3715e0",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/heygen/starfish/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"text\": \"Hello from Comfy. This voice is generated with the HeyGen Starfish engine.\", \"voice_id\": \"d2f4f24783d04e22ab49ee8fdc3715e0\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/heygen/starfish/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/heygen/starfish/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 스키마

### 입력

<ParamField body="input_type" type="string">
  입력 유형: 일반 텍스트의 경우 'text', SSML 마크업의 경우 'ssml'. 기본값은 'text'
</ParamField>

<ParamField body="language" type="string">
  기본 언어 코드(예: 'en'). 생략하면 텍스트에서 자동 감지됩니다
</ParamField>

<ParamField body="locale" type="string">
  BCP-47 언어 설정 태그(예: 'en-US'). 설정되면 언어 설정에서 언어를 유추합니다
</ParamField>

<ParamField body="speed" type="number">
  속도 배율(0.5-2.0)

  범위: `0.5` \~ `2`

  형식: `double`
</ParamField>

<ParamField body="text" type="string" required>
  합성할 텍스트(1-5000자)
</ParamField>

<ParamField body="voice_id" type="string" required>
  사용할 Voice ID. 해당 음성은 starfish 엔진을 지원해야 합니다
</ParamField>

이 문서는 Router가 `GET /v2/models/heygen/starfish/openapi.json`에서 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에게 도달하기 전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다.

### 출력

<ResponseField name="data" type="object" required>
  성공한 HeyGen 텍스트 기반 음성 생성 응답의 페이로드
</ResponseField>

<ResponseField name="data.audio_url" type="string" required>
  생성된 오디오 파일의 URL
</ResponseField>

<ResponseField name="data.duration" type="number">
  오디오의 재생 시간(초)

  형식: `double`
</ResponseField>

<ResponseField name="data.request_id" type="string">
  이 생성 요청의 고유 식별자
</ResponseField>

<ResponseField name="data.word_timestamps" type="object[]">
  단어 수준 타이밍 데이터
</ResponseField>

<ResponseField name="data.word_timestamps[].end" type="number">
  종료 시간(초)

  형식: `double`
</ResponseField>

<ResponseField name="data.word_timestamps[].start" type="number">
  시작 시간(초)

  형식: `double`
</ResponseField>

<ResponseField name="data.word_timestamps[].word" type="string">
  단어
</ResponseField>

## 예시

### 입력

```json theme={null}
{
  "text": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0"
}
```

### 출력

```json theme={null}
{
  "data": {
    "audio_url": "https://example.invalid/heygen/starfish/speech.mp3",
    "duration": 12.5,
    "request_id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9"
  }
}
```

## 배포 전 확인

SDK는 `Idempotency-Key`를 생성하고 자동 재시도에 재사용합니다. 수동으로 재시도할 때는 원본 키를 재사용하세요. Router는 연결을 최대 10분간 유지할 수 있습니다.

요청이 실패하면 Router는 그 이유를 설명하는 `X-Comfy-Error-Type` 응답 헤더를 보냅니다. `422`는 Router가 공급자를 호출하기 전에 입력을 거부했음을 의미하고, `413`은 요청 본문이 Router가 허용하는 크기보다 컸음을 의미합니다. [결과 URL이 만료](/ko/development/comfy-router/reference#결과-에셋)될 수 있으므로 생성된 에셋은 즉시 다운로드하세요.

위의 필드 설명에 명시된 크기 제한은 해당 필드에 대한 공급자 자체의 한도이며, 공급자 사양에서 인용한 것입니다. Router는 전체 요청 본문에 별도의 상한을 적용하며, base64로 인코딩된 미디어도 여기에 포함됩니다. [요청 본문 크기](/ko/development/comfy-router/limitations)를 참고하세요.

<CardGroup cols={3}>
  <Card title="헤더" icon="list" href="/ko/development/comfy-router/headers">
    인증, 멱등성, 요청 ID, 오류 분류, 재시도 간격, 지출 한도.
  </Card>

  <Card title="Router API 사용" icon="code" href="/ko/development/comfy-router/api">
    모델 검색, 검증 오류, 재시도, 과금.
  </Card>

  <Card title="제한 사항" icon="triangle-exclamation" href="/ko/development/comfy-router/limitations">
    Router가 현재 지원하지 않는 기능과 대신 사용할 방법.
  </Card>
</CardGroup>