How do I get started with the ollama API doc?

Create an account and generate an API key. Use the base URL provided in the dashboard. Send your first POST request to the chat completions endpoint. The process takes less than two minutes.

What happens if I hit the rate limit?

You receive a 429 Too Many Requests error. The limit is 300 requests per minute per key. You can switch to a new key if needed. Wait a minute and retry. Streaming responses count towards the limit.

Can I use this with OpenAI SDKs?

Yes. The API is fully OpenAI-compatible. Set the base URL to our endpoint. Pass your API key. The code works exactly like standard OpenAI integration. This allows easy switching between providers.

API-dokumentaatio - OpenAI-yhteensopivat päätepisteet

Perus-URL ja todennus

API sijaitsee osoitteessa https://api.ollamaapidoc.com/v1. Autentikoit käyttämällä Bearer-tokenia Authorization header. Luo avain välittömästi Google- tai sähköpostitilin kautta hallintapaneelissa. Puhelinnumeroa ei tarvita. Avain toimii vakiomuotoisten OpenAI-SDK:iden kanssa asettamalla perus-URL:n.

Ensimmäinen pyyntösi

Lähetä POST-pyyntö osoitteeseen /v1/chat/completions mallin tunnisteella uncensored. Tämä päätepiste käsittelee tekstiä sisään ja tekstiä ulos. Se tukee streamausta, JSON-tilaa ja funktiokutsuja. Voit testaa yhteyksiä ilman krediittien kulutusta tarkistamalla mallit-päätepisteen ensin.

curl 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"}]
  }'

Vastaus palauttaa standardin OpenAI-muotoilun. Virheet palauttavat asianmukaiset HTTP-koodit. Tarkista runko error tiedot, jos jokin epäonnistuu. Streamausvastaukset käyttävät Server-Sent Events -tekniikkaa.

Python SDK -integraatio

Asenna virallinen OpenAI-kirjasto. Määritä asiakas base URL -osoitteellasi ja API-avaimellasi. Kutsu chat-completions-päätepistettä. Koodi pysyy identtisenä vakiintuneen OpenAI-käytön kanssa. Tämä varmistaa helpon siirtymisen olemassa oleviin projekteihin. Voit säätää parametreja kuten lämpötilaa ja top_p:ta suoraan kutsussa.

from 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)

Käsittele poikkeukset nopeusrajoituksille tai virallisille avaimille. Kirjasto streamaa tokenit, jos asetat stream arvoon true. Tämä lähestymistapa pitää koodikantaasi siistinä ja yhteensopivana.

Node.js SDK:n määritys

Käytä openai npm-paketti. Alusta asiakas mukautetulla perus-URL:llä. Anna API-avaimesi. Syntaksi vastaa Python-esimerkkiä. Tämä johdonmukaisuus vähentää virheenkorjausaikaa. Voit lähettää useita viestejä keskusteluhistoria-taulukkoon.

import 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);

Jäsennä vastaus huolellisesti. API palauttaa rakenteisen JSON-vastauksen. Virheenkäsittely on kriittistä tuotantosovelluksille. Tartu verkkovirheisiin ja API-kohtaisiin virheisiin erikseen. Tämä varmistaa, että sovelluksesi pysyy reaktiivisena ruuhkan aikana.

Streamaus ja JSON-tila

Ota virtauskäyttöön asettamalla stream parametri arvoon true. API lähettää tokenit Server-Sent Events -muodossa. Saat osittaisia vastauksia reaaliajassa. Tämä parantaa käyttäjäkokemusta pitkissä tulosteissa. Voit myös pakottaa JSON-tuloksen käyttämällä response_format. Tämä on hyödyllistä rakenteellisen datan erottelussa.

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)

Function calling toimii samalla tavalla. Määrittele työkalut pyynnössäsi. Malli palauttaa työkalukutsut. Jäsentele nämä kutsut koodissasi. Suorita ne ja syötä tulokset takaisin mallille. Tämä silmukka mahdollistaa monimutkaisten työvuokojen luonnin.

Rajoitukset, virheet ja konteksti

Kontekstiikkoni on 100 000 tokenia. Tulostuksen maksimimäärä on 16 000 tokenia pyyntöä kohden. Virheet sisältävät 401 virheellisten avainten ja 402 riittämättömän krediitin osalta. Nopeusrajoitukset ovat 300 pyyntöä minuutissa. Käsittele nämä sujuvasti sovelluksessasi. API ei koskaan käytä promptejasi koulutukseen. Yksityisyys on ylläpidetty. Krediitit eivät vanhene.

API Dokumentointi