Ultineo AI:n API
Aja katalogin sovelluksia omasta ohjelmistostasi. API käyttää JSONia HTTPS:n yli, todentaa jokaisen kutsun projektiavaimella ja vastaa jokaiseen kutsuun samassa muodossa.
Rakennettu kolmen resurssin ympärille
- Katalogi
Julkaistut sovellukset käytetyimmästä alkaen, kukin niiden syötekenttien kanssa, joita se odottaa.
- Ajot
Yksi kutsu käynnistää sovelluksen syötteineen, toinen lukee ajon takaisin vastauksineen.
- Avaimet
Projektiavaimet käyttöoikeuksineen, valinnaisine voimassaoloaikoineen ja tiloineen, jonka voit kytkeä pois päältä.
Todennus ja käyttöoikeudet
- Bearer-avain
Lähetä projektiavaimesi jokaisen kutsun Authorization-otsakkeessa, vain HTTPS-yhteyden kautta.
- Rajattu yhteen projektiin
Avain on sidottu yhteen projektiin, eikä se voi koskaan lukea tai kirjoittaa toisen projektin tietoja, oli pyyntö mikä tahansa.
- Tallennettu tiivisteenä
Avaimesta tallennetaan vain tiiviste, joten avain näytetään kokonaan vain kerran. Kadonnut avain korvataan, sitä ei koskaan palauteta.
Käynnistä ajo ja lue sen vastaus
- Luo
Nimeä sovellus ja anna yksi arvo kutakin syötekenttää kohden, avaimena katalogin palauttama kentän nimi.
- Seuraa
Ajot ovat asynkronisia: lue ajo uudelleen, kunnes sen tila on valmis tai epäonnistunut. Kumpikin tila on lopullinen.
- Lue
Valmis ajo sisältää vastauksensa, kestonsa sekä syötteen ja tulosteen tokenimäärät.
Yksi vakiomuoto jokaiselle vastaukselle
- Aina samat kolme kenttää
Jokainen vastaus sisältää tilakoodin, lyhyen otsikon ja varsinaisen sisällön, niin onnistuessa kuin virhetilanteessa.
- Pysyvät ilmoitukset
Virheilmoitukset ovat pysyviä englanninkielisiä merkkijonoja, jotka nimeävät puuttuvan käyttöoikeuden tai hylätyn arvon.
- Paketin rajat ovat selkeät
Kutsu, jota paketti ei kata tai joka ylittäisi sen kiintiön, hylätään omalla tilakoodillaan.
Näin saat avaimen
API-käyttö sisältyy Ultineo AI:n maksullisiin paketteihin. Itsepalvelurekisteröintiä ei vielä ole: tiimimme avaa projektisi ja antaa sinulle sen ensimmäisen avaimen.
Yhdistä ohjelmistosi Ultineo AI:hin
Kerro meille, mitä haluat automatisoida, niin avaamme projektisi ja sen API-avaimen.
Kysymyksiä API:sta
Maksulliset paketit. Maksuton paketti antaa pääsyn sovelluksiin ilman API:a.
Ei. Ohjeet kuuluvat sovelluksen omistajalle. API palauttaa syötekentät, koska juuri ne kutsuja täyttää.
Ajon luominen palaa heti uuden tilan kanssa. Saat vastauksen lukemalla ajon uudelleen, kunnes se on valmis.
Kyllä. Jokaisella avaimella on omat käyttöoikeutensa ja valinnainen voimassaoloaika, eikä avain voi koskaan luoda toista avainta, jolla on laajemmat käyttöoikeudet kuin sillä itsellään.