ENTITY developer reference
Meta
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.
This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.
This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.
Bounded response metadata. Precommit encoding reserves the maximum permitted metadata and actual adapter envelope; no later hook may append unreserved warnings or fields.
Declared type: "object"
Declared fields
This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.
request_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for request_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}served_at
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"date-time"
Reading definition for served_at
{
"type": "string",
"format": "date-time",
"maxLength": 35,
"x-profile-maxLength": "string_characters_max"
}profile_revision
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for profile_revision
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
}synthetic
Listed in this schema’s required array.
- Declared type
"boolean"
Reading definition for synthetic
{
"type": "boolean"
}replayed
Listed in this schema’s required array.
- Declared type
"boolean"
Reading definition for replayed
{
"type": "boolean"
}warnings
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for warnings
{
"type": "array",
"items": {
"type": "string",
"maxLength": 400,
"x-profile-maxLength": "string_characters_max"
},
"maxItems": 16,
"x-profile-maxItems": "collection_items_max"
}source_attributions
Not listed in this schema’s required array.
Required whenever the delivered information has an applicable attribution condition; absent/empty only when no such information is supplied. Include every required credit, never truncate for size. Count actual immutable credits in admission; rights-denied/opaque errors disclose none.
- Declared type
"array"
Reading definition for source_attributions
{
"type": "array",
"maxItems": 100000,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/SourceAttribution"
},
"description": "Required whenever the delivered information has an applicable attribution condition; absent/empty only when no such information is supplied. Include every required credit, never truncate for size. Count actual immutable credits in admission; rights-denied/opaque errors disclose none.",
"x-profile-maxItems": "json_nodes_max"
}Schema reading view
Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.
{
"type": "object",
"properties": {
"request_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"served_at": {
"type": "string",
"format": "date-time",
"maxLength": 35,
"x-profile-maxLength": "string_characters_max"
},
"profile_revision": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
"synthetic": {
"type": "boolean"
},
"replayed": {
"type": "boolean"
},
"warnings": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400,
"x-profile-maxLength": "string_characters_max"
},
"maxItems": 16,
"x-profile-maxItems": "collection_items_max"
},
"source_attributions": {
"type": "array",
"maxItems": 100000,
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/SourceAttribution"
},
"description": "Required whenever the delivered information has an applicable attribution condition; absent/empty only when no such information is supplied. Include every required credit, never truncate for size. Count actual immutable credits in admission; rights-denied/opaque errors disclose none.",
"x-profile-maxItems": "json_nodes_max"
}
},
"required": [
"request_id",
"served_at",
"profile_revision",
"synthetic",
"replayed",
"warnings"
],
"additionalProperties": false,
"description": "Bounded response metadata. Precommit encoding reserves the maximum permitted metadata and actual adapter envelope; no later hook may append unreserved warnings or fields."
}