Skip to content

HTTP models: LabelSelectorOperator – PersistedEventSideEffectInspection

Exact OpenAPI component declarations. $ref values identify other components in the complete schema.

LabelSelectorOperator

Section titled “LabelSelectorOperator”
{
  "type": "string",
  "enum": [
    "exists",
    "not_exists",
    "in",
    "not_in"
  ],
  "title": "LabelSelectorOperator"
}

LabelSelectorRequirement

Section titled “LabelSelectorRequirement”
{
  "properties": {
    "key": {
      "type": "string",
      "title": "Key"
    },
    "operator": {
      "$ref": "#/components/schemas/LabelSelectorOperator"
    },
    "values": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Values"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "key",
    "operator"
  ],
  "title": "LabelSelectorRequirement"
}

ListSessionEventsResponse

Section titled “ListSessionEventsResponse”
{
  "properties": {
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "events": {
      "items": {
        "$ref": "#/components/schemas/ApiEventRecord"
      },
      "type": "array",
      "title": "Events"
    },
    "order_by": {
      "type": "string",
      "enum": [
        "sequence_asc",
        "sequence_desc"
      ],
      "title": "Order By",
      "description": "Ordering applied to the returned event page."
    },
    "next_sequence": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Sequence",
      "description": "Exclusive sequence cursor for the next page in the returned order: pass it as after_sequence for ascending pages or before_sequence for descending pages."
    },
    "scan_through_sequence": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Scan Through Sequence",
      "description": "Highest durable sequence that a forward tail reader can safely pass as after_sequence. This can be newer than next_sequence when filters exclude events."
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "session_id",
    "events",
    "order_by",
    "scan_through_sequence",
    "has_more"
  ],
  "title": "ListSessionEventsResponse"
}

ListSessionInteractionsResponse

Section titled “ListSessionInteractionsResponse”
{
  "properties": {
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "interactions": {
      "items": {
        "$ref": "#/components/schemas/ApiInteractionSummary"
      },
      "type": "array",
      "title": "Interactions"
    },
    "next_sequence": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Sequence"
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "session_id",
    "interactions",
    "next_sequence",
    "has_more"
  ],
  "title": "ListSessionInteractionsResponse"
}

ListSessionsResponse

Section titled “ListSessionsResponse”
{
  "properties": {
    "sessions": {
      "items": {
        "$ref": "#/components/schemas/ApiSessionBase"
      },
      "type": "array",
      "title": "Sessions"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Cursor"
    },
    "total_count": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Count"
    },
    "usage": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/components/schemas/SessionUsageSummary"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Usage",
      "description": "Present only for `include=usage`: one exact usage summary per listed session, in the same order as `sessions`."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "sessions",
    "next_cursor"
  ],
  "title": "ListSessionsResponse"
}

Message

Section titled “Message”
{
  "properties": {
    "role": {
      "$ref": "#/components/schemas/MessageRole"
    },
    "content": {
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/TextPart"
          },
          {
            "$ref": "#/components/schemas/ToolCallPart"
          },
          {
            "$ref": "#/components/schemas/ToolResultPart"
          },
          {
            "$ref": "#/components/schemas/ProviderStatePart"
          },
          {
            "$ref": "#/components/schemas/ThinkingPart"
          },
          {
            "$ref": "#/components/schemas/FilePart"
          },
          {
            "$ref": "#/components/schemas/HostedToolCallPart"
          },
          {
            "$ref": "#/components/schemas/CitationPart"
          },
          {
            "$ref": "#/components/schemas/PeerContentPart"
          }
        ]
      },
      "type": "array",
      "title": "Content",
      "default": []
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "role"
  ],
  "title": "Message",
  "description": "Frozen transcript message.\n\nMessages and their parts are immutable once constructed: attribute\nassignment is rejected, `content` is a tuple, and every part entering the\nmessage is copied so the message exclusively owns its JSON payloads. The\nfreeze is shallow, though \u2014 nested payload dicts stay mutable \u2014 so sharing\na validated instance is safe only while every holder treats payloads as\nread-only. Hot-path `copy_message` \"copies\" are no-ops under that\ncontract; `detach_message` produces a genuinely isolated copy for\nstorage/trust boundaries, and `copy.deepcopy` isolates as well."
}

MessageRole

Section titled “MessageRole”
{
  "type": "string",
  "enum": [
    "user",
    "assistant",
    "system",
    "tool"
  ],
  "title": "MessageRole"
}

