Démarrage en cinq minutes
Une requête GET, une URL en paramètre. Ce guide vous mène du premier appel à une intégration qui gère les erreurs.
1. Premier appel
Aucune inscription ni clé n’est nécessaire. Passez l’adresse de la page dans url, encodée pour une URL.
curl "https://omnillink.kayzen-lyon.com/api/v1/meta?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch"
La réponse est une enveloppe JSON : status, le résultat dans data, et meta qui dit si la réponse vient du cache, par quel chemin la page a été lue et en combien de temps.
2. Dans votre code
const params = new URLSearchParams({ url: "https://example.com/blog/launch" });
const response = await fetch(`https://omnillink.kayzen-lyon.com/api/v1/meta?${params}`);
const body = await response.json();
if (body.status !== "success") {
throw new Error(`${body.code}: ${body.message}`);
}
console.log(body.data.title, body.data.image?.url);
Appuyez-vous sur body.code pour traiter une erreur : il est stable, alors que message est destiné aux humains. La liste complète est dans Codes d’erreur.
3. Une capture dans une balise
/screenshot renvoie l’image elle-même. Son adresse fonctionne donc directement dans un attribut src.
<img src="https://omnillink.kayzen-lyon.com/api/v1/screenshot?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch&device=mobile" alt="example.com" />
4. Du texte pour un modèle
/content renvoie la partie lisible de la page. Avec format=markdown, la réponse est le Markdown lui-même, sans enveloppe JSON.
curl "https://omnillink.kayzen-lyon.com/api/v1/content?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch&format=markdown"
5. Et ensuite
- Essayez chaque paramètre dans le bac à sable, qui génère le code correspondant.
- Lisez la référence de l’API pour le détail des paramètres et des réponses.
- Vérifiez les limites et quotas avant de passer en production.
- Hébergez votre propre instance avec le guide d’auto-hébergement.