API-specificatie
Referentie voor integraties in tekst-, agent-, media- en zoekworkflows.
https://cicora.ai/api/v1https://cicora.ai/apiIntegratiereferentie: kies parameters en beschikbare mogelijkheden uit de API-instellingen van uw account en de modelcatalogus voor uw omgeving.
Een eerste aanvraag versturenAan de slag
Stuur een eerste aanvraag, selecteer een model uit de catalogus en bewaar een aanvraag-ID voor diagnose.
AuthenticatieStuur een API-sleutel in een Bearer-header en houd inloggegevens voor productie gescheiden van inloggegevens voor ontwikkeling.
SDK's en HTTP-clientsGebruik verschillende basis-URL's voor OpenAI-achtige clients en Messages-clients: ze richten zich op één specificatie, maar stellen paden anders samen.
CLI en integratiesConfigureer een client met een sleutel, model en basis-URL die bij het protocol passen; bewaar het geheim in de omgeving.
Veelgestelde vragen voor ontwikkelaarsKorte praktische antwoorden over sleutels, basis-URL's, modellen, kosten en integratiediagnose.
Account en catalogus
Bouw modelselectie op uit catalogusgegevens in plaats van een hardgecodeerde lijst in uw toepassing.
Teams en API-sleutelsHoud sleutels, eigenaren, budgetten en gebruikstraces gescheiden tussen toepassingen en werkruimten.
LimietenBeschouw sleutel-, organisatie-, model- en routeringslimieten als onderdeel van de gebruikersworkflow.
Gebruik en kostenKoppel antwoordmetadata en uw eigen aanvraaglogboeken aan echte gebruikersacties.
Gegevens en privacyMinimaliseer verzonden gegevens, houd een eindgebruikers-ID gescheiden van inhoud en beheer bewaring in uw product.
Tekst en agents
Maak gesprekken over meerdere beurten in de vertrouwde messages-indeling en selecteer voor elke aanvraag een model.
Messages APIGebruik de Messages-indeling voor gesprekken met een systeeminstructie op het hoogste niveau en een expliciete uitvoerlimiet.
Responses APIGebruik één invoerobject wanneer uw toepassing baat heeft bij het verwerken van uitvoeritems en acties in één gegevensmodel.
StreamingOntvang tokens en gestructureerde delta's via SSE zonder op het volledige antwoord te wachten.
Tools en functieaanroepenBeschrijf functies met JSON Schema, voer de aanroep in uw toepassing uit en geef het resultaat terug aan het gesprek.
Gestructureerde uitvoerVraag om een JSON-object of JSON Schema wanneer software, en niet een persoon, het antwoord verwerkt.
RedenerenStel de redeneerinspanning per aanvraag alleen in voor modellen die deze mogelijkheid aangeven.
RouteringLeg uitvoeringsvereisten vast in providervoorkeuren en bewaar het daadwerkelijke resultaat voor observeerbaarheid.
ContextcachingHoud terugkerende context apart, zodat een client compatibele caching kan gebruiken waar het gekozen model dit ondersteunt.
Zoeken op het webHaal actuele bronnen op via een door de client uitgevoerde functie `web_search` en houd links gescheiden van gegenereerde tekst.
Media en ophalen
Upload een bestand via een speciale bewerking, bewaar de ID en geef een verwijzing door in een latere compatibele aanvraag.
AfbeeldingenMaak afbeeldingen via één route en selecteer parameters uit de mogelijkheden van het gekozen model.
VideoStart video als asynchrone taak, bewaar de taak-ID en houd het maken gescheiden van het lezen van het resultaat.
AudioGebruik afzonderlijke bewerkingen voor spraaksynthese, transcriptie en audio-invoer naar een model.
EmbeddingsZet tekst of ondersteunde invoer om in vectoren voor zoeken, clusteren en aanbevelingen.
HerordenenHerorden een kleine kandidatenverzameling ten opzichte van een query om de precisie van het uiteindelijke ophalen te verbeteren.
BatchuitvoeringVerwerk onafhankelijke bewerkingen in beheerde groepen wanneer de workflow asynchrone levering toestaat.