Přeskočit na hlavní obsah

Dokumentace

Jeden backend, čtyři cesty dovnitř. Každá sekce dokumentuje stejné případy použití, takže koncept, který se naučíte v REST API, je stejný koncept v MCP a v CLI.

  • Začínáme

    Autentizace, pracovní prostory, projekty a váš první publikovaný příspěvek.

    Dosud nezveřejněnoTato sekce je napsána proti dodanému API a publikuje se s ním. Raději vám neukážeme nic než dokumentaci pro koncový bod, který se může změnit.

  • REST API

    Zdroje, stránkování, idempotence, chybové kódy a limity sazeb.

    Dosud nezveřejněnoTato sekce je napsána proti dodanému API a publikuje se s ním. Raději vám neukážeme nic než dokumentaci pro koncový bod, který se může změnit.

  • MCP server

    Doprava, OAuth, katalog nástrojů, rozsahy a schvalovací handshake.

    Dosud nezveřejněnoTato sekce je napsána proti dodanému API a publikuje se s ním. Raději vám neukážeme nic než dokumentaci pro koncový bod, který se může změnit.

  • CLI

    Nainstalujte, ověřte a smlouvu o strojově čitelném výstupu.

    Dosud nezveřejněnoTato sekce je napsána proti dodanému API a publikuje se s ním. Raději vám neukážeme nic než dokumentaci pro koncový bod, který se může změnit.

  • Webhooky

    Katalog událostí, ověření podpisu, opakované pokusy a opětovné doručení.

    Dosud nezveřejněnoTato sekce je napsána proti dodanému API a publikuje se s ním. Raději vám neukážeme nic než dokumentaci pro koncový bod, který se může změnit.

  • Podle požadavků platformy, typů účtů, limitů a známých omezení.

  • Odkaz na chybu

    Každý chybový kód, co jej způsobuje a co s tím dělat.

    Dosud nezveřejněnoTato sekce je napsána proti dodanému API a publikuje se s ním. Raději vám neukážeme nic než dokumentaci pro koncový bod, který se může změnit.

Na co se můžete spolehnout

  • Každý zápis vyžaduje klíč idempotence. Opakované přehrání požadavku se stejným klíčem vrátí původní výsledek namísto vytvoření druhého příspěvku.
  • Každá chyba nese stabilní kód, klíč zprávy a vyčištěné detaily. Kódy mezi verzemi nemění význam.
  • Porušující změny dostanou novou verzi a ohlášené okno ukončení podpory. Aditivní změny ne.
  • Čtení, vytváření návrhů, žádosti o schválení, plánování a publikování jsou samostatné oblasti. Pověření získá nejmenší sadu, která dělá svou práci.

API and MCP Terms