API-spesifikasjon
Referanse for integrasjoner i arbeidsflyter for tekst, agenter, medier og informasjonsgjenfinning.
https://cicora.ai/api/v1https://cicora.ai/apiIntegrasjonsreferanse: Velg parametere og tilgjengelige funksjoner fra API-innstillingene for kontoen og modellkatalogen for miljøet ditt.
Send den første forespørselenKom i gang
Send en første forespørsel, velg en modell fra katalogen, og behold en forespørselsidentifikator til diagnostisering.
AutentiseringSend en API-nøkkel i et Bearer-hode, og hold produksjonslegitimasjon atskilt fra utviklingslegitimasjon.
SDK-er og HTTP-klienterBruk ulike basis-URL-er for klienter i OpenAI-stil og Messages-klienter: de retter seg mot én spesifikasjon, men setter sammen baner på ulike måter.
Kommandolinje og integrasjonerKonfigurer en klient med nøkkel, modell og basis-URL som samsvarer med protokollen, og oppbevar hemmeligheten i miljøet.
Vanlige spørsmål for utviklereKorte, praktiske svar om nøkler, basis-URL-er, modeller, kostnader og diagnostisering av integrasjoner.
Konto og katalog
Bygg modellvalget fra katalogdata i stedet for en hardkodet liste i applikasjonen.
Team og API-nøklerHold nøkler, eiere, budsjetter og bruksspor atskilt mellom applikasjoner og arbeidsområder.
GrenserBehandle grenser for nøkkel, organisasjon, modell og ruting som en del av brukerflyten.
Bruk og kostnaderKnytt metadata fra svaret og dine egne forespørselslogger til faktiske brukerhandlinger.
Data og personvernMinimer overførte data, hold en sluttbrukeridentifikator atskilt fra innholdet, og styr oppbevaringen i produktet.
Tekst og agenter
Opprett samtaler over flere runder i det velkjente messages-formatet, og velg en modell for hver forespørsel.
Messages APIBruk Messages-formatet for samtaler med en systeminstruksjon på toppnivå og en uttrykkelig grense for utdata.
Responses APIBruk ett input-objekt når applikasjonen har nytte av å behandle utdataelementer og handlinger i én datamodell.
StrømmingMotta tokener og strukturerte deltaer gjennom SSE uten å vente på hele svaret.
Verktøy og funksjonskallBeskriv funksjoner med JSON Schema, kjør kallet i applikasjonen, og returner resultatet til samtalen.
Strukturerte utdataBe om et JSON-objekt eller JSON Schema når svaret skal brukes av programvare, ikke av en person.
ResonneringAngi resonneringsinnsats per forespørsel bare for modeller som oppgir at de støtter funksjonen.
RutingAngi krav til kjøring i leverandørpreferansene, og behold det faktiske utfallet for observerbarhet.
KontekstmellomlagringSkill ut gjentakende kontekst, slik at klienten kan bruke kompatibel mellomlagring der den valgte modellen støtter det.
NettsøkHent ferske kilder gjennom en klientkjørt `web_search`-funksjon, og hold lenker atskilt fra generert tekst.
Medier og informasjonsgjenfinning
Last opp en fil gjennom en egen operasjon, behold ID-en, og send en referanse i en senere kompatibel forespørsel.
BilderOpprett bilder gjennom én rute, og velg parametere fra funksjonene til den valgte modellen.
VideoStart video som en asynkron jobb, behold jobb-ID-en, og hold opprettelsen atskilt fra lesingen av resultatet.
LydBruk separate operasjoner for talesyntese, transkripsjon og lydinndata til en modell.
InnebyggingerGjør tekst eller støttede inndata om til vektorer for søk, klyngedannelse og anbefalinger.
OmrangeringOmorganiser et lite sett med kandidater opp mot en spørring for å forbedre presisjonen i den endelige gjenfinningen.
BatchkjøringBehandle uavhengige operasjoner i kontrollerte grupper når arbeidsflyten tillater asynkron levering.