Documentação da API Ollama: Referência de Endpoints

URL Base e Autenticação

A URL base para todas as solicitações é https://api.ollamaapidocumentation.com/v1. Você autentica usando um token bearer passado no Authorization cabeçalho. Sua chave é gerada no painel e funciona imediatamente.

• Use os SDKs oficiais da OpenAI ou qualquer cliente compatível.
• Defina a URL base para o valor acima.
• Inclua sua chave de API no cabeçalho.

A autenticação é rigorosa. Se a chave estiver ausente ou for inválida, a API retorna um erro 401. Isso garante que seu uso seja rastreado com precisão para faturamento.

Endpoint Chat Completions: POST /v1/chat/completions

Envie mensagens para o modelo via POST /v1/chat/completions. O endpoint aceita um corpo JSON com um model field set to "uncensored" and a messages array.

Este endpoint lida com geração de texto. Não suporta imagens, áudio ou vídeo. Você pode transmitir respostas ou aguardar o resultado completo.

Erros como 402 indicam crédito insuficiente. As solicitações são cobradas pelo uso real de tokens. Recusas devido a crédito são gratuitas.

Listagem de Modelos: GET /v1/models

Recupere modelos disponíveis usando GET /v1/models. Isso retorna uma lista de objetos de modelo. O único ID de modelo disponível é "uncensored".

Este endpoint ajuda a verificar a conectividade. Confirma se a URL base está correta. Ele também mostra o nome do modelo e o tipo de objeto.

Use isto para depurar problemas de conexão antes de enviar cargas pesadas.

Parâmetros: Temperatura, Top P e Seed

Controle a geração com temperature, top_p, e seed. O seed parameter garante saídas determinísticas. Use-o para depuração ou resultados consistentes.

Definir temperature entre 0 e 2. Valores mais baixos tornam as respostas mais previsíveis. Valores mais altos aumentam a aleatoriedade. O top_p parâmetro filtra tokens por probabilidade cumulativa.

Esses parâmetros funcionam exatamente como a API da OpenAI. Você pode combiná-los para controle preciso do estilo.

Respostas em Streaming e Uso de Tokens

Ative o streaming definindo stream: true. A API retorna Server-Sent Events (SSE). Cada fragmento contém texto parcial.

O último chunk inclui as estatísticas de uso de tokens. Isso permite que você calcule os custos com precisão. Você pode processar os tokens conforme chegam.

O streaming reduz a latência percebida. É ideal para interfaces de chat. O servidor envia dados até que a resposta esteja completa.

Limites, Erros e Janela de Contexto

A janela de contexto é de 100.000 tokens. Isso inclui tokens de entrada e saída. Você pode gerar até 16.000 tokens por solicitação. A saída máxima padrão é de 2.048 tokens.

Os limites de taxa são de 300 solicitações por minuto. Você pode ter 8 solicitações simultâneas. O tamanho do corpo da solicitação é limitado a 8 MB.

Erros incluem 401 para chaves inválidas e 429 para limites de taxa. Erros de crédito retornam 402. Esses erros são claros e acionáveis.

cURL

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

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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)