# Omnillink > An open-source API that turns a URL into metadata, screenshots, PDFs, custom fields and readable content. Omnillink is an open-source (MIT), self-hostable HTTP API. Every endpoint is a GET under /api/v1, except the metadata batch. The OpenAPI 3.1 document at https://omnillink.kayzen-lyon.com/api/v1/openapi.json is the source of truth. ## Documentation - [API reference](https://omnillink.kayzen-lyon.com/en/docs): Complete reference of the Omnillink API: endpoints, parameters, example requests and responses, errors, authentication, rate limits and caching. - [Five-minute quick start](https://omnillink.kayzen-lyon.com/en/docs/quickstart): Your first call to the Omnillink API in five minutes: metadata, screenshot, readable content, error handling. - [Self-hosting](https://omnillink.kayzen-lyon.com/en/docs/self-hosting): Hosting Omnillink: Node.js locally or on a server, deployment on Vercel, environment variables, Redis and API keys. - [TypeScript SDK and the link-preview element](https://omnillink.kayzen-lyon.com/en/docs/sdk): The Omnillink TypeScript client, the element, the React component and the GitHub Action: installation, typed calls, a drop-in preview card. - [Omnillink for AI agents](https://omnillink.kayzen-lyon.com/en/docs/ai-agents): Giving a model the content of a web page: clean Markdown, numbered citations, hosted or local MCP server, llms.txt files. - [Recipes](https://omnillink.kayzen-lyon.com/en/docs/recipes): Four common integrations with Omnillink: link previews in a blog, share images, price monitoring, PDF archiving. - [Error codes](https://omnillink.kayzen-lyon.com/en/docs/errors): Every error code of the Omnillink API, with its HTTP status, its likely cause and how to fix it. - [Limits and quotas](https://omnillink.kayzen-lyon.com/en/docs/limits): Rates, sizes and durations applied by the Omnillink API, with the defaults and the variables that set them. - [Security](https://omnillink.kayzen-lyon.com/en/docs/security): The threat model of Omnillink: protection against SSRF attacks, what is covered, what is not, and how to report a vulnerability. - [Glossary](https://omnillink.kayzen-lyon.com/en/docs/glossary): The terms used in the Omnillink documentation: Open Graph, JSON-LD, oEmbed, SSRF, rendering, headless browser, TTL. - [Changelog](https://omnillink.kayzen-lyon.com/en/docs/changelog): New features and fixes in Omnillink, taken from the repository history: one line per shipped change, grouped by date. ## Documentation en français - [Référence de l’API](https://omnillink.kayzen-lyon.com/docs): Référence complète de l’API Omnillink : points d’accès, paramètres, exemples de requêtes et de réponses, erreurs, authentification, limites de débit et cache. - [Démarrage en cinq minutes](https://omnillink.kayzen-lyon.com/docs/quickstart): Premier appel à l’API Omnillink en cinq minutes : métadonnées, capture d’écran, contenu lisible, gestion des erreurs. - [Auto-hébergement](https://omnillink.kayzen-lyon.com/docs/self-hosting): Héberger Omnillink : Node.js en local ou sur un serveur, déploiement sur Vercel, variables d’environnement, Redis et clés d’API. - [SDK TypeScript et composant link-preview](https://omnillink.kayzen-lyon.com/docs/sdk): Le client TypeScript d’Omnillink, l’élément , le composant React et l’action GitHub : installation, appels typés, carte d’aperçu prête à poser. - [Omnillink pour les agents IA](https://omnillink.kayzen-lyon.com/docs/ai-agents): Donner à un modèle le contenu d’une page web : Markdown propre, citations numérotées, serveur MCP hébergé ou local, fichiers llms.txt. - [Recettes](https://omnillink.kayzen-lyon.com/docs/recipes): Quatre intégrations courantes avec Omnillink : aperçus de liens dans un blog, images de partage, veille de prix, archivage en PDF. - [Codes d’erreur](https://omnillink.kayzen-lyon.com/docs/errors): Tous les codes d’erreur de l’API Omnillink, avec leur statut HTTP, leur cause probable et la correction à apporter. - [Limites et quotas](https://omnillink.kayzen-lyon.com/docs/limits): Débits, tailles et durées appliqués par l’API Omnillink, avec les valeurs par défaut et les variables qui les règlent. - [Sécurité](https://omnillink.kayzen-lyon.com/docs/security): Le modèle de menace d’Omnillink : protection contre les attaques SSRF, ce qui est couvert, ce qui ne l’est pas, et comment signaler une faille. - [Glossaire](https://omnillink.kayzen-lyon.com/docs/glossary): Les termes employés dans la documentation d’Omnillink : Open Graph, JSON-LD, oEmbed, SSRF, rendu, navigateur sans interface, TTL. - [Journal des modifications](https://omnillink.kayzen-lyon.com/docs/changelog): Les nouveautés et les corrections d’Omnillink, tirées de l’historique du dépôt : une ligne par changement livré, regroupée par date. ## Optional - [Full text of the documentation](https://omnillink.kayzen-lyon.com/llms-full.txt) - [Playground](https://omnillink.kayzen-lyon.com/en/playground) - [Source code](https://github.com/kayzen-lyon/linkforge)