Dokumentasi API Ollama: Referensi Endpoint

URL Dasar dan Autentikasi

URL dasar untuk semua permintaan adalah https://api.ollamaapidocumentation.com/v1. Anda mengautentikasi menggunakan token bearer yang diteruskan di Authorization header. Kunci Anda dibuat di dasbor dan berfungsi segera.

• Gunakan SDK resmi OpenAI atau klien kompatibel lainnya.
• Atur URL dasar ke nilai di atas.
• Sertakan kunci API Anda di header.

Autentikasi ketat. Jika kunci hilang atau tidak valid, API mengembalikan error 401. Ini memastikan penggunaan Anda dilacak dengan akurat untuk penagihan.

Endpoint Chat Completions: POST /v1/chat/completions

Kirim pesan ke model melalui POST /v1/chat/completions. Endpoint menerima badan JSON dengan model field set to "uncensored" and a messages array.

Endpoint ini menangani generasi teks. Endpoint ini tidak mendukung gambar, audio, atau video. Anda dapat melakukan streaming respons atau menunggu hasil penuh.

Kesalahan seperti 402 menunjukkan kredit tidak cukup. Permintaan dibebankan berdasarkan penggunaan token aktual. Penolakan karena kredit bersifat gratis.

Daftar Model: GET /v1/models

Ambil model yang tersedia menggunakan GET /v1/models. Ini mengembalikan daftar objek model. ID model yang tersedia hanya "uncensored".

Endpoint ini membantu memverifikasi konektivitas. Endpoint ini mengonfirmasi bahwa URL dasar benar. Endpoint ini juga menampilkan nama model dan jenis objek.

Gunakan ini untuk memverifikasi masalah koneksi sebelum mengirim payload berat.

Parameter: Suhu, Top P, dan Seed

Kendalikan generasi dengan temperature, top_p, dan seed. The seed parameter memastikan output deterministik. Gunakan untuk debugging atau hasil yang konsisten.

Atur temperature antara 0 dan 2. Nilai yang lebih rendah membuat respons lebih dapat diprediksi. Nilai yang lebih tinggi meningkatkan keacakan. The top_p parameter menyaring token berdasarkan probabilitas kumulatif.

Parameter-parameter ini bekerja persis seperti API OpenAI. Anda dapat menggabungkannya untuk kontrol presisi atas gaya.

Respons Streaming dan Penggunaan Token

Aktifkan streaming dengan mengatur stream: true. API mengembalikan Server-Sent Events (SSE). Setiap potongan berisi teks parsial.

Bagian terakhir mencakup statistik penggunaan token. Ini memungkinkan Anda menghitung biaya secara akurat. Anda dapat memproses token saat tiba.

Streaming mengurangi latensi yang dirasakan. Sangat ideal untuk antarmuka obrolan. Server mendorong data hingga respons selesai.

Batas, Error, dan Jendela Konteks

Jendela konteks adalah 100.000 token. Ini mencakup input dan output. Anda dapat menghasilkan hingga 16.000 token per permintaan. Output maksimum default adalah 2.048 token.

Batas laju adalah 300 permintaan per menit. Anda dapat memiliki 8 permintaan simultan. Ukuran badan permintaan dibatasi hingga 8 MB.

Kesalahan mencakup 401 untuk kunci tidak valid dan 429 untuk batas laju. Kesalahan kredit mengembalikan 402. Kesalahan-kesalahan ini jelas dan dapat ditindaklanjuti.

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)