ModelFailoverPolicy

Section titled “ModelFailoverPolicy”
{
  "properties": {
    "fallbacks": {
      "items": {
        "$ref": "#/components/schemas/ModelTarget"
      },
      "type": "array",
      "maxItems": 7,
      "minItems": 1,
      "title": "Fallbacks"
    },
    "max_total_attempts": {
      "type": "integer",
      "maximum": 80.0,
      "minimum": 1.0,
      "title": "Max Total Attempts",
      "default": 20
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "fallbacks"
  ],
  "title": "ModelFailoverPolicy",
  "description": "Bounded, explicit alternatives after an eligible ordinary model failure.\n\nThe primary target is resolved by the run entrance. ``max_total_attempts``\nincludes that primary's attempts and all same-provider retries, not just\ntransitions between targets. This value never authorizes dispatch itself."
}

ModelPrice

Section titled “ModelPrice”
{
  "properties": {
    "provider_name": {
      "type": "string",
      "title": "Provider Name"
    },
    "model": {
      "type": "string",
      "title": "Model"
    },
    "aliases": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Aliases",
      "default": []
    },
    "match": {
      "type": "string",
      "enum": [
        "exact",
        "prefix"
      ],
      "title": "Match",
      "default": "prefix"
    },
    "match_prefixes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Match Prefixes",
      "default": []
    },
    "pricing_context": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PricingContextSelector"
        },
        {
          "type": "null"
        }
      ]
    },
    "cache_write_ttls": {
      "items": {
        "type": "string",
        "enum": [
          "5m",
          "1h"
        ]
      },
      "type": "array",
      "title": "Cache Write Ttls",
      "default": []
    },
    "schedules": {
      "items": {
        "$ref": "#/components/schemas/PriceSchedule"
      },
      "type": "array",
      "minItems": 1,
      "title": "Schedules"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "provider_name",
    "model",
    "schedules"
  ],
  "title": "ModelPrice",
  "description": "Pricing identity and its non-overlapping effective schedules."
}

ModelTarget

