Dokumentacja API
Wybierz format żądań, skonfiguruj uwierzytelnianie i odczytaj nagłówki routingu.
Ustaw https://unused.market/v1 jako bazowy URL klienta zgodnego z OpenAI. Sekcja szybkiego startu w API Keys pokazuje dokładny adres bramy API dla Twojego konta. SDK Anthropic przyjmują adres hosta https://unused.market i same dodają /v1/messages.
Endpointy
| Metoda | Trasa | Zastosowanie |
|---|---|---|
POST | /v1/chat/completions | Tekst, narzędzia, obrazy, rozumowanie i ustrukturyzowana odpowiedź w formacie OpenAI |
POST | /v1/messages | Wiadomości i bloki treści w formacie Anthropic |
POST | /v1/messages/count_tokens | Liczba tokenów od dostawcy lub oszacowanie |
GET | /v1/models | Dostępne modele z uwzględnieniem ograniczeń klucza i routingu |
Publiczna brama API nie udostępnia /v1/responses, Realtime, Batch ani Assistants. Format klienta nie musi odpowiadać formatowi dostawcy: brama konwertuje obsługiwane funkcje w obie strony. Poszczególne oferty mogą mieć dodatkowe ograniczenia. Zobacz Modele.
Uwierzytelnij każde żądanie
Wyślij jeden z poniższych nagłówków z kluczem utworzonym w API Keys:
Authorization: Bearer sk-unused-...x-api-key: sk-unused-...sk-unused-... to przykładowa wartość w dokumentacji. Zastąp ją całym ujawnionym kluczem; nie zmieniaj jego prefiksu. Jeśli wyślesz oba nagłówki, rozpoznana wartość Bearer w Authorization ma pierwszeństwo przed x-api-key. Żądania JSON wymagają też Content-Type: application/json.
Odczytaj nagłówki odpowiedzi
Pole
Typ
W klientach Anthropic wysyłaj anthropic-version: 2023-06-01. Dla GET /v1/models obecność anthropic-version wybiera format odpowiedzi Anthropic. Bez tego nagłówka odpowiedź ma strukturę OpenAI z object: "list". Udane liczenie tokenów zwraca input_tokens; nie nalicza opłaty za inferencję ani nie dodaje udanego wywołania do historii żądań.
Ustaw budżet odpowiedzi
W Chat Completions ustaw max_completion_tokens lub max_tokens. Jeśli podasz oba, pierwszeństwo ma max_completion_tokens. Jeśli nie podasz żadnego, brama użyje maksymalnego limitu wyjściowego modelu, co może zwiększyć blokadę środków. W Messages max_tokens jest wymagane. Trasa liczenia tokenów ustawia własny budżet jednego tokenu na potrzeby walidacji.
Szacowane wejście wraz z budżetem odpowiedzi musi mieścić się w oknie kontekstu modelu. Zobacz kredyty i blokady środków. Dla żądania obsługiwanego przez subskrypcję Codex efektywny budżet odpowiedzi wynosi co najmniej 16 tokenów; końcowa opłata nadal zależy od rzeczywistego zużycia.
Odbierz odpowiedź strumieniową
Ustaw stream: true, aby odbierać zdarzenia server-sent events. Klient OpenAI może dodać stream_options: { "include_usage": true }. Odczytaj cały strumień, w tym zdarzenia zużycia i zakończenia, oraz obsłuż zdarzenie błędu nawet po poprawnym statusie HTTP.
Przed wysłaniem bajtów odpowiedzi brama może wypróbować inną ofertę. Po wysłaniu bajtów nie przełącza już oferty: wysyła zdarzenie błędu, jeśli połączenie nadal na to pozwala. Jeśli klient się rozłączył lub przestał czytać, połączenie może zostać zamknięte. Częściowa odpowiedź może mieć zapisane zużycie i opłatę. Przed ponowieniem przeczytaj opis błędów.
Nieobsługiwane opcje
Parser OpenAI odrzuca n inne niż 1, logprobs, top_logprobs, logit_bias, audio na poziomie żądania i wiadomości oraz wpisy inne niż tekstowe w modalities. Wiadomości systemowe i deweloperskie muszą zawierać tekst. Obsługiwane są tylko narzędzia function oraz typy treści tekstowej i obrazowej opisane w wygenerowanym schemacie.
Zgodność obejmuje określony zakres funkcji, a nie całość API obu dostawców. Przyjęcie innego pola nie potwierdza obsługi danej funkcji. Nadal obowiązują możliwości modelu i dostawcy. Przy kolejnych wywołaniach narzędzi zachowuj bloki rozumowania i podpisy zwrócone przez dostawcę; ich zmiana może spowodować błąd następnego żądania.
Sprawdź schemat
Strony endpointów powstają ze schematów żądań OpenAPI działającej bramy API. Pobierz publiczny schemat bramy. Dokument uruchomionej aplikacji nie zawiera obecnie schematów odpowiedzi, dlatego przykłady i opis błędów weryfikujemy osobno na podstawie kodu oraz lokalnych żądań z symulowanym dostawcą.