Início rápido para usuários do Grok NSFW

Autenticação e URL Base

Nossa API implementa o protocolo compatível com openai. Você se autentica passando sua chave de API exclusiva no cabeçalho Authorization. A URL base para todas as requisições é https://api.groknsfw.cc/v1. Diferente dos provedores padrão, não exigimos um ID de organização específico. Basta gerar sua chave pelo painel ou na página de cadastro rápido. Mantenha sua chave segura; ela fornece acesso total ao seu crédito pré-pago. Não há taxas mensais nem assinaturas, apenas precificação por token sem expiração.

Toda requisição deve incluir o identificador do modelo uncensored. Este modelo é um LLM de pesos abertos hospedado em nossa infraestrutura, distinto de outros fornecedores. Ele é ajustado para fornecer respostas sem restrições para conteúdo adulto lícito, mantendo alta precisão factual. Você não precisa alterar a versão da biblioteca do cliente; SDKs padrão do OpenAI funcionam imediatamente.

Chat Completion Básico

Envie uma requisição padrão de conclusão de chat para gerar texto. O endpoint aceita uma lista de mensagens, incluindo papéis de sistema, usuário e assistente. Essa estrutura permite definir contexto, instruções e histórico de conversas. O modelo retorna uma resposta de texto com base no prompt fornecido. Você pode controlar a criatividade da saída usando parâmetros como temperature e top_p. Se nenhum max_tokens for especificado, o limite padrão de saída é de 2.048 tokens. Você pode aumentar isso para até 32.000 tokens por requisição, dentro da janela de contexto total de 100.000 tokens.

Erros são retornados em formato JSON padrão. Problemas comuns incluem chaves inválidas ou crédito insuficiente. A API não realiza tokenização para você; você envia texto e o modelo o processa internamente. Você recebe o texto final gerado ou fluxos parciais se habilitados.

Respostas em Streaming

Chamada de Funções e Ferramentas

A API suporta chamada de funções, permitindo que o modelo gere dados estruturados em vez de texto livre. Defina suas ferramentas no parâmetro tools, especificando o nome da função, descrição e esquema de parâmetros. Quando o modelo determina que uma chamada de ferramenta é necessária, ele retorna o nome da função e os argumentos em formato JSON. Seu aplicativo executa então a função e alimenta o resultado de volta na conversa. Isso permite fluxos de trabalho complexos, extração de dados e ações automatizadas. Defina tool_choice para controlar se o modelo deve usar uma ferramenta ou pode escolher livremente.

Modo JSON

Para aplicativos que exigem formatos de saída rigorosos, use o modo JSON. Defina o parâmetro response_format como {"type": "json_object"}. O modelo restringirá sua saída para JSON válido. Isso é ideal para analisar dados em seus sistemas de back-end ou gerar configurações estruturadas. Observe que o modo JSON pode reduzir ligeiramente a flexibilidade de raciocínio do modelo em comparação com texto livre. Certifique-se de que seu prompt instrua claramente o modelo a gerar apenas JSON. Este recurso funciona junto com a chamada de funções, mas fornece uma interface mais simples quando você precisa apenas de dados estruturados sem definições de ferramentas.

Uso de Tokens e Limites

Sua conta está limitada a 300 requisições por minuto e 8 requisições simultâneas por chave. O tamanho máximo do corpo da requisição é de 8 MB. Se você exceder esses limites, a API retornará o código de status 429. Erros de autenticação retornam 401 e crédito insuficiente retorna 402. O preço é $0,25 por milhão de tokens de entrada e $1,00 por milhão de tokens de saída. Erros e recusas não consomem crédito. A janela de contexto é de 100.000 tokens no total, incluindo prompt e conclusão. Gerencie o uso de tokens com cuidado para evitar custos inesperados. O crédito nunca expira e você pode recarregar a qualquer momento usando criptomoeda.

cURL

Copycurl https://api.groknsfw.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.groknsfw.cc/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.groknsfw.cc/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

Streaming

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)