Dokumentace API

Ověření & hlavičky

Váš glm api key autorizuje každý požadavek. Předávejte ho v Authorization hlavička jako Bearer token. Toto je standardní metoda používaná oficiálními SDK OpenAI a funguje s jakýmikoli klienty, které podporují autentizaci kompatibilní s OpenAI. Tento klíč obdržíte ihned po registraci přes Google nebo e-mail na ovládacím panelu.

Chraňte svůj klíč bezpečně. Poskytuje plný přístup k vašemu předplacenému kreditu. Pokud jej ztratíte, vygenerujte nový; starý klíč se okamžitě stane neplatným. V daném okamžiku můžete mít v rámci jednoho účtu aktivní pouze jeden klíč.

Endpoint Chat Completions

Odesílejte textové zprávy modelu pomocí POST /v1/chat/completions endpoint. Základní URL pro všechny požadavky je https://api.apiglm.com/v1. Musíte specifikovat ID modelu jako uncensored v těle požadavku. Tento endpoint zpracovává standardní konverzační přenosy a vrací vygenerovaný text.

Každý požadavek spotřebovává tokeny z vašeho předplaceného zůstatku. Chyby a odmítnutí nezpoplatní váš kredit. Model přijímá posloupnost zpráv, což umožňuje víceotáčkové konverzace v rámci kontextového okna.

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

Koncový bod Modely

Ověřte dostupné modely a konfiguraci endpointu voláním GET /v1/models. Tento endpoint vrací seznam modelů aktuálně podporovaných API. Můžete jej použít k ověření připojení a zkontrolování ID modelu před odesláním požadavků na dokončení. Je užitečný při ladění konfigurace klienta.

Odpověď zahrnuje metadata o modelu, jako je jeho ID a pole owned_by. Tento koncový bod nespotřebovává kredit. Použijte jej k zajištění, že váš klient ukazuje na správnou základní URL a že je váš autentizační hlavička platná.

Streamování & SSE

Povolte výstup tokenů v reálném čatu nastavením stream: true ve vaší žádosti. API vrací stream Server-Sent Events (SSE). Každý blok obsahuje částečné textové delta. Poslední blok zahrnuje kompletní statistiky využití tokenů pro žádost.

Streaming snižuje vnímanou latenci pro uživatele. Umožňuje vaší aplikaci zobrazovat tokeny, jak jsou generovány. To je ideální pro chatová rozhraní, kde se očekává okamžitá zpětná vazba. Stream zpracujte správně, aby byly zpracovány všechny tokeny.

Copyfrom openai import OpenAI

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

Volání funkcí

Definujte nástroje v těle žádosti pro povolení volání funkcí. Model může vrátit strukturovaný JSON s identifikací funkce, kterou má zavolat, a jejími argumenty. To umožňuje vaší aplikaci vykonávat kód na základě záměru uživatele. Podpora zahrnuje definice nástrojů, volby nástrojů a režim JSON pro přísné formátování výstupu.

Použijte tuto funkci k integraci LLM do vašeho pracovního postupu. Definujte schéma funkce v těle požadavku. Model odpoví seznamem volání nástrojů. Tyto volání parsovejte ve svém kódu pro spuštění externích akcí. To umožňuje komplexní úkoly v několika krocích.

Copyimport OpenAI from "openai";

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

Parametry & Limity

Okno kontextu podporuje 100 000 tokenů pro kombinaci promptu a completion. Maximální výstup je 16 000 tokenů na požadavek. Nastavte max_tokens ovlivnit délku výstupu. Výchozí hodnota je 2,048 tokenů, pokud není zadáno. Můžete upravit teplotu, top_p a seed pro variabilitu.

Omezení rychlosti umožňují 300 požadavků za minutu na klíč. Souběžné požadavky jsou omezeny na 8 na klíč. Těla požadavků musí být menší než 8 MB. Chyby vracejí standardní kódy stavu HTTP. 401 označuje neplatný klíč. 402 znamená, že je váš kredit vyčerpán. 429 signalizuje překročení limitu rychlosti.

Streamování

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)