Możliwości klucza API agenta
Klucz API agenta (agent API key) to api_token, który otrzymujesz po połączeniu zewnętrznego agenta niestandardowego. Wywołania wykonane przy użyciu tego tokena są realizowane jako agent, a nie jako użytkownik, który go połączył.
Agenci są nadal aktywnie rozwijani, a nowe możliwości pojawiają się każdego dnia. Ta strona przedstawia podstawowe operacje API, które agenci mogą obecnie wykonywać. Nie zawiera pełnego opisu wszystkich interfejsów API dostępnych dla agentów.
Czym token agenta różni się od tokena użytkownika
| Token użytkownika | Klucz API agenta | |
|---|---|---|
| Tożsamość | Użytkownik monday.com | Agent. me.kind ma wartość external_agent_member lub external_agent_detached_member |
| Domyślny dostęp | Tablice i dokumenty, które może otworzyć użytkownik | Brak. Agent nie ma na początku dostępu do żadnych tablic ani dokumentów |
| Przypisanie | Użytkownik | Agent |
Sprawdź token za pomocą me:
query {
me {
id
name
email
kind
}
}
Adresy e-mail agentów mają format agent-<id>@agent.monday.com.
Przyznaj dostęp przed wysłaniem zapytania
Osoba, która utworzyła agenta, nie przekazuje mu dostępu do swoich tablic i dokumentów. Przyznaj agentowi dostęp na jeden z poniższych sposobów:
- Utwórz zasób za pomocą tokena agenta. Agent może korzystać z utworzonych przez siebie tablic i publicznych dokumentów.
- Przyznaj dostęp do zasobów wiedzy za pomocą
add_agent_resource_accessz tokena użytkownika. Ustaw nagłówekAPI-Version: dev. Ustawscope_typenaBOARDlubDOCi przekaż identyfikator agenta z jego adresu e-mail albo z odpowiedzi na żądanie połączenia.
Do użycia create_board wymagany jest workspace_id.
Obsługiwane operacje
Te operacje powiodą się, jeśli agent ma już dostęp do zasobu.
Tablice, grupy i kolumny
- Wyświetlanie listy tablic i pobieranie informacji o tablicach
- Tworzenie tablicy w obszarze roboczym i duplikowanie tablicy
- Tworzenie, duplikowanie i wyświetlanie listy grup oraz pobieranie informacji o grupach
- Dodawanie kolumny
- Tworzenie folderu w obszarze roboczym
- Odczytywanie dzienników aktywności tablicy
- Agregowanie danych tablicy, w tym za pomocą
COUNT_ITEMS, filtrów kolumn igroup_by(grupy statusu zwracają kolory w formacie szesnastkowym, np.#00c875)
Elementy i aktualizacje
- Tworzenie elementu, w tym wartości kolumn, oraz tworzenie podelementu
- Pobieranie elementu oraz wyświetlanie listy elementów na tablicy lub w grupie
- Przenoszenie elementu między grupami i duplikowanie elementu
- Odczytywanie i aktualizowanie wartości kolumn (
change_multiple_column_values,change_simple_column_value) - Wyszukiwanie elementów według wartości kolumn (
items_page_by_column_valuesorazitems_pagezquery_params) - Tworzenie aktualizacji i wyświetlanie listy aktualizacji, w tym odpowiedzi
- Usuwanie elementu (
delete_item)
Osoby i konto
- Wyświetlanie listy użytkowników i pobieranie informacji o użytkownikach
- Wyświetlanie listy zespołów i pobieranie informacji o zespołach oraz wyświetlanie listy członków zespołu
- Dodawanie subskrybentów tablicy oraz wyświetlanie listy subskrybentów tablicy lub elementu
- Tworzenie powiadomienia
- Tworzenie tagu lub pobieranie informacji o tagu
- Odczytywanie danych
account,workspacesicomplexity
Dokumenty
Agent może wykonywać następujące operacje na publicznych dokumentach, do których ma dostęp:
- Wyświetlanie listy dokumentów i odczytywanie bloków
- Tworzenie dokumentu w obszarze roboczym (
create_doczkind: public) - Aktualizowanie nazwy dokumentu (
update_doc_name) - Dodawanie treści w formacie Markdown (
add_content_to_doc_from_markdown) - Duplikowanie dokumentu (
duplicate_doc)
Nieobsługiwane operacje
| Operacja | Co się dzieje |
|---|---|
Tworzenie webhooka lub wyzwalacza (create_webhook) |
Obecnie agenci nie mogą tworzyć wyzwalaczy |
Archiwizowanie elementu lub tablicy (archive_item, archive_board) |
Brak autoryzacji, także w przypadku tablic utworzonych przez agenta. Usuwanie elementu nadal działa |
Usuwanie subskrybentów tablicy (delete_subscribers_from_board) |
Brak autoryzacji. Dodawanie subskrybentów działa |
Przesyłanie pliku (add_file_to_update, add_file_to_column) |
Brak autoryzacji |
Usuwanie dokumentu (delete_doc) |
Operacja kończy się niepowodzeniem, także w przypadku dokumentów utworzonych przez agenta |
Tworzenie prywatnego dokumentu (create_doc z kind: private) |
Mutacja zwraca błąd, a prywatny dokument może nadal pojawić się w obszarze roboczym |
Zapraszanie użytkowników lub zarządzanie rolami konta (invite_users, account_roles) |
Brak autoryzacji |
Uruchamianie innego agenta (run_agent) lub czatu monday AI |
Niedostępne z kluczem API agenta |