API Documentação

URL Base e Autenticação

A API vive em https://api.ollamaapidoc.com/v1. Você autentica usando um token Bearer no Authorization Cabeçalho. Gere sua chave instantaneamente via Google ou e-mail no painel. Não é necessário número de telefone. A chave funciona com SDKs padrão do OpenAI definindo a URL base.

Sua Primeira Solicitação

Envie uma requisição POST para /v1/chat/completions com o ID do modelo uncensored. Esse endpoint lida com entrada e saída de texto. Suporta streaming, modo JSON e chamada de funções. Você pode testar a conectividade sem gastar crédito verificando primeiro o endpoint de modelos.

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

A resposta retorna o formato padrão da OpenAI. Erros retornam códigos HTTP apropriados. Verifique o corpo para error detalhes caso algo falhe. Respostas em streaming usam Server-Sent Events.

Integração do SDK Python

Instale a biblioteca oficial da OpenAI. Configure o cliente com sua URL base e chave de API. Chame o endpoint de conclusões de chat. O código permanece idêntico ao uso padrão da OpenAI. Isso garante uma migração fácil para projetos existentes. Você pode ajustar parâmetros como temperatura e top_p diretamente na chamada.

Copyfrom openai import OpenAI

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

Trate exceções para limites de taxa ou chaves inválidas. A biblioteca transmite tokens se você definir stream como true. Essa abordagem mantém sua base de código limpa e compatível.

Configuração do SDK Node.js

Use o openai pacote npm. Inicialize o cliente com a URL base personalizada. Passe sua chave de API. A sintaxe espelha o exemplo Python. Essa consistência reduz o tempo de depuração. Você pode enviar várias mensagens em um array de histórico de conversas.

Copyimport OpenAI from "openai";

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

Analise a resposta com cuidado. A API retorna JSON estruturado. O tratamento de erros é crucial para aplicativos de produção. Capture erros de rede e erros específicos da API separadamente. Isso garante que seu aplicativo permaneça responsivo durante picos de tráfego.

Streaming e Modo JSON

Habilite o streaming definindo o stream parâmetro para true. A API envia tokens via Server-Sent Events. Você recebe respostas parciais em tempo real. Isso melhora a experiência do usuário para saídas longas. Você também pode impor saída JSON usando response_format. Isso é útil para extração de dados estruturados.

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)

A chamada de função funciona de forma semelhante. Defina ferramentas na sua solicitação. O modelo retorna chamadas de ferramenta. Analise essas chamadas no seu código. Execute-as e alimente os resultados de volta ao modelo. Esse loop permite fluxos de trabalho complexos.

Limites, Erros e Contexto

A janela de contexto é de 100.000 tokens. A saída máxima é de 16.000 tokens por solicitação. Os erros incluem 401 para chaves inválidas e 402 para crédito insuficiente. Os limites de taxa são de 300 solicitações por minuto. Lidere com esses casos de forma graciosa em seu aplicativo. A API nunca usa seus prompts para treinamento. A privacidade é mantida. O crédito não expira.