Referensi API

Base URL

Saben request tumuju menyang:

Otentikasi

Gawe kunci ing kaca Kunci API, banjur kirimake minangka bearer token ing header Authorization. Mung hash saka kuncimu sing disimpen — salinen pas digawe, amarga GatifyAI ora bisa nampilake maneh.

Miwiti cepet

Conto request minimal nganggo curl, Python, utawa TypeScript:

curl https://gatifyai.com/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

Ngwatesi kunci menyang model tartamtu

Miturut standar, kunci anyar bisa nganggo model gratis GatifyAI apa wae, kanthi fallover otomatis kaya sing dienggo web chat yen ana model sing ora kasedhiya. Sampeyan bisa ngwatesi kunci menyang model tartamtu utawa dhaftar cendhak — kunci mau banjur mung bakal nganggo model saka dhaftar kasebut, miturut urutan sing sampeyan wenehi, tanpa mikirake model apa sing dijaluk request. Njaluk model ing njaba dhaftar kasebut bakal ngasilake error 400 sing nyebutake model-model sing pancen diijini kunci kasebut.

Ngobrol minangka persona

Kirimake model: "persona/<slug>" kanggo ngobrol minangka persona sing dirilis ing galeri komunitas — kapribadene lan model sing disenengi digunakake otomatis, tetep diwatesi model sing diijini kuncimu yen sampeyan wis nyetel. Golekana slug persona lan conto sing wis siap ing kacane dhewe, ing tab API.

{
  "model": "persona/senior-engineer",
  "messages": [{"role": "user", "content": "Review my code."}]
}

Streaming vs. non-streaming

Setel stream: true kanggo nampa token pas digawe, persis kaya format streaming OpenAI (Server-Sent Events, dipungkasi karo [DONE]). Ilangi, utawa setel dadi false, kanggo ngenteni wangsulan lengkap lan nampa siji respons JSON — iki standar.

Error

Error ngetutake wangun error OpenAI: {"error": {"message": "...", "type": "..."}}. 401 tegese kunci ilang, ora sah, utawa dicabut. 400 tegese requeste dhewe ora sah — biasane model sing ora dikenali, slug persona sing durung dirilis/ora dikenal, utawa model ing njaba dhaftar sing diijini kuncimu. 502 tegese kabeh model calon gagal nanggapi.

{
  "error": {
    "message": "This API key may only use: llama-3.1-8b:free",
    "type": "invalid_request_error"
  }
}

Watesan rate

Request API diitung ing rate limit chat per-akun sing padha karo aplikasi web — durung ana kuota kapisah kanggo lalu lintas API saiki.