API:et för Ultineo AI
Kör katalogens applikationer från din egen programvara. API:et talar JSON över HTTPS, autentiserar varje anrop med en projektnyckel och besvarar alla anrop i samma format.
Uppbyggt kring tre resurser
- Katalog
De publicerade applikationerna, de mest använda först, var och en med de inmatningsfält den förväntar sig.
- Körningar
Ett anrop startar en applikation med dess indata; ett annat läser tillbaka körningen med dess svar.
- Nycklar
Projektnycklar med behörigheter, ett valfritt utgångsdatum och en status som du kan stänga av.
Autentisering och behörigheter
- En bearer-nyckel
Skicka din projektnyckel i Authorization-headern i varje anrop, endast över HTTPS.
- Begränsad till ett projekt
En nyckel är knuten till ett enda projekt och kan aldrig läsa eller skriva data i ett annat projekt, oavsett förfrågan.
- Sparad som en hash
Endast en hash av nyckeln sparas, så en nyckel visas i sin helhet en enda gång. En förlorad nyckel ersätts och återställs aldrig.
Starta en körning och läs dess svar
- Skapa
Ange applikationen och lämna ett värde per inmatningsfält, angivet med det fältnamn som katalogen returnerar.
- Följ
Körningar är asynkrona: läs körningen igen tills dess status är klar eller misslyckad. Båda är slutgiltiga.
- Läs
En klar körning innehåller sitt svar, sin varaktighet och sitt antal token för indata och utdata.
Ett fast format för alla svar
- Alltid samma tre fält
Varje svar innehåller statuskoden, en kort titel och själva innehållet, både vid framgång och vid fel.
- Stabila meddelanden
Felmeddelanden är stabila engelska textsträngar som anger den saknade behörigheten eller det avvisade värdet.
- Planens gränser är tydliga
Ett anrop som planen inte täcker, eller som skulle överskrida dess kvot, avvisas med en egen statuskod.
Så får du en nyckel
API-åtkomst ingår i de betalda Ultineo AI-planerna. Det finns ännu ingen självbetjänad registrering: vårt team öppnar ditt projekt och ger dig dess första nyckel.
Anslut din programvara till Ultineo AI
Berätta vad du vill automatisera, så öppnar vi ditt projekt och dess API-nyckel.
Frågor om API:et
De betalda planerna. Gratisplanen ger åtkomst till applikationerna utan API:et.
Nej. Instruktionerna tillhör applikationens ägare. API:et returnerar inmatningsfälten, som är det som den som anropar API:et fyller i.
När du skapar en körning svarar API:et direkt med den nya statusen. Läs körningen igen tills den är klar för att få svaret.
Ja. Varje nyckel har behörigheter och ett valfritt utgångsdatum, och en nyckel kan aldrig skapa en annan nyckel med bredare behörigheter än sina egna.