Sustema

ENTITY developer reference

SearchRequest

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.

Bounds come from the accepted service profile. Request bodies/cursors are not logged. Search is candidate discovery.

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.

reference

Listed in this schema’s required array.

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

page_size

Not listed in this schema’s required array.

Declared type
"integer"
Reading definition for page_size
{
  "type": "integer",
  "minimum": 1,
  "x-profile-maximum": "page_size_max",
  "x-additional-profile-maximum": "candidate_count_max"
}

cursor

Not listed in this schema’s required array.

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

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": {
    "reference": {
      "$ref": "#/components/schemas/InputReference"
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "x-profile-maximum": "page_size_max",
      "x-additional-profile-maximum": "candidate_count_max"
    },
    "cursor": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max",
      "maxLength": 4096
    }
  },
  "required": [
    "reference"
  ],
  "additionalProperties": false,
  "description": "Bounds come from the accepted service profile. Request bodies/cursors are not logged. Search is candidate discovery."
}

Related schemas

All API operations