> ## Documentation Index
> Fetch the complete documentation index at: https://www.krea.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API do Krea 3

> Guia da API do Krea 3, modelo rápido de edição de imagens que segue instruções: endpoint, parâmetros, modos de raciocínio, edições regionais e preços.

O Krea 3 é um modelo rápido de edição de imagens. Ele segue instruções em linguagem natural: você diz o que deve mudar e o que deve continuar igual, e o Krea 3 gera a edição em segundos. Você também pode usá-lo para gerar imagens a partir de texto.

<Info>
  A API do Krea 3 está em **acesso antecipado**. Somente workspaces que participam do beta do Krea 3 podem chamá-la. Para solicitar acesso, entre em contato com [sales@krea.ai](mailto:sales@krea.ai).
</Info>

## Endpoint

| Modelo | Endpoint |
| - | - |
| **Krea 3** | `POST /generate/image/krea/krea-3` |

O endpoint segue o [ciclo de vida do job](/docs/pt-BR/developers/job-lifecycle) padrão: ele retorna um `job_id`, e você faz polling em `GET /jobs/{job_id}` (ou usa um [webhook](/docs/pt-BR/developers/webhooks)) até o job ser concluído. A imagem gerada fica em `result.urls[0]`.

## Início rápido: sua primeira edição de imagem

Todas as requisições exigem um Bearer token. Veja [Chaves de API e cobrança](/docs/pt-BR/developers/api-keys-and-billing) se você ainda não tiver um.

<Steps>
  <Step title="Envie uma referência">
    Faça `POST /assets` com sua imagem de entrada. A resposta retorna `image_url`. Você também pode passar uma URL de imagem externa ou um data URI em base64 diretamente em `image_urls`.
  </Step>

  <Step title="Crie uma edição">
    Faça `POST /generate/image/krea/krea-3` com seu prompt e sua referência. Guarde o `job_id` da resposta.
  </Step>

  <Step title="Obtenha o resultado">
    Faça polling em `GET /jobs/{job_id}` até que `status` seja `completed`. O resultado fica em `result.urls[0]`.
  </Step>
</Steps>

<CodeGroup>
  ```bash cURL theme={null}
  # Bash + curl + jq. Set KREA_API_TOKEN to your API token first.
  set -euo pipefail
  : "${KREA_API_TOKEN:?Set your Krea API token}"

  # 1. Upload a reference
  ASSET=$(curl --fail-with-body --silent --show-error --max-time 60 \
    https://api.krea.ai/assets \
    -H "Authorization: Bearer $KREA_API_TOKEN" \
    -F "file=@reference.png")

  IMAGE_URL=$(printf '%s' "$ASSET" | jq -er '.image_url')

  # 2. Create an edit
  PAYLOAD=$(jq -n --arg image "$IMAGE_URL" '{
    prompt: "Place the product on a clean studio background",
    thinking_mode: "fast",
    image_urls: [$image],
    resolution: "2k"
  }')

  JOB=$(curl --fail-with-body --silent --show-error --max-time 60 \
    https://api.krea.ai/generate/image/krea/krea-3 \
    -H "Authorization: Bearer $KREA_API_TOKEN" \
    -H "Content-Type: application/json" \
    -d "$PAYLOAD")

  JOB_ID=$(printf '%s' "$JOB" | jq -er '.job_id')

  # 3. Get the result
  for attempt in $(seq 1 150); do
    JOB=$(curl --fail-with-body --silent --show-error --max-time 30 \
      "https://api.krea.ai/jobs/$JOB_ID" \
      -H "Authorization: Bearer $KREA_API_TOKEN")
    STATUS=$(printf '%s' "$JOB" | jq -er '.status')
    case "$STATUS" in
      completed)
        printf '%s' "$JOB" | jq -er '.result.urls[0]'
        exit 0 ;;
      failed|cancelled)
        printf 'Job ended: %s\n' "$STATUS" >&2; exit 1 ;;
      scheduled|processing|queued|backlogged|sampling|intermediate-complete)
        sleep 2 ;;
      *) printf 'Unexpected status: %s\n' "$STATUS" >&2; exit 1 ;;
    esac
  done
  printf 'Polling timed out\n' >&2
  exit 1
  ```

  ```python Python theme={null}
  # Python 3 + requests: pip install requests
  # Set KREA_API_TOKEN to your API token first.
  import os
  import time
  import requests

  api = "https://api.krea.ai"
  headers = {"Authorization": f"Bearer {os.environ['KREA_API_TOKEN']}"}

  # 1. Upload a reference
  with open("reference.png", "rb") as image:
      response = requests.post(
          f"{api}/assets", headers=headers,
          files={"file": image}, timeout=60,
      )
  response.raise_for_status()
  image_url = response.json()["image_url"]

  # 2. Create an edit
  response = requests.post(
      f"{api}/generate/image/krea/krea-3",
      headers=headers,
      json={
          "prompt": "Place the product on a clean studio background",
          "thinking_mode": "fast",
          "image_urls": [image_url],
          "resolution": "2k",
      },
      timeout=60,
  )
  response.raise_for_status()
  job_id = response.json()["job_id"]

  # 3. Get the result
  pending = {"scheduled", "processing", "queued", "backlogged",
             "sampling", "intermediate-complete"}
  deadline = time.monotonic() + 300

  while time.monotonic() < deadline:
      response = requests.get(
          f"{api}/jobs/{job_id}", headers=headers, timeout=30,
      )
      response.raise_for_status()
      job = response.json()
      if job["status"] == "completed":
          print(job["result"]["urls"][0])
          break
      if job["status"] not in pending:
          raise RuntimeError(f"Job ended: {job['status']}")
      time.sleep(2)
  else:
      raise TimeoutError("Polling timed out")
  ```

  ```javascript Node.js theme={null}
  // Node.js 22+. Save as example.mjs.
  // Set KREA_API_TOKEN to your API token first.
  import { readFile } from "node:fs/promises";

  const token = process.env.KREA_API_TOKEN;
  if (!token) throw new Error("Set your Krea API token");
  const api = "https://api.krea.ai";
  const headers = { Authorization: `Bearer ${token}` };

  async function request(path, options = {}) {
    const response = await fetch(`${api}${path}`, {
      ...options,
      headers: { ...headers, ...options.headers },
      signal: AbortSignal.timeout(60_000),
    });
    if (!response.ok) throw new Error(`HTTP ${response.status}`);
    return response.json();
  }

  // 1. Upload a reference
  const form = new FormData();
  form.append("file", new Blob([await readFile("reference.png")]), "reference.png");
  const asset = await request("/assets", { method: "POST", body: form });

  // 2. Create an edit
  const job = await request("/generate/image/krea/krea-3", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      prompt: "Place the product on a clean studio background",
      thinking_mode: "fast",
      image_urls: [asset.image_url],
      resolution: "2k",
    }),
  });

  // 3. Get the result
  const pending = new Set([
    "scheduled", "processing", "queued", "backlogged",
    "sampling", "intermediate-complete",
  ]);
  const deadline = Date.now() + 300_000;
  let imageUrl;

  while (Date.now() < deadline) {
    const result = await request(`/jobs/${job.job_id}`);
    if (result.status === "completed") {
      imageUrl = result.result.urls[0];
      break;
    }
    if (!pending.has(result.status)) {
      throw new Error(`Job ended: ${result.status}`);
    }
    await new Promise((resolve) => setTimeout(resolve, 2_000));
  }
  if (!imageUrl) throw new Error("Polling timed out");
  console.log(imageUrl);
  ```
