Docs da API Ollama: Guia de Início Rápido
Este guia fornece os detalhes concretos da nossa API compatível com OpenAI, permitindo que você substitua nosso modelo sem censura sem alterar o código do seu cliente existente.
URL Base e Autenticação
A URL base é HTTPS://api.ollamaapidocs.com/v1. Passe sua chave no cabeçalho Authorization padrão.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'Endpoint Chat Completions
Envie solicitações POST para /v1/chat/completions com o modelo definido como uncensored.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.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)Suporte a Streaming e Ferramentas
Ative o streaming definindo stream como true. A API retorna tokens por meio de Eventos Enviados pelo Servidor e suporta chamada de função.
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)Modo JSON e Parâmetros
Use response_format json_object para saída JSON estrita. Você também pode ajustar temperatura, top_p e sequências de parada.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaapidocs.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);Limites de Taxa e Restrições
O limite é de 300 solicitações por minuto por chave. Cada solicitação suporta uma janela de contexto de 100.000 tokens.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'Erros e Janela de Contexto
Trate erros 401 para chaves inválidas, 402 para falta de crédito e 429 para limites de taxa. O modelo suporta uma janela de contexto de 100,000 tokens.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.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)Perguntas frequentes
Qual é a documentação da API ollama para este serviço?
Este guia cobre a URL base, autenticação e endpoints da nossa API hospedada. Ele permite que você use SDKs padrão da OpenAI com nosso modelo sem censura.
Como lidar com respostas de streaming?
Defina o parâmetro stream como true na sua solicitação. A API retorna tokens via Server-Sent Events, permitindo processamento em tempo real.
O que acontece se eu exceder o limite de taxa?
Você receberá um código de status 429. O limite é de 300 solicitações por minuto por chave, com um máximo de 8 solicitações simultâneas.
Gere sua chave de API
Faça o cadastro, copie sua chave e atualize a URL base. É só isso que você precisa para começar.
