Guia de Início Rápido da API Ollama

Configuração da URL Base e Autenticação

Configure seu cliente para apontar para nosso endpoint hospedado. Defina o base_url para https://api.apiollama.com/v1 e forneça sua chave no Authorization Cabeçalho. A autenticação usa o padrão Bearer scheme. Você pode gerar uma chave via Google ou e-mail no painel. O sistema cria uma chave ativa por conta.

Copycurl https://api.apiollama.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list installed models"}]
  }'

Mantenha sua chave segura. Se você precisar de uma chave nova, gere uma no painel e a antiga se tornará inativa imediatamente. Nenhum número de telefone é necessário para a configuração. Esta configuração funciona com qualquer cliente compatível com OpenAI.

POST /v1/chat/completions: Enviando Solicitações

Envie sua primeira solicitação de conclusão de chat usando o endpoint padrão. Especifique o ID do modelo como uncensored no corpo da solicitação. A API aceita arrays de mensagens padrão contendo papéis de sistema, usuário e assistente. Isso funciona com qualquer SDK que suporte o formato OpenAI. Certifique-se de incluir o model field in every request.

Copyfrom openai import OpenAI

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

As solicitações são processadas através dos nossos servidores. O modelo responde com texto gerado com base no seu prompt. Você pode ajustar parâmetros como temperature ou top_p para controlar a aleatoriedade. O sistema retorna um objeto de resposta completo contendo o conteúdo gerado.

GET /v1/models: Listando Modelos Disponíveis

Consulte o endpoint de modelos para verificar as opções disponíveis. Envie uma solicitação GET para /v1/models para listar os modelos hospedados. A resposta inclui o id field set to uncensored. Esse endpoint confirma que sua chave de API tem permissões válidas. Ele retorna metadados sobre a configuração do modelo.

Copyimport OpenAI from "openai";

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

Use esta chamada para depurar problemas de conexão. Se o endpoint retornar um erro, verifique seu cabeçalho de autenticação. O endpoint fornece uma lista simples de modelos disponíveis. Você pode verificar o status do serviço sem enviar uma solicitação de chat completa.

Respostas em Streaming com Server-Sent Events

Habilite o streaming definindo o stream parâmetro para true. A API retorna Server-Sent Events (SSE) para entrega de tokens em tempo real. Cada chunk contém atualizações de conteúdo parcial. O último chunk inclui as estatísticas completas de uso de tokens. Isso reduz a latência percebida para respostas longas.

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)

Lide com o stream SSE no código do seu cliente. Processe cada evento conforme ele chega. O último evento contém o usage objeto com contagens de tokens de entrada e saída. O streaming funciona com todos os parâmetros suportados. Ele fornece feedback imediato para aplicativos interativos.

Parâmetros de Configuração: Temperatura, Top-p e Mais

Ajuste o comportamento de geração usando parâmetros padrão. Defina temperature para aleatoriedade e top_p para amostragem por núcleo. Use stop sequências para interromper a geração antecipadamente. A seed parâmetro garante resultados reproduzíveis. Você também pode definir o presence_penalty e frequency_penalty para controle de estilo.

O modo JSON está disponível via response_format. Defina isso como json_object para saídas estruturadas. O modelo adere ao formato especificado. Esses parâmetros se aplicam a todas as solicitações. Use-os para ajustar o estilo da resposta.

Tratamento de Erros e Relatórios de Uso de Tokens

Lide com erros HTTP comuns no seu aplicativo. Um status 401 indica uma chave de API inválida. Um status 402 significa que seu crédito pré-pago está esgotado. Um status 429 sinaliza que você excedeu o limite de taxa. Verifique o corpo da resposta para mensagens de erro detalhadas. Recusas devido à política de conteúdo são gratuitas.

A janela de contexto suporta 100.000 tokens no total. A saída é limitada a 16.000 tokens por solicitação. A saída padrão é de 2.048 tokens se max_tokens está indefinido. O uso de tokens é relatado no último chunk do stream. Erros não consomem crédito.