</CodeGroup>

<Tip>
  Mantenha seu token de API no seu servidor. Nunca o inclua em código do lado do cliente.
</Tip>

## Parâmetros

| Campo | Tipo | Observações |
| - | - | - |
| `prompt` | string | **Obrigatório.** A instrução de edição. Descreva o que deve mudar e o que deve continuar igual. |
| `image_urls` | array of strings | Opcional. Referências de imagem de entrada, até 8. Inclua pelo menos uma para uma edição; omita para gerar imagens a partir de texto. Aceita um `image_url` de `POST /assets`, uma URL externa ou um data URI em base64. |
| `thinking_mode` | enum | Opcional. `fast` (padrão) ou `high`. Veja [Modos de raciocínio](#thinking-modes). |
| `resolution` | enum | `1k` ou `2k`. Obrigatório, a menos que você informe `width` e `height`. Não combine com `width` e `height`. |
| `aspect_ratio` | enum | Opcional. Um de `1:1`, `4:5`, `3:4`, `2:3`, `9:16`, `5:4`, `4:3`, `3:2`, `16:9`, `21:9`. Use junto com `resolution`. Omita para enquadramento automático. |
| `width` / `height` | integers | Opcional. Dimensões solicitadas, inteiros positivos de até 4096 cada. Informe os dois, sem `resolution` nem `aspect_ratio`. |
| `seed` | integer | Opcional. Omita para usar uma seed aleatória. |
| `negative_prompt` | string | Opcional. O que evitar, até 1,024 caracteres. |
| `regional_edit` | boolean | Opcional. Defina como `true` para uma edição local que mantém o restante da imagem exatamente igual. Exige pelo menos uma imagem em `image_urls`. Veja [Edições regionais](#regional-edits). |

<Note>
  Com `width` e `height`, o resultado é arredondado para a proporção compatível mais próxima e para uma tela de 1k ou 2k. Dimensões exatas em pixels não são garantidas.

  Reutilizar uma `seed` não garante resultados idênticos, porque a etapa de expansão do prompt pode variar entre execuções.
</Note>

<h2 id="thinking-modes">
  Modos de raciocínio
</h2>

Antes de gerar, o Krea 3 interpreta seu prompt. O `thinking_mode` define quanto planejamento ele faz.

| Modo | O que acontece | Use para |
| - | - | - |
| `fast` | O Krea expande o prompt rapidamente e depois gera. É o mais rápido. **Padrão e recomendado.** | Edições claras e simples e a maioria das solicitações do dia a dia. |
| `high` | O Krea usa um mecanismo de raciocínio mais poderoso para planejar edições mais complexas a partir do prompt e das imagens de referência e depois gera. É mais lento. | Edições complexas ou com várias etapas, várias referências para combinar ou um resultado com `fast` que não atendeu ao pedido. |

Se você omitir `thinking_mode`, a API usa `fast`. Os dois modos são compatíveis com `regional_edit`.

<h2 id="regional-edits">
  Edições regionais
</h2>

Com `regional_edit: true`, o Krea 3 regenera apenas as partes da imagem que precisam mudar. Todo o resto permanece exatamente como estava, então você pode editar a mesma imagem várias vezes sem perder qualidade.

**Use para edições locais** em que o restante da imagem precisa continuar idêntico pixel a pixel: mudar a cor de um objeto ou trocá-lo, adicionar ou remover um elemento, corrigir um detalhe ou alterar o texto de uma placa. É a forma segura de encadear edições sobre o resultado mais recente.

**Não use para edições globais** que devem renderizar a imagem inteira novamente: mudar o estilo ou a iluminação, mudar a estação ou o horário do dia, reenquadrar ou combinar várias imagens em uma nova cena. Edições normais renderizam a imagem inteira novamente, então artefatos podem se acumular quando você continua editando o resultado mais recente.

Edições regionais exigem pelo menos uma imagem em `image_urls`.

```json theme={null}
{
  "prompt": "Change the mug to red, keeping everything else the same",
  "image_urls": ["IMAGE_URL"],
  "thinking_mode": "fast",
  "resolution": "2k",
  "regional_edit": true
}
```

## Prompts

O Krea 3 é um editor que segue instruções. Escreva a edição em linguagem natural:

* Comece pela mudança. Adicione apenas os detalhes que ajudam a executá-la.
* Termine com uma frase de preservação quando o restante da imagem deve continuar igual. Não liste tudo o que deve permanecer igual.
* Quando o prompt usar mais de uma imagem, refira-se a cada imagem pelo que ela mostra. Por exemplo: "Coloque o tênis da segunda imagem na pessoa da primeira imagem."

```text theme={null}
Change the mug to red, keeping everything else the same.
```

## Referências de imagem

* O Krea 3 usa cada referência na resolução em que foi enviada. Uma referência maior que 4 MP é redimensionada para 4 MP.
* Cerca de 1 MP é suficiente para a maioria das edições. Não faça upscale de uma referência antes de enviá-la.
* Quando detalhes finos importam (texto pequeno, logotipos, tecidos, rostos em um plano aberto), envie a versão da imagem com a maior resolução que você tiver.
* Com cinco ou mais referências em uma requisição, cada referência é redimensionada para no máximo 1536 px no lado maior. Para referências com todos os detalhes, envie quatro ou menos.

## Zero Data Retention

O Krea 3 é compatível com [Zero Data Retention](/docs/pt-BR/developers/zdr) para workspaces enterprise. Envie o cabeçalho `X-Api-Zero-Data-Retention: 1`. Com o Zero Data Retention:

* Toda imagem em `image_urls` precisa ser um data URI em base64.
* `thinking_mode` pode ser `fast` ou `high`.
* Uma requisição pode usar no máximo 4 referências de imagem.

```bash theme={null}
IMAGE_DATA_URI="data:image/png;base64,$(base64 < ./reference.png | tr -d '\n')"

curl -X POST https://api.krea.ai/generate/image/krea/krea-3 \
  -H "Authorization: Bearer $KREA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "X-Api-Zero-Data-Retention: 1" \
  -d '{
    "prompt": "Change the mug to red, keeping everything else the same",
    "image_urls": ["'"$IMAGE_DATA_URI"'"],
    "thinking_mode": "fast",
    "resolution": "2k"
  }'
```

## Preços

O preço por imagem depende da resolução de saída, do modo de raciocínio e das referências de imagem.

| Componente do preço | Saída 1K | Saída 2K |
| - | - | - |
| Preço base | \$0.03 | \$0.06 |
| Cada imagem de referência 1K | +\$0.02 | +\$0.02 |
| Cada imagem de referência 2K | +\$0.07 | +\$0.07 |
| Modo de raciocínio `high` | +\$0.02 por geração | +\$0.02 por geração |

## Relacionados

<CardGroup cols={2}>
  <Card title="Ciclo de vida do job" icon="arrows-rotate" href="/docs/pt-BR/developers/job-lifecycle">
    Status de jobs, polling e resultados.
  </Card>

  <Card title="Webhooks" icon="bell" href="/docs/pt-BR/developers/webhooks">
    Receba uma notificação quando um job for concluído, em vez de fazer polling.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.