Referência da API

URL base

Cada requisição vai para:

Autenticação

Crie uma chave na página chaves de API e envie-a como token bearer no cabeçalho Authorization. Apenas um hash da sua chave é armazenado — copie-a ao criá-la, pois o GatifyAI não poderá mostrá-la novamente.

Início rápido

Uma requisição mínima em curl, Python ou TypeScript:

curl https://gatifyai.com/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

Restringir uma chave a modelos específicos

Por padrão, uma nova chave pode usar qualquer modelo gratuito do GatifyAI, com o mesmo fallback automático que o chat web usa caso um esteja indisponível. Você pode, em vez disso, restringir uma chave a um modelo específico ou a uma lista curta — a chave então só usará modelos dessa lista, na ordem que você definiu, independentemente do modelo que uma requisição solicitar. Solicitar um modelo fora dessa lista retorna um erro 400 nomeando os modelos que a chave realmente pode usar.

Conversando como uma persona

Envie model: "persona/<slug>" para conversar como uma persona publicada na galeria da comunidade — sua personalidade e modelos preferidos são usados automaticamente, ainda restritos pelos modelos permitidos da sua chave, se você tiver definido algum. Encontre o slug de uma persona e um exemplo pronto na página dela, na aba API.

{
  "model": "persona/senior-engineer",
  "messages": [{"role": "user", "content": "Review my code."}]
}

Streaming vs. não streaming

Defina stream: true para receber tokens à medida que são gerados, exatamente como o formato de streaming da OpenAI (Server-Sent Events, terminado por [DONE]). Omita, ou defina como false, para esperar a resposta completa e receber uma única resposta JSON — este é o padrão.

Erros

Os erros seguem o formato de erro da OpenAI: {"error": {"message": "...", "type": "..."}}. Um 401 significa uma chave ausente, inválida ou revogada. Um 400 significa que a própria requisição é inválida — geralmente um modelo não reconhecido, um slug de persona não publicado/desconhecido, ou um modelo fora da lista permitida da sua chave. Um 502 significa que nenhum modelo candidato respondeu.

{
  "error": {
    "message": "This API key may only use: llama-3.1-8b:free",
    "type": "invalid_request_error"
  }
}

Limites de taxa

As requisições da API contam para o mesmo limite de taxa de chat por conta que o aplicativo web — hoje não há uma cota separada para o tráfego da API.