Edistynyt15 min
API-dokumentaatio
Integroi Lyyli.ai palvelut sovelluksiisi ja työprosesseihin
Nopeat toiminnot
API:n yleiskatsaus
REST API
Lyyli.ai tarjoaa RESTful API:n, joka tukee JSON-muotoisia pyyntöjä ja vastauksia. Kaikki API-kutsut vaativat autentikaation.
HTTPS
Suojattu
JSON
Muoto
OAuth 2.0
Autentikaatio
Autentikaatio
API-avaimet
API-avaimen hankkiminen:
- Kirjaudu tiliisi
- Mene kehittäjäasetuksiin
- Klikkaa 'Luo API-avain'
- Anna avaimelle nimi ja kuvaus
- Kopioi avain turvallisesti
Tärkeää:
API-avain on kuin salasana. Älä jaa sitä ja säilytä se turvallisesti. Jos avain vuotaa, poista se välittömästi.
Käyttö otsakkeissa
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json
Lisää Authorization-otsikko kaikkiin API-kutsuihin. API-avain tulee Bearer-tokenin muodossa.
API-päätepisteet
Perus-URL:
https://api.lyyli.ai/v1Avustajat
HallintaGET
/assistantsListaa avustajatPOST
/assistantsLuo avustajaPUT
/assistants/{id}Päivitä avustajaKeskustelut
ViestintäGET
/conversationsListaa keskustelutPOST
/conversations/{id}/messagesLähetä viestiAnalytiikka
TiedotGET
/analytics/usageKäyttötiedotGET
/analytics/performanceSuorituskykyKoodiesimerkit
JavaScript / Node.js
const response = await fetch('https://api.lyyli.ai/v1/assistants', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
});
const data = await response.json();
Python
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
response = requests.get(
'https://api.lyyli.ai/v1/assistants',
headers=headers
)
data = response.json()
cURL
curl -X GET \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
"https://api.lyyli.ai/v1/assistants"
Nopeusrajoitukset
Vapaa suunnitelma
- • 100 pyyntöä/tunti
- • Perusominaisuudet
- • Yhteisö-tuki
Pro-suunnitelma
- • 1000 pyyntöä/tunti
- • Kaikki ominaisuudet
- • Prioriteettituki
Nopeusrajoituksen hallinta:
Kun saavutat nopeusrajoituksen, API palauttaa 429-statuskoodin. Suosittelemme eksponentiaalista takaisinyritystä.
Virheiden käsittely
Yleisimmät HTTP-statuskoodit:
200OK
201Created
204No Content
400Bad Request
401Unauthorized
429Too Many Requests
Virheviestin rakenne:
{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded",
"retry_after": 3600
}
}
SDK:t ja kirjastot
Viralliset SDK:t
- JavaScript/Node.js
- Python
- PHP
Yhteisön kirjastot
- Ruby
- Go
- Java
Tarvitsetko lisäapua?
Jos sinulla on kysymyksiä API:n käytöstä tai tarvitset teknisen tukea, ota yhteyttä kehittäjätiimiimme.