Section titled “ModelTarget”
{
  "properties": {
    "provider_name": {
      "type": "string",
      "title": "Provider Name"
    },
    "model": {
      "type": "string",
      "title": "Model"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "provider_name",
    "model"
  ],
  "title": "ModelTarget",
  "description": "An application-selected provider and model pair for one session epoch."
}

OperationalSnapshotRequest

Section titled “OperationalSnapshotRequest”
{
  "properties": {
    "session_filter": {
      "$ref": "#/components/schemas/SessionAggregateFilter"
    },
    "task_filter": {
      "$ref": "#/components/schemas/TaskAggregateFilter"
    },
    "include_tasks": {
      "type": "boolean",
      "title": "Include Tasks",
      "default": true
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "OperationalSnapshotRequest"
}

OperationalSnapshotResponse

Section titled “OperationalSnapshotResponse”
{
  "properties": {
    "scope": {
      "type": "string",
      "const": "configured_stores",
      "title": "Scope"
    },
    "cross_store_atomic": {
      "type": "boolean",
      "const": false,
      "title": "Cross Store Atomic"
    },
    "sessions": {
      "$ref": "#/components/schemas/SessionOperationalSnapshot"
    },
    "task_snapshot_status": {
      "type": "string",
      "enum": [
        "available",
        "not_requested",
        "not_configured",
        "unsupported"
      ],
      "title": "Task Snapshot Status"
    },
    "tasks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/TaskOperationalSnapshot"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "scope",
    "cross_store_atomic",
    "sessions",
    "task_snapshot_status",
    "tasks"
  ],
  "title": "OperationalSnapshotResponse"
}

OptionalSurfaceCapability

Section titled “OptionalSurfaceCapability”
{
  "properties": {
    "configured": {
      "type": "boolean",
      "title": "Configured"
    },
    "read": {
      "$ref": "#/components/schemas/CapabilityOperation"
    },
    "mutate": {
      "$ref": "#/components/schemas/CapabilityOperation"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "configured",
    "read",
    "mutate"
  ],
  "title": "OptionalSurfaceCapability",
  "description": "Configuration and operation availability for one optional surface."
}

PeerContentPart

Section titled “PeerContentPart”
{
  "properties": {
    "type": {
      "type": "string",
      "const": "peer_content",
      "title": "Type",
      "default": "peer_content"
    },
    "text": {
      "type": "string",
      "maxLength": 131072,
      "title": "Text"
    },
    "sender_participant_id": {
      "type": "string",
      "maxLength": 512,
      "title": "Sender Participant Id"
    },
    "sender_participant_incarnation": {
      "type": "string",
      "maxLength": 512,
      "title": "Sender Participant Incarnation"
    },
    "sender_session_id": {
      "type": "string",
      "maxLength": 512,
      "title": "Sender Session Id"
    },
    "sender_session_instance_id": {
      "type": "string",
      "maxLength": 512,
      "title": "Sender Session Instance Id"
    },
    "occurrence_id": {
      "type": "string",
      "maxLength": 512,
      "title": "Occurrence Id"
    },
    "append_key_json": {
      "type": "string",
      "maxLength": 16384,
      "title": "Append Key Json"
    },
    "operation_key": {
      "type": "string",
      "maxLength": 512,
      "title": "Operation Key"
    },
    "projection_id": {
      "type": "string",
      "maxLength": 256,
      "title": "Projection Id"
    },
    "provenance_sha256": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$",
      "title": "Provenance Sha256"
    },
    "executable": {
      "type": "boolean",
      "const": false,
      "title": "Executable",
      "default": false
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "text",
    "sender_participant_id",
    "sender_participant_incarnation",
    "sender_session_id",
    "sender_session_instance_id",
    "occurrence_id",
    "append_key_json",
    "operation_key",
    "projection_id",
    "provenance_sha256"
  ],
  "title": "PeerContentPart",
  "description": "Attributed, non-executable content delivered by another participant."
}

PendingActionKind

Section titled “PendingActionKind”
{
  "type": "string",
  "enum": [
    "tool_approval",
    "user_input",
    "manual_recovery",
    "delegated_action"
  ],
  "title": "PendingActionKind"
}

PendingActionsResponse

Section titled “PendingActionsResponse”
{
  "properties": {
    "actions": {
      "items": {
        "$ref": "#/components/schemas/ApiPendingAction"
      },
      "type": "array",
      "title": "Actions"
    },
    "issues": {
      "items": {
        "$ref": "#/components/schemas/ApiPendingActionIssue"
      },
      "type": "array",
      "title": "Issues"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Cursor"
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More"
    },
    "total_count": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Count"
    },
    "inspected_candidate_count": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Inspected Candidate Count"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "actions",
    "issues",
    "next_cursor",
    "has_more",
    "total_count",
    "inspected_candidate_count"
  ],
  "title": "PendingActionsResponse"
}

PendingKnowledgeDetailResponse

Section titled “PendingKnowledgeDetailResponse”
{
  "properties": {
    "entry_id": {
      "type": "string",
      "title": "Entry Id"
    },
    "revision": {
      "type": "integer",
      "maximum": 2147483647.0,
      "minimum": 1.0,
      "title": "Revision"
    },
    "namespace": {
      "type": "string",
      "title": "Namespace"
    },
    "kind": {
      "type": "string",
      "title": "Kind"
    },
    "visibility": {
      "type": "string",
      "title": "Visibility"
    },
    "status": {
      "type": "string",
      "title": "Status"
    },
    "title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Title"
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Labels"
    },
    "aspects": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Aspects"
    },
    "impact_targets": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Impact Targets"
    },
    "source_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Type"
    },
    "source_uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Uri"
    },
    "source_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Id"
    },
    "created_by_type": {
      "type": "string",
      "title": "Created By Type"
    },
    "created_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By"
    },
    "created_at": {
      "type": "string",
      "title": "Created At"
    },
    "updated_at": {
      "type": "string",
      "title": "Updated At"
    },
    "importance": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
        },
        {
          "type": "null"
        }
      ],
      "title": "Importance"
    },
    "importance_source": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Importance Source"
    },
    "confidence": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
        },
        {
          "type": "null"
        }
      ],
      "title": "Confidence"
    },
    "text": {
      "type": "string",
      "title": "Text"
    },
    "metadata": {
      "additionalProperties": true,
      "type": "object",
      "title": "Metadata"
    },
    "expires_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "chunks": {
      "items": {
        "$ref": "#/components/schemas/ApiKnowledgeChunk"
      },
      "type": "array",
      "title": "Chunks"
    },
    "chunk_limit": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Chunk Limit"
    },
    "chunk_max_bytes": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Chunk Max Bytes"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "entry_id",
    "revision",
    "namespace",
    "kind",
    "visibility",
    "status",
    "title",
    "labels",
    "aspects",
    "impact_targets",
    "source_type",
    "source_uri",
    "source_id",
    "created_by_type",
    "created_by",
    "created_at",
    "updated_at",
    "importance",
    "importance_source",
    "confidence",
    "text",
    "metadata",
    "expires_at",
    "chunks",
    "chunk_limit",
    "chunk_max_bytes"
  ],
  "title": "PendingKnowledgeDetailResponse"
}

