Models API jest zgodne z OpenAI: treści żądań, parametry i obiekty odpowiedzi odpowiadają HTTP API OpenAI. Możesz więc korzystać z istniejących samouczków i SDK OpenAI, zmieniając bazowy URL i klucz API.

Zanim zaczniesz

• Obszar roboczy monday.com w planie Pro lub Enterprise, z funkcjami AI dostępnymi dla Twojego przypadku użycia.

1. Uzyskaj token API

Do uwierzytelniania w Models API użyj osobistego tokenu API monday.com, a nie klucza API OpenAI. Instrukcje tworzenia i kopiowania tokenu, generowania go ponownie oraz informacje o tym, do czego daje dostęp, znajdziesz w sekcji Uwierzytelnianie.

Jeśli zamiast tego uwierzytelniasz się za pomocą tokenu aplikacji, skonfiguruj zakresy i tokeny zgodnie z dokumentacją aplikacji, aby token mógł korzystać z funkcji AI. Aplikacja powiązana z tokenem musi mieć zakres ai:consume.

2. Skieruj klienta do Models API

Ustaw:

Ustawienie	Wartość
Bazowy URL	https://api.monday.com/platform-ai-gateway/openai/v1
Autoryzacja	Bearer <MONDAY_API_TOKEN>

Jeśli korzystasz z SDK OpenAI, ustaw baseURL / base_url na powyższą wartość, a apiKey / api_key na swój token monday.

3. Wyślij testowe żądanie

cURL (uzupełnianie czatu)

curl -sS -X POST "https://api.monday.com/platform-ai-gateway/openai/v1/chat/completions" \
  -H "Authorization: Bearer <MONDAY_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "monday-standard",
    "messages": [{ "role": "user", "content": "Reply with the word: ok" }]
  }'

Do testów polecamy monday-standard (lub monday-fast / monday-powerful). Zobacz zalecane aliasy modeli czatu. Możesz też przekazać bezpośredni identyfikator modelu z listy obsługiwanych modeli.

Obsługiwane funkcje

Funkcja	Punkt końcowy	Uwagi
Tekst / czat	POST /chat/completions	Strumieniowanie SSE, narzędzia / wywoływanie funkcji, tryby odpowiedzi JSON - te same koncepcje co w OpenAI.
Wektory osadzeń	POST /embeddings	Wektory tekstowe do wyszukiwania, RAG i porównywania podobieństwa.
Obrazy	POST /images/generations	Generowanie obrazu na podstawie promptu tekstowego.
Dźwięk	POST /audio/speech	Zamiana tekstu na mowę; odpowiedź zawiera dźwięk w formacie binarnym (na przykład MP3).

Za pomocą jednego API możesz obsługiwać tekst, wektory osadzeń, obrazy i dźwięk.

Aliasy modeli czatu (zalecane)

W przypadku /chat/completions, gdy tylko możesz, przekazuj jeden z aliasów monday-* zamiast wpisywać na stałe identyfikator modelu dostawcy:

• monday-fast → claude-haiku-4-5
• monday-standard → claude-sonnet-4-6 (używany również wtedy, gdy pominięto model)
• monday-powerful → claude-opus-4-6

Dlaczego warto używać aliasów: Są stabilniejsze dla Twojego produktu. monday kontroluje, jaki model bazowy odpowiada danemu aliasowi, dlatego ulepszenia (na przykład przejście na nowszy model Sonnet) nie wymagają ponownego wdrażania nowych nazw modeli w wielu miejscach. Zobacz obsługiwane modele oraz cennik i rozliczanie użycia.

Korzystanie z oficjalnych SDK OpenAI

Skieruj klienta do bazowego URL Models API i użyj tokenu monday jako klucza API. Typy żądań i odpowiedzi odpowiadają tym, których oczekują SDK OpenAI, więc możesz korzystać z dowolnego samouczka dotyczącego OpenAI, zmieniając bazowy URL i klucz API.

• Pełna lista metod i parametrów: dokumentacja referencyjna API OpenAI
• Cookbook i przykłady: dokumentacja OpenAI - używaj tych samych struktur żądań; sprawdzaj identyfikatory modeli na liście obsługiwanych modeli, ponieważ nie każda nazwa modelu OpenAI jest dostępna w Models API.

👍 Wskazówka

Niektóre SDK OpenAI wymagają jawnego argumentu model, nawet gdy serwer nadrzędny ma ustawiony model domyślny. Jeśli musisz przekazać wartość, użyj monday-standard (lub innego aliasu monday-*) zamiast identyfikatora modelu dostawcy. Jeśli w żądaniu REST korzystasz z wartości domyślnych po stronie serwera, Models API domyślnie używa monday-standard.

Uwagi dotyczące działania

Planując integrację, weź pod uwagę kilka praktycznych różnic względem bezpośredniego korzystania z OpenAI:

• Obrazy: Odpowiedzi mogą zawierać dane obrazu w polu b64_json zamiast hostowanego adresu url - dekoduj dane Base64 w swojej aplikacji.
• Błędy: Niektóre błędy HTTP (na przykład błędy uwierzytelniania) mogą mieć format JSON specyficzny dla platformy, zamiast obiektu error OpenAI. Obsługuj zarówno surowe błędy HTTP, jak i ustrukturyzowane treści error.
• Modele: Nieobsługiwane nazwy modeli mogą powodować ogólne błędy po stronie usługi nadrzędnej - korzystaj z listy obsługiwanych modeli i przypinaj konkretne identyfikatory modeli w środowisku produkcyjnym.

Rozliczanie użycia

Korzystanie z samego Models API nie wiąże się z osobną opłatą. Zużycie jest rozliczane w tokenach monday AI. Ich liczba ma możliwie najlepiej odzwierciedlać koszt modelu bazowego, ale w zależności od używanego modelu może uwzględniać niewielki dodatkowy koszt. Szczegóły znajdziesz w sekcji cennik i rozliczanie użycia.

Podczas integracji sprawdzaj nagłówki odpowiedzi (takie jak x-monday-credits-used), aby Twoja aplikacja mogła spójnie rejestrować lub wyświetlać informacje o użyciu.

Zobacz też