Sustema

ENTITY developer reference

Page

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.

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.

next_cursor

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for next_cursor
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max",
      "maxLength": 4096
    },
    {
      "type": "null"
    }
  ]
}

returned

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for returned
{
  "type": "integer",
  "minimum": 0
}

generation

Listed in this schema’s required array.

Declared type
"string"
Reading definition for generation
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

expires_at

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for expires_at
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

completeness

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for completeness
{
  "$ref": "#/components/schemas/Completeness"
}

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": {
    "next_cursor": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max",
          "maxLength": 4096
        },
        {
          "type": "null"
        }
      ]
    },
    "returned": {
      "type": "integer",
      "minimum": 0
    },
    "generation": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "expires_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "completeness": {
      "$ref": "#/components/schemas/Completeness"
    }
  },
  "required": [
    "next_cursor",
    "returned",
    "generation",
    "expires_at",
    "completeness"
  ],
  "additionalProperties": false
}

Related schemas

All API operations