API Keys

Visão Geral

As API keys autenticam as requisições da sua aplicação ao gateway Floopy. Cada chave está vinculada à sua organização e pode ser configurada individualmente com rate limits e routing rules.

Todas as API keys seguem o formato flo_sk_live_ seguido de uma string aleatória, por exemplo:

flo_sk_live_xxxxxxxxxxxxxxxx

Criando uma API Key

1. Vá para Settings > API Keys no dashboard.
2. Clique em Create API key.
3. Dê à chave um nome descritivo (ex.: production-backend, staging-chatbot).
4. Configure rate limiting e routing rules (opcional — você pode atualizar depois).
5. Clique em Create.

A API key completa é exibida uma única vez. Copie-a e armazene-a com segurança — você não poderá visualizá-la novamente. Se você perder uma chave, revogue-a e crie uma nova.

Usando Sua API Key

Passe a chave como apiKey (ou no header Authorization: Bearer) nas suas requisições:

import { OpenAI } from "openai";

const client = new OpenAI({
  baseURL: "https://api.floopy.ai/v1",
  apiKey: process.env.FLOOPY_API_KEY,
});

const response = await client.chat.completions.create({
  model: "gpt-4o",
  messages: [{ role: "user", content: "Hello" }],
});

console.log(response.choices[0].message.content);

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://api.floopy.ai/v1",
    api_key=os.environ["FLOOPY_API_KEY"],
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello"}],
)

print(response.choices[0].message.content)

curl https://api.floopy.ai/v1/chat/completions \
  -H "Authorization: Bearer $FLOOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Armazene as chaves em variáveis de ambiente, nunca no código-fonte.

Rate Limiting

Cada API key pode ter seu próprio rate limit, expresso em requisições por minuto (RPM). Quando uma chave excede seu limite, o gateway retorna uma resposta 429 Too Many Requests.

Para configurar rate limits:

1. Vá para Settings > API Keys.
2. Clique na chave que deseja editar.
3. Defina o campo RPM limit.
4. Salve as alterações.

Se nenhum limite for definido, a chave usa o rate limit padrão do seu plano.

Você também pode substituir a política de rate limit por requisição usando o header floopy-ratelimit-policy:

const response = await client.chat.completions.create(
  {
    model: "gpt-4o",
    messages: [{ role: "user", content: "Hello" }],
  },
  {
    headers: {
      "floopy-ratelimit-policy": "strict",
    },
  },
);

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello"}],
    extra_headers={
        "floopy-ratelimit-policy": "strict",
    },
)

curl https://api.floopy.ai/v1/chat/completions \
  -H "Authorization: Bearer $FLOOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "floopy-ratelimit-policy: strict" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Atribuindo Routing Rules

Você pode associar uma routing rule a cada API key. Isso determina como o gateway roteia requisições feitas com essa chave — por exemplo, usando uma cadeia de fallback ou distribuição ponderada entre providers.

1. Vá para Settings > API Keys.
2. Clique na chave que deseja editar.
3. Selecione uma Routing rule no dropdown.
4. Salve as alterações.

Consulte o guia de Routing para detalhes sobre como criar routing rules.

Revogando uma Chave

Para revogar uma API key:

1. Vá para Settings > API Keys.
2. Encontre a chave e clique em Revoke.
3. Confirme a ação.

A revogação é imediata. Qualquer requisição usando a chave revogada receberá uma resposta 401 Unauthorized. Esta ação não pode ser desfeita — se precisar de acesso novamente, crie uma nova chave.

Boas Práticas

• Use chaves separadas para cada ambiente (produção, staging, desenvolvimento).
• Rotacione as chaves periodicamente criando uma nova chave, atualizando sua aplicação e depois revogando a antiga.
• Defina rate limits em todas as chaves para evitar custos descontrolados por bugs ou abuso.
• Nunca faça commit de chaves no controle de versão. Use variáveis de ambiente ou um gerenciador de segredos.