Referenční příručka API pro vývojáře

Propojte vlastní aplikaci se svým pracovním prostorem: REST API, jeho klíče a rozsahy, chyby, limity požadavků a webhooky.

Kde to najdete

⚙️ Nastavení › Referenční příručka API · Domovská stránka › Zdroje › Referenční příručka API

Otevřít tuto obrazovku
Referenční příručka API s postranní nabídkou, ověřováním a koncovými body.

Kroky

  1. Otevřete „Referenční příručka API“ v postranním panelu nebo v nabídce „Zdroje“ na domovské stránce.
  2. Začněte částí „Začněte zde“: „Základní URL a konvence“, „Ověřování“ a „Rozsahy“.
  3. Vyhledejte „Koncové body“ podle skupin; každý ukazuje parametry, tělo požadavku, odpověď a chyby s příklady.
  4. Před spuštěním do provozu si přečtěte „Chyby a stavové kódy“, „Limity požadavků“ a „Webhooky (odchozí)“. „OpenAPI JSON“ stáhne celou specifikaci.

Řešení problémů

Jak získám klíč API?

Klíče se pro váš pracovní prostor vydávají na vyžádání; v aplikaci je zatím vytvořit nelze. Klíče vašeho pracovního prostoru jsou uvedeny na stránce pro vývojáře v oblasti AI, kde mohou lidé spravující pracovní prostor také přidávat a testovat koncové body webhooků.

Tipy

  • API volejte jen ze svého serveru. Nikdy nedávejte klíč do webové stránky ani do mobilní aplikace.

Dobré vědět

  • Referenční příručku API lze číst bez přihlášení.

Související návody

Začít zdarma Domů