ENTITY developer reference
Release compatibility and binding
Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.
Read the release as one set
Use matching capabilities, OpenAPI, field dictionary, error catalogue, examples and binding information. A generic candidate is a reading reference, not evidence of a hosted release, enabled source or workspace entitlement.
Retain the exact profile_id, its separately pinned revision and the contract_binding. Follow the release’s immutable public bundle location and verify each artifact using its declared representation. These pages do not supply a released bundle or bind a live endpoint.
Compare the right hashes
Raw source-file bytes, generic canonical JSON and compiled-profile canonical JSON are different representations. Do not compare a compiled-profile hash with an uncompiled template file hash. Use the exact canonical-content bytes and hash convention supplied by the release; do not silently substitute another JSON canonicalisation scheme.
A missing artifact, unknown binding or hash mismatch stops new work. Do not fall back to a client generator’s bundled schema or guess a replacement endpoint. Re-read capabilities and validate replacement artifacts only through the supported compatibility path.
Preserve values and semantic constraints
Keep wire strings, identifier leading zeroes, exact decimal unit strings, conditional fields and errors. Generated typed models must preserve the actual JSON mapping and pass both positive and adverse cases. Schema validity alone does not prove authentication, matching, accounting, source rights or provider access.
Where input limits require decoded Unicode code points, UTF-16 code-unit counts are not equivalent. Respect aggregate input bounds as well as individual field constraints; silently truncating or normalising input is not a substitute for the required validation.
Retain the original recovery contract
An unresolved operation keeps its original key, creation time and compatible recovery contract. Retained results and receipts keep their own generation and rights. Upgrading a client does not make old receipts interchangeable or restore withdrawn rights.
Review release notes for meaningful changes to coverage, rights, confidence, charging and recovery as well as JSON shape. Do not assume a smaller profile can replace a profile still needed for retained references.
Candidate wording discrepancy
The retained template describes Entity-Service-Profile as a revision; the current guide specifies the accepted profile_id, with a separate immutable revision. This explanation does not repair the contract artifact. The released generated artifacts must reconcile that wording before they are treated as a consistent integration bundle.
Next: API collection guidance, MCP guidance or the supported-release guide.
Downloads and offline inspection
Check release-material availability and inspect the original offline bundle verifiers. TypeScript, Python and Elixir source downloads are candidate examples with checks pending. They do not provide a released bundle, executable collection, authenticated starter or permission to make requests.