API-specifikation
Referens för integrationer i arbetsflöden för text, agenter, medier och informationshämtning.
https://cicora.ai/api/v1https://cicora.ai/apiIntegrationsreferens: välj parametrar och tillgängliga funktioner från API-inställningarna för ditt konto och modellkatalogen för din miljö.
Skicka en första begäranKom igång
Skicka en första begäran, välj en modell från katalogen och spara en begärandeidentifierare för diagnostik.
AutentiseringSkicka en API-nyckel i ett Bearer-huvud och håll autentiseringsuppgifter för produktion åtskilda från autentiseringsuppgifter för utveckling.
SDK:er och HTTP-klienterAnvänd olika bas-URL:er för OpenAI-kompatibla klienter och Messages-klienter: de riktar sig mot en specifikation men sätter samman sökvägar på olika sätt.
CLI och integrationerKonfigurera en klient med en nyckel, modell och bas-URL som matchar dess protokoll; förvara hemligheten i miljön.
Vanliga frågor för utvecklareKorta praktiska svar om nycklar, bas-URL:er, modeller, kostnad och integrationsdiagnostik.
Konto och katalog
Bygg modellvalet från katalogdata i stället för en hårdkodad lista i din applikation.
Team och API-nycklarHåll nycklar, ägare, budgetar och användningsspår åtskilda mellan applikationer och arbetsytor.
GränserBetrakta gränser för nyckel, organisation, modell och dirigering som en del av användarens arbetsflöde.
Användning och kostnadKoppla metadata i svaret och dina egna begärandeloggar till faktiska användaråtgärder.
Data och integritetMinimera överförda data, håll en slutanvändaridentifierare åtskild från innehåll och styr lagring i din produkt.
Text och agenter
Skapa konversationer med flera turer i det välkända messages-formatet och välj en modell för varje begäran.
Messages APIAnvänd Messages-formatet för konversationer med en systeminstruktion på toppnivå och en uttrycklig utdatagräns.
Responses APIAnvänd ett indataobjekt när din applikation har nytta av att hantera utdataobjekt och åtgärder i en enda datamodell.
StrömningTa emot token och strukturerade deltasvar via SSE utan att vänta på hela svaret.
Verktyg och funktionsanropBeskriv funktioner med JSON Schema, kör anropet i din applikation och returnera resultatet till konversationen.
Strukturerad utdataBegär ett JSON-objekt eller JSON Schema när svaret ska användas av programvara i stället för av en person.
ResonemangAnge resonemangsnivå per begäran endast för modeller som uppger att funktionen stöds.
DirigeringAnge körningskraven i leverantörsinställningarna och spara det faktiska utfallet för observerbarhet.
KontextcachelagringHåll återkommande kontext separat så att en klient kan använda kompatibel cachelagring där den valda modellen stöder det.
WebbsökningHämta aktuella källor genom en klientkörd `web_search`-funktion och håll länkar åtskilda från genererad text.
Medier och informationshämtning
Ladda upp en fil genom en särskild åtgärd, spara dess id och skicka en referens i en senare kompatibel begäran.
BilderSkapa bilder via en sökväg och välj parametrar från den valda modellens funktioner.
VideoStarta video som ett asynkront jobb, spara dess jobb-id och håll skapandet åtskilt från läsningen av resultatet.
LjudAnvänd separata åtgärder för talsyntes, transkribering och ljudindata till en modell.
InbäddningarOmvandla text eller indata som stöds till vektorer för sökning, klustring och rekommendationer.
OmrankningSortera om en liten uppsättning kandidater mot en fråga för att förbättra precisionen i den slutliga hämtningen.
BatchkörningBearbeta oberoende åtgärder i kontrollerade grupper när arbetsflödet tillåter asynkron leverans.