Início Rápido: Integre a API de Namorada de IA

URL Base e Autenticação

Nossa API segue o padrão chat-completions da OpenAI, tornando a integração direta para clientes existentes. Você deve incluir sua chave de API no cabeçalho Authorization de cada requisição. A URL base para todos os endpoints é https://api.roleplayapi.com/v1. Ao usar SDKs oficiais, atualize a configuração base_url para apontar para este endereço e forneça sua chave como api_key. Esta configuração garante que suas requisições alcancem nosso endpoint sem censura dedicado sem modificação na sua lógica padrão.

Enviar uma Conclusão

Inicie uma conversa enviando uma requisição POST para /v1/chat/completions. O identificador do modelo é uncensored. Você pode passar qualquer número de mensagens no array messages para estabelecer contexto ou iniciar um diálogo novo. A resposta contém a saída de texto do modelo, que você pode streamar ou analisar como um objeto JSON. Este endpoint lida com a interação central de entrada de texto e saída de texto necessária para aplicativos baseados em personagens.

Copycurl https://api.roleplayapi.com/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."}]
  }'

Integração com SDK Python

Use a biblioteca Python oficial openai para interagir com a API com o mínimo de código boilerplate. Configure o cliente com nossa URL base e sua chave de API. Em seguida, chame chat.completions.create com o ID do modelo uncensored. Esta abordagem aproveita as dicas de tipo existentes e mecanismos de tratamento de erros, permitindo que você se concentre na lógica do seu aplicativo em vez de análise de HTTP. O objeto de resposta fornece acesso direto ao conteúdo gerado.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.roleplayapi.com/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)

Integração com SDK Node.js

Para projetos JavaScript e TypeScript, o SDK Node da OpenAI oferece uma interface limpa para chamadas de API. Inicialize o cliente com a URL base personalizada e sua chave secreta. Chame o endpoint de conclusões de chat usando o modelo uncensored. Este método é ideal para servidores web ou funções de borda onde você precisa gerenciar requisições assíncronas de forma eficiente. O SDK cuida da serialização e desserialização do payload JSON automaticamente.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.roleplayapi.com/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);

Habilitar Streaming

Reduza a latência percebida habilitando eventos enviados pelo servidor (SSE). Defina o parâmetro stream como true em sua requisição. A API retornará um fluxo de chunks em vez de uma resposta completa única. Isso é particularmente útil para interfaces de chat onde os usuários esperam respostas imediatas de personagens. Você pode processar cada chunk conforme ele chega, atualizando a interface do usuário incrementalmente. O fluxo termina quando o modelo termina de gerar a sequência de tokens.

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)

Limites, Erros e Contexto

Suas requisições estão sujeitas a um limite de requisições de 300 requisições por minuto por chave. Se você exceder isso, a API retornará um código de status 429. Falhas de autenticação resultam em um erro 401, enquanto crédito pré-pago insuficiente aciona um erro 402. A janela de contexto suporta até 100.000 tokens para o prompt e a conclusão combinados. Se você precisar verificar os modelos disponíveis, envie uma requisição GET para /v1/models. Certifique-se de que o corpo da sua requisição não exceda 8 MB.