Przejdź do treści
Przewodniki
Przewodniki

Szybki start

Wywoływanie modeli językowych RunAPI przez obsługiwany protokół synchroniczny lub strumieniowy.

Zobacz Markdown

RunAPI udostępnia modele językowe poprzez znane publiczne kształty protokołów. Wskaż istniejący kompatybilny klient na adres https://runapi.ai, użyj identyfikatora modelu RunAPI i uwierzytelnij się standardowym kluczem API.

Wybierz protokół

  • Zgodny z OpenAI Chat Completions używa POST /v1/chat/completions.
  • Zgodny z OpenAI Responses używa POST /v1/responses.
  • Zgodny z Anthropic Messages używa POST /v1/messages.
  • Generowanie treści zgodne z Gemini używa /v1beta/models/{model}:generateContent lub :streamGenerateContent.

Wybierz protokół najlepiej pasujący do istniejącego klienta i przepływu aplikacji. Katalog modeli wskazuje, które publiczne protokoły obsługuje każdy model.

Wyślij żądanie

To żądanie Chat Completions zwraca jedną synchroniczną odpowiedź:

SHELL 
curl "https://runapi.ai/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [{"role": "user", "content": "Summarize why idempotency matters."}]
  }'

Zachowaj kształt żądania i odpowiedzi zgodny z wybranym protokołem. Użyj Dokumentacji interfejsu API danej operacji, aby uzyskać dokładne pola, wywoływanie narzędzi, strukturyzowane wyjście i ograniczenia specyficzne dla modelu.

Strumieniowe wyjście

Ustaw opcję strumieniowania protokołu i odbieraj zwrócone zdarzenia wysyłane przez serwer przyrostowo. W przypadku Chat Completions dodaj "stream": true; dla wywołań kompatybilnych z Gemini użyj operacji :streamGenerateContent. Zamknij strumień, gdy klient odbierze terminalowe zdarzenie protokołu.

Sprawdzanie wierności dostarczania

Każda zaakceptowana odpowiedź LLM zawiera nagłówek X-RunAPI-Fidelity. Wartość full oznacza, że żądanie zostało dostarczone bez pominięć. Wartość lossy oznacza, że RunAPI pominął opcjonalne parametry sterujące, aby zrealizować żądanie; X-RunAPI-Omitted-Fields zawiera ich nazwy oddzielone przecinkami. Żądania, których wymagana semantyka cyklu życia, kontynuacji, narzędzi lub typowanych elementów nie może zostać zachowana, są odrzucane przed utworzeniem zadania (Task).

Oba nagłówki są udostępniane przez CORS, dzięki czemu klienci przeglądarkowi mogą je odczytywać. Rejestruj je razem z identyfikatorem żądania, gdy dokładne zachowanie dostarczania ma znaczenie dla aplikacji.

Obsługa błędów i użycia

Traktuj 401 jako błąd uwierzytelniania, odpowiedzi 4xx jako problemy z żądaniem lub polityką, a ponów próbę tylko w przypadku przejściowych awarii serwera lub sieci. Odczytuj zużycie tokenów z końcowej odpowiedzi lub terminalnego zdarzenia strumienia w wybranym kształcie protokołu i przechowuj identyfikatory żądań w logach aplikacji dla potrzeb wsparcia.