{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["api-container","api-content","endpoint","api-examples","tabs","tab","code-group"]},"redocly_category":"API Reference","searchWeight":120,"type":"markdown"},"seo":{"title":"Fetch a recipient-bound encrypted area","description":"Complete API reference and documentation for Freddy AI-powered backend system by Aitronos","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"fetch-a-recipient-bound-encrypted-area","__idx":0},"children":["Fetch a recipient-bound encrypted area"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the ciphertext and public decryption parameters for an encrypted area sealed to the"," ","authenticated recipient. The response never contains a key the server can use or any plaintext —"," ","your client unwraps the wrapped key with your own private key and decrypts on-device."]},{"$$mdtype":"Tag","name":"ApiContainer","attributes":{},"children":[{"$$mdtype":"Tag","name":"ApiContent","attributes":{},"children":[{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"GET","path":"https://api.aitronos.com/v1/encrypted-areas/{encbin_id}"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Refuses areas that have expired or, for burn-after-read areas, that were already opened."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This GET is a safe, repeatable ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["peek"]},". For a burn-after-read area it deliberately"," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["withholds"]}," the ciphertext (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blob"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requires_open"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},") so an"," ","automated request — a browser prefetch, a link preview, or a scanner — can never destroy"," ","it. To actually open (and consume) a burn-after-read area, send an explicit"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#open-a-recipient-bound-encrypted-area"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/encrypted-areas/{encbin_id}/open"]}]}," on a"," ","real user action. A non-burn area returns its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blob"]}," directly from this GET."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"path-parameters","__idx":1},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encbin_id"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#ef4444 !important","fontWeight":"600 !important","fontStyle":"normal !important"}},"children":["required"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The encrypted-area id (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encbin_"]},"-prefixed) from the message token."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"returns","__idx":2},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An encrypted-area fetch view."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encbin_id"]}]}," string · The area id."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["audience"]}]}," string · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user"]}," for a recipient-bound area."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["crypto_mode"]}]}," string · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recipient_bound"]}," — selects which parameters block is populated."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format_version"]}]}," string · The sealing format version."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blob"]}]}," object · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ciphertext_b64"]}," (base64 ciphertext) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["content_kind"]},", which is always"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["file"]}," on this endpoint — a recipient-bound seal accepts binary payloads and does not report an"," ","inline-text kind. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," on a GET peek of a burn-after-read area (open it with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST .../open"]},")."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requires_open"]}]}," boolean · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," on a GET peek of a burn-after-read area, meaning the"," ","ciphertext was withheld and you must ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST .../open"]}," to receive it. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," otherwise."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recipient_bound"]}]}," object · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wrapped_dek"]}," (the wrapped data-encryption key you unwrap with"," ","your private key — the server cannot open it), plus the public parameters needed to open the"," ","content. Present only for recipient-bound areas."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["external"]}]}," object · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," for recipient-bound areas."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}]}," string · Expiry timestamp (UTC) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["burn_after_read"]}]}," boolean · Whether the area self-destructs on first open."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["password_required"]}]}," boolean · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," for recipient-bound areas."]}]},{"$$mdtype":"Tag","name":"ApiExamples","attributes":{},"children":[{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeGroup","attributes":{"mode":"dropdown"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"cURL","header":{"title":"cURL","controls":{"copy":{}}},"source":"curl \"https://api.aitronos.com/v1/encrypted-areas/encbin_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\" \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","data-title":"Python SDK","header":{"title":"Python SDK","controls":{"copy":{}}},"source":"# pip install aitronos-sdk\n#\n# The Python SDK does not expose a typed `encrypted_areas` namespace yet, and it\n# has no generic request method, so call the endpoint directly with the same\n# credential you would pass to `Aitronos(...)` — an API key or a bearer token,\n# both sent as `Authorization: Bearer <value>`.\nimport httpx\n\nAPI_KEY = \"your-api-key\"\n\narea = httpx.get(\n    \"https://api.aitronos.com/v1/encrypted-areas/encbin_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n    headers={\"Authorization\": f\"Bearer {API_KEY}\"},\n).json()\n# Unwrap area[\"recipient_bound\"][\"wrapped_dek\"] with your private key, then decrypt on-device.\nprint(area[\"blob\"][\"content_kind\"], area[\"burn_after_read\"])\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","data-title":"Python","header":{"title":"Python","controls":{"copy":{}}},"source":"import requests\n\nresp = requests.get(\n    \"https://api.aitronos.com/v1/encrypted-areas/encbin_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n    headers={\"Authorization\": f\"Bearer {access_token}\"},\n)\narea = resp.json()\nprint(area[\"audience\"], area[\"crypto_mode\"])\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","data-title":"JavaScript","header":{"title":"JavaScript","controls":{"copy":{}}},"source":"const resp = await fetch(\n  'https://api.aitronos.com/v1/encrypted-areas/encbin_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6',\n  { headers: { Authorization: `Bearer ${accessToken}` } }\n);\nconst area = await resp.json();\nconsole.log(area.audience, area.burn_after_read);\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"200 OK","header":{"title":"200 OK","controls":{"copy":{}}},"source":"{\n  \"encbin_id\": \"encbin_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\",\n  \"audience\": \"user\",\n  \"crypto_mode\": \"recipient_bound\",\n  \"format_version\": \"rb1\",\n  \"blob\": { \"ciphertext_b64\": \"k9Xa...==\", \"content_kind\": \"file\" },\n  \"requires_open\": false,\n  \"recipient_bound\": {\n    \"wrapped_dek\": { \"v\": \"1\", \"aead\": \"aes-256-gcm\", \"nonce\": \"b64...\", \"ct\": \"b64...\", \"epk\": \"b64...\" },\n    \"aead\": \"aes-256-gcm\",\n    \"nonce_b64\": \"3n5f8c2a1b7d9e0f4a6c8b1d\",\n    \"sender_binding\": \"c2VuZGVyOnVzcl8xMjM=\"\n  },\n  \"external\": null,\n  \"expires_at\": \"2026-07-30T09:00:00Z\",\n  \"burn_after_read\": false,\n  \"password_required\": false\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Errors","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"403 Not Authorized","header":{"title":"403 Not Authorized","controls":{"copy":{}}},"source":"{ \"success\": false, \"error\": { \"code\": \"ENCRYPTED_AREA_NOT_AUTHORIZED\", \"message\": \"You are not authorized to open this encrypted area.\", \"system_message\": \"Not the bound recipient of this encrypted area\", \"type\": \"authorization_error\", \"status\": 403, \"details\": { \"encbin_id\": \"encbin_...\" }, \"trace_id\": \"...\", \"timestamp\": \"...\" } }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"404 Not Found","header":{"title":"404 Not Found","controls":{"copy":{}}},"source":"{ \"success\": false, \"error\": { \"code\": \"ENCRYPTED_AREA_NOT_FOUND\", \"message\": \"Encrypted area not found.\", \"system_message\": \"Encrypted area not found\", \"type\": \"client_error\", \"status\": 404, \"details\": { \"encbin_id\": \"encbin_...\" }, \"trace_id\": \"...\", \"timestamp\": \"...\" } }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"410 Expired","header":{"title":"410 Expired","controls":{"copy":{}}},"source":"{ \"success\": false, \"error\": { \"code\": \"ENCRYPTED_AREA_EXPIRED\", \"message\": \"This encrypted area has expired and can no longer be opened.\", \"system_message\": \"This encrypted area has expired\", \"type\": \"client_error\", \"status\": 410, \"details\": { \"encbin_id\": \"encbin_...\" }, \"trace_id\": \"...\", \"timestamp\": \"...\" } }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"410 Already opened","header":{"title":"410 Already opened","controls":{"copy":{}}},"source":"{ \"success\": false, \"error\": { \"code\": \"ENCRYPTED_AREA_BURNED\", \"message\": \"This encrypted area was already opened and destroyed.\", \"system_message\": \"This encrypted area was already opened and destroyed\", \"type\": \"client_error\", \"status\": 410, \"details\": { \"encbin_id\": \"encbin_...\" }, \"trace_id\": \"...\", \"timestamp\": \"...\" } }\n","lang":"json"},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"open-a-recipient-bound-encrypted-area","__idx":3},"children":["Open a recipient-bound encrypted area"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The non-idempotent counterpart of the fetch above. Use it to open (and, for"," ","burn-after-read areas, consume) an area — call it only on an explicit user action, never on"," ","page load. The response body is identical to a successful fetch, always with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blob"]}," present"," ","and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requires_open"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},". For a burn-after-read area, the first call returns the"," ","ciphertext and destroys the area; a second call returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["410 ENCRYPTED_AREA_BURNED"]},"."]},{"$$mdtype":"Tag","name":"ApiContainer","attributes":{},"children":[{"$$mdtype":"Tag","name":"ApiContent","attributes":{},"children":[{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"POST","path":"https://api.aitronos.com/v1/encrypted-areas/{encbin_id}/open"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"path-parameters-1","__idx":4},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encbin_id"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#ef4444 !important","fontWeight":"600 !important","fontStyle":"normal !important"}},"children":["required"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The encrypted-area id (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["encbin_"]},"-prefixed)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"returns-1","__idx":5},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The same encrypted-area fetch view as the GET, with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blob"]}," always present and"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requires_open"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"ApiExamples","attributes":{},"children":[{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"cURL","header":{"title":"cURL","controls":{"copy":{}}},"source":"curl -X POST \"https://api.aitronos.com/v1/encrypted-areas/encbin_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/open\" \\\n  -H \"Authorization: Bearer $ACCESS_TOKEN\"\n","lang":"bash"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Errors","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"410 Already opened","header":{"title":"410 Already opened","controls":{"copy":{}}},"source":"{ \"success\": false, \"error\": { \"code\": \"ENCRYPTED_AREA_BURNED\", \"message\": \"This encrypted area was already opened and destroyed.\", \"system_message\": \"This encrypted area was already opened and destroyed\", \"type\": \"client_error\", \"status\": 410, \"details\": { \"encbin_id\": \"encbin_...\" }, \"trace_id\": \"...\", \"timestamp\": \"...\" } }\n","lang":"json"},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-resources","__idx":6},"children":["Related resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/encrypted-areas/create"},"children":["Create an encrypted area"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/encrypted-areas/fetch-secure-link"},"children":["Fetch a secure-link encrypted area"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/encrypted-areas/introduction"},"children":["Encrypted areas overview"]}]}]}]},"headings":[{"value":"Fetch a recipient-bound encrypted area","id":"fetch-a-recipient-bound-encrypted-area","depth":1},{"value":"Path parameters","id":"path-parameters","depth":2},{"value":"Returns","id":"returns","depth":2},{"value":"Open a recipient-bound encrypted area","id":"open-a-recipient-bound-encrypted-area","depth":2},{"value":"Path parameters","id":"path-parameters-1","depth":2},{"value":"Returns","id":"returns-1","depth":2},{"value":"Related resources","id":"related-resources","depth":2}],"frontmatter":{"title":"Fetch a recipient-bound encrypted area","keywords":["encrypted area","recipient bound","decrypt"],"seo":{"title":"Fetch a recipient-bound encrypted area"}},"lastModified":"2026-10-26T18:32:31.568Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference/encrypted-areas/fetch-recipient-bound","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}