Open an explainer page
One explainer page, written in English and in Italian, with its questions and answers.
/learn/{slug}- Access
- Public access
- Client
- Open as a page
Parameters#
| Name | Location | Meaning |
|---|---|---|
slugRequired | Path | The page: public-key-directory, veil-vs-keybase, veil-vs-keyoxide, veil-vs-pgp-keyservers, verify-a-discord-account, release-signing, for-organizations or for-communities. Any other slug is the 404 page. |
lang | Query | en or it. English is the default. |
Request examples#
curl -fsS 'https://veil.pub/learn/public-key-directory'Response#
A page with the article and its questions, in the language of the address, with an Article, a FAQPage and a BreadcrumbList in JSON-LD.
Response headers#
| Header | Value | Meaning |
|---|---|---|
Content-Type | text/html | Use the declared media type before choosing a parser. |
Date | HTTP date | Server time. Compare it with your clock when signing requests. |
Retry-After | integer seconds, on rate_limited or busy | Wait at least this long before retrying. Other 429/503 codes do not necessarily include it. |
Usage notes#
- An unknown slug answers 404 with the error page and noindex.
Errors#
API errors return an error object. Use error.code for program logic; error.message is English text for people and can change. Response and error guide
| HTTP | Code | Meaning and next step |
|---|---|---|
| 404 | not_found | No explainer page has this slug. A browser gets the HTML error page. Use a slug from GET /learn. |
Shared request errors
| HTTP | Code | Meaning and next step |
|---|---|---|
| 429 | rate_limited | An anonymous, signed-request or API-key allowance was exceeded. Wait at least |
| 500 | internal_error | An unexpected server error occurred. Internal details are not returned. Retry reads with bounded backoff. Check write results before sending a new signed operation. |
| 503 | busy | The application has reached a temporary concurrency or database limit. Wait |