PendingKnowledgeListResponse

Section titled “PendingKnowledgeListResponse”
{
  "properties": {
    "entries": {
      "items": {
        "$ref": "#/components/schemas/ApiKnowledgeListItem"
      },
      "type": "array",
      "title": "Entries"
    },
    "truncated": {
      "type": "boolean",
      "title": "Truncated"
    },
    "limit": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Limit"
    },
    "max_bytes": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Max Bytes"
    },
    "total_entries_known": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Total Entries Known"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "entries",
    "truncated",
    "limit",
    "max_bytes",
    "total_entries_known"
  ],
  "title": "PendingKnowledgeListResponse"
}

PersistedEventSideEffectHealth

Section titled “PersistedEventSideEffectHealth”
{
  "properties": {
    "observed_at": {
      "type": "string",
      "format": "date-time",
      "title": "Observed At"
    },
    "pending": {
      "type": "integer",
      "title": "Pending",
      "default": 0
    },
    "leased_live": {
      "type": "integer",
      "title": "Leased Live",
      "default": 0
    },
    "leased_expired": {
      "type": "integer",
      "title": "Leased Expired",
      "default": 0
    },
    "failed_retryable": {
      "type": "integer",
      "title": "Failed Retryable",
      "default": 0
    },
    "failed_deferred": {
      "type": "integer",
      "title": "Failed Deferred",
      "default": 0
    },
    "dead_lettered": {
      "type": "integer",
      "title": "Dead Lettered",
      "default": 0
    },
    "delivered": {
      "type": "integer",
      "title": "Delivered",
      "default": 0
    },
    "claimable_total": {
      "type": "integer",
      "title": "Claimable Total",
      "default": 0
    },
    "outstanding_total": {
      "type": "integer",
      "title": "Outstanding Total",
      "default": 0
    },
    "repeatedly_failing": {
      "type": "integer",
      "title": "Repeatedly Failing",
      "default": 0
    },
    "final_attempt_boundary": {
      "type": "integer",
      "title": "Final Attempt Boundary",
      "default": 0
    },
    "max_outstanding_attempts": {
      "type": "integer",
      "title": "Max Outstanding Attempts",
      "default": 0
    },
    "max_automatic_attempts": {
      "type": "integer",
      "title": "Max Automatic Attempts",
      "default": 3
    },
    "oldest_claimable_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Claimable At"
    },
    "oldest_claimable_age_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Claimable Age Seconds"
    },
    "oldest_pending_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Pending At"
    },
    "oldest_pending_age_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Pending Age Seconds"
    },
    "oldest_failed_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Failed At"
    },
    "oldest_failed_age_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Failed Age Seconds"
    },
    "oldest_dead_letter_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Dead Letter At"
    },
    "oldest_dead_letter_age_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oldest Dead Letter Age Seconds"
    },
    "earliest_live_lease_expires_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Earliest Live Lease Expires At"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "observed_at"
  ],
  "title": "PersistedEventSideEffectHealth"
}

PersistedEventSideEffectInspection

Section titled “PersistedEventSideEffectInspection”
{
  "properties": {
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "event_id": {
      "type": "string",
      "title": "Event Id"
    },
    "event_sequence": {
      "type": "integer",
      "title": "Event Sequence"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "leased",
        "failed",
        "delivered",
        "dead_lettered"
      ],
      "title": "Status"
    },
    "claimable": {
      "type": "boolean",
      "title": "Claimable"
    },
    "attempts": {
      "type": "integer",
      "title": "Attempts"
    },
    "lease_expires_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Lease Expires At"
    },
    "next_attempt_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Next Attempt At"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Updated At"
    },
    "last_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Error"
    }
  },
  "type": "object",
  "required": [
    "session_id",
    "event_id",
    "event_sequence",
    "status",
    "claimable",
    "attempts",
    "lease_expires_at",
    "next_attempt_at",
    "updated_at",
    "last_error"
  ],
  "title": "PersistedEventSideEffectInspection"
}