Five-minute quick start
One GET request, one URL as a parameter. This guide takes you from the first call to an integration that handles errors.
1. First call
No sign-up and no key are needed. Pass the address of the page in url, URL-encoded.
curl "https://omnillink.kayzen-lyon.com/api/v1/meta?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch"
The answer is a JSON envelope: status, the result in data, and meta, which says whether the answer came from the cache, which path read the page and how long it took.
2. In your 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);
Rely on body.code to handle an error: it is stable, whereas message is meant for humans. The full list is in Error codes.
3. A screenshot in a tag
/screenshot returns the image itself, so its address works directly in a src attribute.
<img src="https://omnillink.kayzen-lyon.com/api/v1/screenshot?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch&device=mobile" alt="example.com" />
4. Text for a model
/content returns the readable part of the page. With format=markdown, the answer is the Markdown itself, without a JSON envelope.
curl "https://omnillink.kayzen-lyon.com/api/v1/content?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch&format=markdown"
5. What next
- Try every parameter in the playground, which generates the matching code.
- Read the API reference for the details of parameters and responses.
- Check the limits and quotas before going to production.
- Host your own instance with the self-hosting guide.