Documentação da API & Início Rápido

URL Base e Autenticação

Use nossa URL base e uma única chave de API para conectar. O endpoint aceita cabeçalhos padrão. Substitua YOUR_API_KEY com a string do seu painel.

• URL Base: https://api.ollamaopenaicompatibleapi.com/v1
• ID do Modelo: uncensored

A autenticação depende de um token bearer. Passe-o no Authorization cabeçalho. Isso garante compatibilidade com qualquer cliente compatível com SDK do OpenAI. Você pode gerar uma nova chave instantaneamente via Google ou e-mail. Não é necessário número de telefone.

Endpoint Chat Completions

Envie uma requisição POST para /v1/chat/completions. Inclua seu array de mensagens e o nome do modelo. A API retorna texto com base no seu prompt. Isso funciona com qualquer provedor que use parâmetros padrão.

Defina a temperatura para criatividade ou mantenha-a baixa para precisão. Você também pode definir sequências de parada. O servidor processa a solicitação e retorna a conclusão. Esta é a interação principal para a maioria das integrações.

Lembre-se de que erros não consomem seu crédito pré-pago. Apenas as conclusões bem-sucedidas são cobradas. Isso protege seu orçamento durante as fases de depuração.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Respostas em Streaming via SSE

Ative o streaming definindo stream: true. O servidor envia chunks conforme são gerados. Isso reduz significativamente a latência percebida. Você recebe respostas parciais em tempo real.

Analise o fluxo Server-Sent Events. O último chunk contém as estatísticas de uso. Isso inclui contagens de tokens para entrada e saída. Você pode rastrear os custos dinamicamente durante a geração.

Esta abordagem funciona bem para interfaces de chat. Os usuários veem o texto aparecendo palavra por palavra. Parece mais responsivo do que esperar pela resposta completa. A API lida automaticamente com a estabilidade da conexão.

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)

Chamada de Função e Modo JSON

Defina ferramentas no corpo da solicitação. O modelo pode gerar dados estruturados. Use response_format com {"type": "json_object"} para JSON estrito. Isso garante uma saída analisável a cada vez.

As definições de ferramentas incluem nome, descrição e parâmetros. O modelo decide qual ferramenta chamar. Você executa a função e envia os resultados de volta. Isso permite fluxos de trabalho de agentes complexos.

O modo JSON desativa a geração de texto livre. Ele força o modelo a aderir ao seu esquema. Use isso ao integrar com bancos de dados ou APIs. Isso reduz alucinações em campos estruturados.

Copyfrom openai import OpenAI

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

Limites de Taxa e Corpos de Solicitação

Você tem direito a 300 requisições por minuto por chave. A concorrência é limitada a 8 requisições simultâneas. O tamanho máximo do corpo da requisição é de 8 MB. Isso é adequado para a maioria das aplicações baseadas em texto.

A janela de contexto permite 100.000 tokens no total. Isso inclui tanto o prompt quanto a conclusão. A saída máxima por solicitação é de 16.000 tokens. Se você omitir max_tokens, ele assume o padrão de 2.048.

Trate erros HTTP 429 gracefulmente. Eles indicam que você atingiu o limite de taxa. Implemente backoff exponencial no código do seu cliente. Isso evita sobrecarregar o servidor durante picos.

Copyimport OpenAI from "openai";

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

Erros e Limites de Autenticação

Um status 401 significa que sua chave é inválida. Verifique erros de digitação ou sessões expiradas. Um status 402 indica crédito insuficiente. Adicione fundos via cripto para retomar o serviço.

Um status 429 sinaliza limitação de taxa. Você excedeu 300 solicitações por minuto. Reduza sua taxa de transferência ou atualize sua chave. A API retorna mensagens de erro claras.

O crédito nunca expira. Você pode fazer recarga a qualquer momento. O valor mínimo de recarga é $20. Créditos bônus são aplicados para valores maiores. Isso mantém seu projeto funcionando sem problemas.