A share link is a public, read-only snapshot of a tool result. The SEO check is the only tool that can be shared today.
Create a link
curl -X POST https://api.ferrlens.com/v1/shares \
-H 'content-type: application/json' \
-d '{"kind":"seo","input":{"url":"https://example.com"},"result":{}}'
| Field | Type | Notes |
|---|---|---|
kind |
string | Must be seo. Anything else returns INVALID_KIND. |
input |
JSON | What was submitted. At most 16 KiB serialized (INPUT_TOO_LARGE). |
result |
JSON | The result being published. At most 128 KiB serialized (RESULT_TOO_LARGE). |
The response:
{
"id": "7K2M9QXH4D1V",
"url": "https://ferrlens.com/share/7K2M9QXH4D1V",
"expires_at": "2027-01-18T10:00:00Z",
"revoke_token": "..."
}
Creating a link publishes the data at that URL. The tool's page asks for confirmation first; if you call the endpoint yourself, that decision is yours.
The id is 12 random characters, so a link cannot be guessed. The snapshot stores the input and the result, both public data. It does not store your IP address or user agent.
How long it lives
Links created anonymously expire after 90 days. expires_at in the response is the exact
time. After that the link returns 404, same as a revoked or unknown id.
Fetch a snapshot
curl https://api.ferrlens.com/v1/shares/7K2M9QXH4D1V
Returns id, kind, input, result, created_at and expires_at.
Revoke a link
The revoke_token is returned once, at creation. Keep it: it is the only way to take the link
down, and it is stored hashed.
curl -X DELETE https://api.ferrlens.com/v1/shares/7K2M9QXH4D1V \
-H 'x-revoke-token: <revoke_token>'
| Status | Meaning |
|---|---|
204 |
Revoked. The link now returns 404. |
403 |
Missing or wrong token (REVOKE_FORBIDDEN). |
404 |
No such share, or already revoked. |
With an account
Shares that do not expire are planned for accounts but not shipped. Today every link, signed in or not, follows the 90-day rule.