# HeyGen Avatar IV

> Crie um vídeo falado em 720p com um retrato e um roteiro. A duração depende do roteiro e da voz.

- Página do modelo: https://yir.ai/pt/models/avatar-iv
- ID do modelo: `heygen/avatar-iv`
- Cobrança: pelo canal que executou o job; tentativas que o upstream não cobrou são grátis.

## Preços

Preços públicos atuais por canal para a mesma especificação de saída; os preços oficiais são uma referência. Você paga pelo canal que de fato executa o job, que pode mudar em um failover.

| Especificação de saída | Canal | Preço público |
|---|---|---|
| Especificação uniforme | FAL | $ 0,10 / segundo |

## Parâmetros

- Operação: `generate_video`

| Parâmetro | Valores | Padrão |
|---|---|---|
| `input` | reference | reference |
| `resolution` | 720p | 720p |
| `aspect_ratio` | 16:9 / 9:16 / 4:5 / 5:4 / 1:1 / auto | 16:9 |

## Integração

Escolha uma opção: o SDK oficial para código novo, ou troque a Base URL em projetos que já usam o protocolo da OpenAI.

### SDK oficial (TypeScript)

O SDK chama a Standard API (https://gateway.yir.ai) para enviar, aguardar e coletar jobs; também há um SDK em Go. https://yir.ai/docs/integrations/sdk

```bash
pnpm add @yir-ai/sdk
```

```ts
import { createNodeYirClient } from "@yir-ai/sdk/server";

// Reads YIR_API_KEY from the environment by default: process.env.YIR_API_KEY
const client = createNodeYirClient();

// 1. Submit a video generation job
const job = await client.submitVideo({
  model: "heygen/avatar-iv",
  input: {
    type: "reference",
    prompt: "Uma tartaruga marinha nada devagar sobre um recife de coral. A câmera acompanha suavemente pela lateral enquanto a luz do sol atravessa a água cristalina, projetando padrões em movimento no casco",
    references: [],
  },
  parameters: {
    resolution: "720p",
    aspect_ratio: "16:9",
    n: 1,
  },
});

// 2. Wait for the job to finish and deliver its result
const result = await client.waitForJob(job.id);
console.log("Delivered files:", result.result);
if (result.result && "files" in result.result) {
  for (const file of result.result.files) {
    console.log("->", file.url);
  }
}
```

### API compatível com OpenAI

Protocolos OpenAI Images e Sora Videos para SDKs da OpenAI e gateways como o new-api; sem chat. https://yir.ai/docs/integrations/openai-compatibility

- base_url do SDK da OpenAI: `https://gateway.yir.ai/openai/v1`
- Base URL do canal no new-api (tipo de canal OpenAI): `https://gateway.yir.ai/openai`
- ID do modelo: `heygen/avatar-iv`

```bash
curl https://gateway.yir.ai/openai/v1/videos \
  -H "Authorization: Bearer $YIR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "heygen/avatar-iv",
    "prompt": "Uma tartaruga marinha nada devagar sobre um recife de coral. A câmera acompanha suavemente pela lateral enquanto a luz do sol atravessa a água cristalina, projetando padrões em movimento no casco",
    "resolution": "720p",
    "aspect_ratio": "16:9",
    "seconds": "0"
  }'
```

## Regras

- Autentique com Authorization: Bearer $YIR_API_KEY; mantenha a key em uma variável de ambiente do servidor, nunca em código de navegador, controle de versão, prompts ou logs.
- Os jobs são assíncronos: guarde o Job ID, espere um estado final e depois leia o resultado; trate falhas e cancelamentos.
- Para retentativas seguras, reutilize a mesma chave de idempotência e a mesma requisição; não reenvie às cegas quando o resultado for desconhecido.
- As URLs de resultado são temporárias; copie os arquivos para outro lugar se precisar guardá-los.

## Links

- [Início rápido](https://yir.ai/docs/getting-started/quickstart)
- [Referência da API](https://yir.ai/docs/reference)
- [llms.txt](https://yir.ai/llms.txt)
