Specifikace API
Referenční dokumentace pro integrace pracovních postupů s textem, agenty, médii a vyhledáváním informací.
https://cicora.ai/api/v1https://cicora.ai/apiReferenční dokumentace integrace: parametry a dostupné možnosti vybírejte v nastavení API svého účtu a v katalogu modelů pro své prostředí.
Odeslat první požadavekZačínáme
Odešlete první požadavek, vyberte model z katalogu a uchovejte identifikátor požadavku pro diagnostiku.
OvěřováníOdešlete klíč API v hlavičce Bearer a produkční přihlašovací údaje uchovávejte odděleně od vývojových.
SDK a klienti HTTPPro klienty ve stylu OpenAI a Messages používejte různé základní URL: cílí na stejnou specifikaci, ale cesty skládají odlišně.
CLI a integraceNastavte klienta s klíčem, modelem a základní URL odpovídající jeho protokolu; tajný údaj uchovávejte v prostředí.
Časté dotazy vývojářůStručné praktické odpovědi o klíčích, základních URL, modelech, nákladech a diagnostice integrace.
Účet a katalog
Výběr modelu sestavte z dat katalogu, nikoli z napevno zadaného seznamu ve své aplikaci.
Týmy a klíče APIOddělte klíče, vlastníky, rozpočty a záznamy využití mezi aplikacemi a pracovními prostory.
LimityLimity klíče, organizace, modelu a směrování považujte za součást pracovního postupu uživatele.
Využití a nákladyPropojte metadata odpovědi a vlastní protokoly požadavků se skutečnými akcemi uživatelů.
Data a soukromíMinimalizujte přenášená data, oddělte identifikátor koncového uživatele od obsahu a řiďte uchovávání ve svém produktu.
Text a agenti
Vytvářejte vícekolové konverzace ve známém formátu messages a pro každý požadavek vyberte model.
Messages APIPro konverzace s instrukcí system na nejvyšší úrovni a výslovným limitem výstupu používejte formát Messages.
Responses APIPoužijte jeden vstupní objekt, pokud je pro vaši aplikaci výhodné zpracovávat výstupní položky a akce v jediném datovém modelu.
StreamováníPřijímejte tokeny a strukturované delty prostřednictvím SSE bez čekání na úplnou odpověď.
Nástroje a volání funkcíPopište funkce pomocí JSON Schema, proveďte volání ve své aplikaci a vraťte výsledek do konverzace.
Strukturované výstupyPokud bude odpověď zpracovávat software, nikoli člověk, vyžádejte si objekt JSON nebo JSON Schema.
UvažováníIntenzitu uvažování nastavujte pro jednotlivé požadavky pouze u modelů, které tuto možnost deklarují.
SměrováníPožadavky na provedení vyjádřete v předvolbách týkajících se poskytovatelů a skutečný výsledek uchovejte pro pozorovatelnost.
Ukládání kontextu do mezipamětiOddělte opakovaný kontext, aby klient mohl použít kompatibilní ukládání do mezipaměti tam, kde je zvolený model podporuje.
Vyhledávání na webuZískejte aktuální zdroje prostřednictvím funkce `web_search` spouštěné klientem a uchovávejte odkazy odděleně od generovaného textu.
Média a vyhledávání informací
Nahrajte soubor samostatnou operací, uchovejte jeho ID a v pozdějším kompatibilním požadavku předejte odkaz.
ObrázkyVytvářejte obrázky prostřednictvím jedné cesty a parametry vybírejte z možností zvoleného modelu.
VideoSpusťte generování videa jako asynchronní úlohu, uchovejte její ID a tvorbu oddělte od načtení výsledku.
ZvukPro syntézu řeči, přepis a zvukový vstup do modelu používejte samostatné operace.
EmbeddingsPřevádějte text nebo podporované vstupy na vektory pro vyhledávání, shlukování a doporučení.
RerankPřeřaďte malou sadu kandidátů podle dotazu, abyste zvýšili přesnost konečného vyhledání.
Dávkové prováděníPokud pracovní postup umožňuje asynchronní doručení, zpracovávejte nezávislé operace v řízených skupinách.