{"revision":"0ed62d2c742f8e20","language":"en","entry":{"id":"preview-image","kind":"endpoint","group":"share","title":"Use Veil’s preview image","method":"GET","path":"/preview.png","paths":[],"summary":"Read the general directory preview image.","response":"A PNG for links to the directory or an empty verification page.","parameters":[{"name":"theme","description":"dark or light.","in":"query","required":false},{"name":"lang","description":"en or it. English is the default.","in":"query","required":false}],"sample":"/preview.png","access":"public","base":"directory","notes":[],"errors":["401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS 'https://veil.rip/preview.png'"}],"live":false,"responses":[{"status":200,"contentType":"image/png","description":"A PNG for links to the directory or an empty verification page.","fields":[]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":401,"code":"invalid_api_key","description":"The bearer credential is malformed, unknown, expired or revoked.","action":"Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.","scope":"optional-api-key"},{"status":403,"code":"api_key_scope","description":"The API key lacks read or verify scope, or the endpoint does not accept bearer keys.","action":"Use the correct scope. Identity writes and key management still require a device signature.","scope":"optional-api-key"},{"status":403,"code":"api_key_suspended","description":"This API key is suspended.","action":"Ask staff to restore it; another key cannot lift an account suspension.","scope":"optional-api-key"},{"status":403,"code":"developer_suspended","description":"The owner’s API account is suspended or the owner card is unavailable.","action":"Check the owner account and any staff restriction. Creating another key does not bypass suspension.","scope":"optional-api-key"},{"status":429,"code":"rate_limited","description":"An anonymous, signed-request or API-key allowance was exceeded.","action":"Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.","scope":"common"},{"status":500,"code":"internal_error","description":"An unexpected server error occurred. Internal details are not returned.","action":"Retry reads with bounded backoff. Check write results before sending a new signed operation.","scope":"common"},{"status":503,"code":"busy","description":"The application has reached a temporary concurrency or database limit.","action":"Wait `Retry-After` seconds and retry with bounded backoff.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"image/png","description":"Use the declared media type before choosing a parser."},{"name":"Date","value":"HTTP date","description":"Server time. Compare it with your clock when signing requests."},{"name":"Cache-Control","value":"public, max-age=300","description":"Server-rendered previews may be cached for five minutes."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Wait at least this long before retrying. Other 429/503 codes do not necessarily include it."}],"documentationUrl":"https://veil.rip/docs/preview-image","supportsBrowserFetch":true,"browserMode":"fetch"}}