Documentação da API do Endpoint Ollama
Comece a construir com a API de LLM sem censura em segundos. Este guia cobre a URL base, autenticação e integração de SDK para seus fluxos de trabalho de API compatíveis com OpenAI.
URL Base e Autenticação
Use o URL base fornecido e uma chave de API para cada solicitação. O endpoint é https://api.ollamaendpoint.com/v1Autorização cabeçalho como um token Bearer. Você gera esta chave imediatamente após fazer login com Google ou e-mail. A chave é única por conta e substitui qualquer chave ativa anterior.
Primeira solicitação
Envie uma conclusão de chat padrão para gerar texto. O ID do modelo é uncensored e aceita os mesmos parâmetros que os clientes padrão da OpenAI. Isso funciona para tarefas LLM NSFW ou geração de conteúdo sem restrições.
- Método: POST
- Endpoint:
/v1/chat/completions - Modelo:
uncensored
curl https://api.ollamaendpoint.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Get the local ip address of this machine"}]
}'
Uma resposta bem-sucedida retorna o texto gerado no array choices. Verifique o usage campo para ver a contagem de tokens.
Integração do SDK Python
Instale a biblioteca oficial da OpenAI e configure a URL base. Isso permite que você use o modelo ollama sem censura com código Python familiar. Defina o base_url e api_key antes de inicializar o cliente. O código permanece compatível com os SDKs existentes do OpenAI.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaendpoint.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)
Chame o chat.completions.create método exatamente como você faria para o GPT. A estrutura da resposta corresponde às expectativas padrão. Você pode transmitir ou obter respostas completas.
Integração do SDK Node
Use o pacote OpenAI Node.js para interagir com a API. Configure o cliente com a URL base personalizada e sua chave de API. Esta abordagem funciona para aplicações lado do servidor ou funções de borda. O pacote lida com serialização e novas tentativas automaticamente.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaendpoint.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);
Chame o endpoint de conclusão com seu prompt. A biblioteca retorna uma promessa que é resolvida para o objeto de resposta. Lidar com erros de acordo com os códigos de status HTTP padrão.
Respostas em Streaming com SSE
Ative o streaming definindo stream: true na sua solicitação. O servidor retorna um stream de Server-Sent Events (SSE). Cada bloco contém texto parcial e dados de uso de tokens. O último bloco inclui as estatísticas de uso completas para faturamento. Isso reduz a latência percebida para saídas longas.
stream = 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)
Acumule as partes de conteúdo de cada chunk para reconstruir a resposta completa. Processe erros conforme chegam no stream. O último chunk confirma a contagem de tokens para seu crédito pré-pago.
Limites de Taxa e Restrições
Cada chave de API suporta 300 solicitações por minuto e 8 solicitações simultâneas. O tamanho máximo do corpo da solicitação é de 8 MB. A janela de contexto é de 100.000 tokens para prompt e conclusão combinados. Os limites de saída são de 16.000 tokens por solicitação. Erros e recusas não consomem crédito. Um erro 401 significa que sua chave é inválida. Um erro 402 indica crédito pré-pago insuficiente. Um erro 429 significa que você atingiu o limite de taxa. Ajuste sua concorrência para permanecer dentro dos limites.
FAQ
Qual é a URL base para o endpoint ollama?
A URL base é HTTPS://api.ollamaendpoint.com/v1. Use isso para todas as chamadas de API. É compatível com clientes padrão do OpenAI.
Como lidar com respostas de streaming?
Defina o parâmetro stream como true. A API retorna Server-Sent Events. Processe cada chunk para construir o texto final. O último chunk inclui os dados de uso.
O que acontece se eu atingir um limite de taxa?
Você recebe o código de status 429. O limite é de 300 solicitações por minuto por chave. Reduza sua concorrência ou aguarde antes de tentar novamente. Solicitações simultâneas são limitadas a 8.
Obtenha sua chave de API
Faça o cadastro, pegue a chave e aponte para a nova URL base. Pronto.