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

# Guia rápido: escolha como você vai usar o Flatkey

> Quatro formas de usar o Flatkey — a API REST, o SDK da OpenAI, a CLI do Flatkey ou seu agente de codificação. Uma chave e um catálogo de modelos por trás de todas elas.

O Flatkey oferece uma chave e quatro formas de usá-la. Todas as quatro compartilham a mesma conta, o mesmo saldo e o mesmo catálogo de modelos — então a única pergunta é qual delas se encaixa na sua forma de trabalhar.

<Frame>
  <img src="https://mintcdn.com/flatkey/9eYACi20Ep-B6T7F/images/quickstart/console-choose-how.png?fit=max&auto=format&n=9eYACi20Ep-B6T7F&q=85&s=99ada27fab6ab988299090f74cd627c0" alt="As quatro formas de usar o Flatkey, mostradas no Flatkey Console" width="3000" height="852" data-path="images/quickstart/console-choose-how.png" />
</Frame>

<Tip>
  Você não precisa escolher de uma vez por todas. Comece com a opção mais próxima do que você está fazendo hoje e adicione as outras depois, usando a mesma chave.
</Tip>

## Antes de começar

Crie uma chave em [console.flatkey.ai/keys](https://console.flatkey.ai/keys). As chaves do Flatkey começam com `sk-`. Todas as opções abaixo usam essa mesma chave, então mantenha-a em uma variável de ambiente e fora do controle de versão.

Cada painel no Console também permite escolher uma chave existente em vez de criar uma nova, inserindo-a diretamente no trecho de código exibido.

## API para desenvolvedores

Chame qualquer modelo via HTTP simples com uma requisição compatível com a OpenAI. Sem SDK, sem dependências — se você tem um cliente HTTP, já está pronto.

<Frame>
  <img src="https://mintcdn.com/flatkey/9eYACi20Ep-B6T7F/images/quickstart/modal-api.png?fit=max&auto=format&n=9eYACi20Ep-B6T7F&q=85&s=3dd0485d2730b29d52b3285bdbe176b7" alt="O painel API para desenvolvedores, com uma requisição pronta para executar" width="1540" height="1150" data-path="images/quickstart/modal-api.png" />
</Frame>

O Console monta a requisição para você: escolha uma chave, escolha um modelo e copie o trecho em **cURL**, **Node.js** ou **Python**.

```bash theme={"dark"}
curl https://router.flatkey.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLATKEY_API_KEY" \
  -d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"Say hello in one sentence."}]}'
```

<Card title="Acesso à API" icon="code" href="/pt/guides/api-access">
  URL base, autenticação, endpoints disponíveis e tratamento de erros.
</Card>

## SDKs para desenvolvedores

Continue usando o SDK da OpenAI que você já utiliza e aponte-o para o Flatkey. Seu código de requisição não muda — apenas a URL base.

<Frame>
  <img src="https://mintcdn.com/flatkey/9eYACi20Ep-B6T7F/images/quickstart/modal-sdk.png?fit=max&auto=format&n=9eYACi20Ep-B6T7F&q=85&s=255f7df4814995aa07fb1816ad7342d1" alt="O painel SDKs para desenvolvedores, com a configuração do SDK" width="1540" height="1150" data-path="images/quickstart/modal-sdk.png" />
</Frame>

Mesma ideia de antes: escolha uma chave e um modelo, depois copie a configuração para sua linguagem.

```python theme={"dark"}
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)
```

<CardGroup cols={2}>
  <Card title="SDK da OpenAI" icon="code" href="/pt/guides/openai-sdk">
    Configuração em Python e Node.js, streaming e chamadas de ferramentas.
  </Card>

  <Card title="SDK da Anthropic" icon="code" href="/pt/guides/anthropic-sdk">
    Roteie requisições do Claude pelo Flatkey da mesma forma.
  </Card>
</CardGroup>

## Flatkey CLI

Gere imagens e vídeos a partir do seu terminal, ou deixe um assistente de IA operar a CLI para você.

<Frame>
  <img src="https://mintcdn.com/flatkey/9eYACi20Ep-B6T7F/images/quickstart/modal-cli.png?fit=max&auto=format&n=9eYACi20Ep-B6T7F&q=85&s=a31f30bab8e5eecfc1f84fe593749af1" alt="O painel Flatkey CLI, mostrando instalação, login e primeiro prompt" width="1540" height="930" data-path="images/quickstart/modal-cli.png" />
</Frame>

<Steps>
  <Step title="Instalar">
    ```bash theme={"dark"}
    npm i -g @flatkey-ai/cli
    ```
  </Step>

  <Step title="Fazer login">
    ```bash theme={"dark"}
    flatkey login
    ```
  </Step>

  <Step title="Comece a criar">
    Peça ao seu assistente de IA o que você deseja e deixe que ele execute a CLI:

    ```text theme={"dark"}
    Use Flatkey CLI to generate a "beautiful sunrise" picture.
    ```
  </Step>
</Steps>

<Card title="Flatkey CLI com agente de IA" icon="terminal" href="/pt/guides/flatkey-cli">
  Comandos, saída em JSON para agentes e recuperação de erros.
</Card>

## Codex & Claude Code

Conecte seu agente de codificação uma vez e depois use o Flatkey nos projetos que você já tem abertos.

<Frame>
  <img src="https://mintcdn.com/flatkey/9eYACi20Ep-B6T7F/images/quickstart/modal-agents.png?fit=max&auto=format&n=9eYACi20Ep-B6T7F&q=85&s=0fadd534691bdc978983917445268b6f" alt="O painel Codex e Claude Code, com o comando de instalação" width="1540" height="1064" data-path="images/quickstart/modal-agents.png" />
</Frame>

O Console fornece um único comando de instalação para **macOS**, **Linux** ou **Windows**. Ele instala o agente se você ainda não o tiver, pede sua chave e grava a configuração para você.

<Warning>
  O instalador é interativo. Ele pergunta se você quer usar o Claude Code ou o Codex CLI, e é necessário já ter o Node.js instalado.
</Warning>

<CardGroup cols={3}>
  <Card title="Claude Code" icon="terminal" href="/pt/guides/claude-code">
    Configuração manual ou CC Switch.
  </Card>

  <Card title="Codex CLI" icon="code" href="/pt/guides/codex-cli">
    Roteie o Codex CLI pelo Flatkey.
  </Card>

  <Card title="Codex Desktop" icon="desktop" href="/pt/guides/codex-desktop">
    Configure o aplicativo desktop.
  </Card>
</CardGroup>

## Verifique se funcionou

Qualquer que seja a opção escolhida, abra **Usage Logs** no [Console](https://console.flatkey.ai) depois da sua primeira requisição. Você deve vê-la listada com o modelo, contagem de tokens, latência e custo.

<img src="https://mintcdn.com/flatkey/ln614ti05NsEoN0h/images/quickstart/flatkey-usage-logs.png?fit=max&auto=format&n=ln614ti05NsEoN0h&q=85&s=90a23fb955d4a547c179087b73ab59df" alt="Use o filtro Model Name nos Flatkey Usage Logs" width="1600" height="840" data-path="images/quickstart/flatkey-usage-logs.png" />

Se nada aparecer, espere alguns segundos e pesquise novamente, depois confirme a chave de API e a URL base que a requisição realmente usou.

## Próximos passos

<CardGroup cols={2}>
  <Card title="Diretório de modelos" icon="list" href="https://flatkey.ai/models">
    Todos os modelos suportados com preços e disponibilidade em tempo real.
  </Card>

  <Card title="Erros da API" icon="triangle-exclamation" href="/pt/api-reference/errors">
    Códigos de status, formatos de resposta e o que fazer em cada caso.
  </Card>

  <Card title="Geração de texto" icon="message" href="/pt/guides/text-generation">
    Streaming, chamadas de ferramentas e saída estruturada.
  </Card>

  <Card title="Geração de vídeo" icon="video" href="/pt/guides/video-generation">
    Envie uma tarefa, consulte o status e baixe o MP4.
  </Card>
</CardGroup>
