Burimet · Chat API

Dokumentacioni i Chat API-së

Referencë e nivelit enterprise për /chat/completions që përfshin skemën e kërkesës, ngjarjet e transmetimit, sjelljen gjatë ekzekutimit, dhe semantikën e gabimeve.

Pikat e Përfundimit

GET /api/v1/chat/health
POST /api/v1/chat/completions

Header-et e kërkuara

Authorization: Bearer [token] ose autentikim me çelësin e API-sëContent-Type: application/jsonX-Scope-Type: personal | workspaceX-Workspace-ID: i nevojshëm vetëm kur scope është workspace

Përmbajtja e Kërkesës

json
{
  "message": "Summarize the last meeting in bullet points",
  "session_id": "sess_123",
  "stream": true,
  "attachments": [],
  "metadata": {
    "locale": "en",
    "channel": "web"
  }
}

Përmbajtja e Përgjigjes

json
{
  "success": true,
  "session_id": "sess_123",
  "content": "• Discussed roadmap\n• Confirmed release scope\n• Assigned owners",
  "provider": "pulse",
  "usage": {
    "input_tokens": 324,
    "output_tokens": 118
  },
  "metadata": {
    "latency_ms": 612
  }
}

Ngjarjet e transmetimit

  • response.started — ekzekutimi i bisedës u nis
  • response.delta — tokene teksti inkrementale
  • response.tool_call — ngjarje thirrjeje e mjetit (nëse ka)
  • response.usage — përditësim i përdorimit/tokeneve
  • response.completed — përgjigja përfundimtare e ndërtuar

Sjelljet gjatë ekzekutimit

  • Kontrolli i backpressure refuzon mbingarkesën me 503.
  • Bllokimi i shpërndarë parandalon përpunimin e dyfishtë gjatë ekzekutimit.
  • Cache-i i deduplifikimit shërben kërkesat e përsëritura jo-transmetuese.
  • Persistenca e sesionit ruan shkëmbimet e përdoruesit dhe asistentit.
  • Validimi mbron përmbajtjen e kërkesës, bashkëngjitjet dhe kontekstin e aksesit.

Modelet e Gabimeve

400

Ngarkesa e kërkesës e pavlefshme ose mungesë e fushave të kërkuara.

401

Autentikim i munguar ose i pavlefshëm.

403

Kufizim i shtrirjes/lejimit.

409

Konflikt i bllokimit: kërkesa është tashmë duke u përpunuar.

422

Dështim i verifikimit në kokat, trupin ose kontekstin.

429

Kufi i kërkesave u tejkalua.

503

Mbingarkim i sistemit ose pamundësi e shërbimit sipërm.

Shembuj

bash
curl -X POST "/api/v1/chat/completions" \
  -H "Authorization: Bearer [token]" \
  -H "Content-Type: application/json" \
  -H "X-Scope-Type: personal" \
  -d '{
    "message":"Write a short product update",
    "session_id":"sess_123",
    "stream":false
  }'