Přeskočit na hlavní obsah

Rest API

Rest API připojení umožňuje napojit libovolné HTTP API do Siesta AI bez potřeby speciálního nativního konektoru. V rámci jednoho připojení můžete definovat více funkcí (endpointů) a pro každou funkci nastavit parametry.

1. Přidání nového Rest API připojení​

  1. Otevřete sekci Připojení.
  2. Klikněte na Add Connection.
  3. V dialogu vyberte dlaždici Rest API.

Výběr Rest API v Add Connection dialogu

2. Základní konfigurace připojení​

Po výběru Rest API vyplňte:

  • Name: název integrace v Siesta AI.
  • Base URL: základní URL API (např. https://api.example.com).
  • Visibility: určuje dostupnost připojení.
  • Private = připojení je viditelné pouze pro vás.
  • Shared = připojení může používat více uživatelů v organizaci.

Formulář Rest API připojení a definice funkce

3. Functions (endpointy)​

V části Functions definujete konkrétní volání API:

  • Add function přidá další endpoint.
  • Function name: interní název funkce pro použití v agentech/workflow.
  • Description: stručný popis, co endpoint dělá.
  • Endpoint: kombinuje HTTP metodu (GET, POST, PUT, DELETE, ...) a cestu endpointu (např. /example), která se skládá s Base URL.

Prakticky to znamená, že:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • výsledné volání: https://api.example.com/orders

4. Parametry funkce​

V části Parameters můžete pro každou funkci přidat více parametrů přes Add parameter.

Nastavitelné položky:

  • Key: název parametru.
  • Value type: datový typ (např. String).
  • Position: kam se parametr zapisuje (Query, Path, Header, případně Body podle endpointu).
  • Required: zda je parametr povinný.
  • Description: dokumentační popis parametru.
  • Static value: volitelná pevná hodnota, která se posílá vždy.

Definice parametrů funkce v Rest API připojení

5. Doporučení pro použití​

  • Používejte konzistentní pojmenování funkcí podle business akce (např. getOrders, createTicket).
  • Povinné parametry nastavujte jako Required = true, aby se předešlo nevalidním voláním.
  • Citlivé hodnoty ukládejte bezpečně a nepředávejte je jako volný text v promptu.
  • U sdílených připojení (Shared) průběžně kontrolujte, kdo má k integraci přístup.

Shrnutí​

Rest API konektor je univerzální způsob, jak do Siesta AI připojit externí systémy přes HTTP endpointy. Umožňuje kombinovat více funkcí v jedné integraci a detailně řídit parametry každého volání.