- Verzoeken aan Novita AI te authenticeren met een Bearer API-sleutel.
- Een API-sleutel in de console te maken en veilig op te slaan.
- De sleutel als omgevingsvariabele in te stellen op Linux, macOS of Windows.
- Te controleren hoelang een sleutel geldig blijft en welke sleutelbewerkingen de OpenAPI ondersteunt.
- Model- en netwerktoegangsbeleid voor een sleutel te configureren.
Authenticatie
Novita AI gebruikt Bearer-authenticatie voor API-toegang. Stuur uw API-sleutel in deAuthorization-aanvraagheader:
Een API-sleutel maken
1
Sleutelbeheer openen
Ga naar Sleutelbeheer in de console.
2
Een nieuwe sleutel maken
Selecteer API-sleutel maken en geef de sleutel een naam die het doel weergeeft, zoals
production of local-testing.3
De sleutel kopiëren en opslaan
De volledige sleutel wordt slechts één keer weergegeven, bij het aanmaken. Kopieer deze onmiddellijk en sla deze op een veilige locatie op, zoals een secrets manager of een omgevingsvariabele. Als u deze kwijtraakt, kunt u deze niet herstellen; maak in plaats daarvan een nieuwe sleutel aan.
Toegangsbeheer configureren
Toegangsbeheer is optioneel en wordt per API-sleutel geconfigureerd:- Modeltoegang voor API-sleutels bepaalt welke modellen een sleutel kan aanroepen binnen het ingeschakelde modelbereik van uw team.
- Netwerktoegang voor API-sleutels bepaalt welke bron-IP’s een sleutel kunnen gebruiken voor modelaanroepen.
Sleutelformaat en geldigheid
- Elke sleutel begint met het voorvoegsel
sk_. - Een sleutel wordt slechts één keer volledig weergegeven, bij het aanmaken. Daarna toont de console een gemaskeerde vorm.
- Elk account kan maximaal 10 API-sleutels aanmaken.
U stelt de vervaltijd in wanneer u de sleutel aanmaakt. Deze kan daarna niet worden gewijzigd: u kunt een sleutel niet verlengen of onmiddellijk laten verlopen. Permanente sleutels blijven onbeperkt geldig, waardoor een gelekte sleutel langer bruikbaar blijft. Gebruik permanente sleutels alleen wanneer dat passend is. De vervaltijd wordt alleen in de console geconfigureerd; de OpenAPI maakt geen sleutels aan en stelt de vervaltijd ervan niet in, wijzigt deze niet en verwijdert deze niet.
Wat de OpenAPI ondersteunt
U maakt en verwijdert API-sleutels alleen in de console. De Novita OpenAPI heeft geen endpoints voor het maken of verwijderen van sleutels en ondersteunt het configureren van de vervaltijd van een sleutel niet. Met de sleutelgerelateerde OpenAPI-endpoints kunt u sleutels weergeven en hun model- en netwerktoegangsbeleid beheren:- API-sleutels weergeven — geeft de sleutels van uw team weer, met een optionele samenvatting van modeltoegang.
- Modeltoegangsbeleid voor API-sleutel ophalen — leest het modeltoegangsbeleid van één sleutel.
- Modeltoegangsbeleid voor API-sleutel instellen — stelt het modeltoegangsbeleid van een sleutel in of werkt het bij.
- Modeltoegangsbeleid voor API-sleutel opnieuw instellen — zet het modeltoegangsbeleid van een sleutel terug naar de standaardwaarde. Dit stelt alleen het beleid opnieuw in; het verwijdert de sleutel zelf niet.
- IP-toegangsbeleid voor API-sleutel ophalen — leest het netwerktoegangsbeleid van één sleutel.
- IP-toegangsbeleid voor API-sleutel instellen — stelt de toegestane bron-IP’s van een sleutel in of werkt deze bij.
- IP-toegangsbeleid voor API-sleutel verwijderen — wist het netwerktoegangsbeleid van een sleutel, waardoor er weer geen beperking op bron-IP’s geldt.
Uw sleutel als omgevingsvariabele opslaan
Een sleutel hardcoderen in broncode kan deze blootstellen, bijvoorbeeld wanneer u het bestand commit. Door deze uit een omgevingsvariabele zoalsNOVITA_API_KEY te lezen, blijft deze buiten uw broncode.
Tijdelijk vs. permanent
Een sleutel die is ingesteld metexport (Linux/macOS) of set (Windows) blijft alleen bestaan voor de huidige terminalsessie en verdwijnt wanneer u deze sluit. Dit is geschikt voor een snelle test. Als u de sleutel tussen sessies wilt behouden, stelt u deze permanent in zoals hieronder wordt weergegeven en opent u vervolgens een nieuwe terminal zodat de wijziging van kracht wordt.
De variabele is ingesteld, maar de code kan deze nog steeds niet vinden
U hebt deze tijdelijk ingesteld en een nieuwe terminal geopend
U hebt deze tijdelijk ingesteld en een nieuwe terminal geopend
Een sleutel die is ingesteld met
export of $env: bestaat alleen in de terminalsessie waarin u de opdracht hebt uitgevoerd. Een nieuwe terminal of tab neemt deze niet over. Stel de sleutel permanent in (>> ~/.zshrc, setx), of voer de opdracht export/$env: opnieuw uit in de sessie die u gebruikt.U hebt deze permanent ingesteld, maar niet opnieuw opgestart
U hebt deze permanent ingesteld, maar niet opnieuw opgestart
Een permanente wijziging (een shellprofiel of
setx) geldt voor terminals die na de wijziging worden gestart. Open een nieuwe terminal en start vervolgens uw IDE of editor opnieuw, zodat deze de bijgewerkte omgeving kan lezen. Op Windows heeft setx geen invloed op terminals die al open zijn.Een servicemanager neemt uw shellomgeving niet over
Een servicemanager neemt uw shellomgeving niet over
Processen die worden gestart door
systemd, supervisor, Docker of een CI-runner lezen uw interactieve shellprofiel niet. Stel de variabele in de eigen configuratie van de service in, zoals de Environment= van een systemd-unit, een docker run -e-flag, of de secrets van het CI-project, in plaats van in ~/.bashrc.U hebt de opdracht onder sudo uitgevoerd
U hebt de opdracht onder sudo uitgevoerd
sudo geeft uw omgeving standaard niet door, dus een variabele die door uw gebruiker is geëxporteerd, is niet zichtbaar voor het verhoogde proces. Gebruik sudo -E om de omgeving te behouden, of stel de variabele in de verhoogde context in.Gerelateerd
- Veelvoorkomende foutcodes — los
401- en403-responsen op die gerelateerd zijn aan sleutels. - Snelheidslimieten — aanvraag- en tokenlimieten die op uw account van toepassing zijn.