HTTP models: SessionUsageSummary – TaskOperationalSnapshot

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

SessionUsageSummary

{
  "properties": {
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "model_steps": {
      "type": "integer",
      "maximum": 9.223372036854776e+18,
      "minimum": 0.0,
      "title": "Model Steps",
      "default": 0
    },
    "unmeasured_model_attempts": {
      "type": "integer",
      "maximum": 9.223372036854776e+18,
      "minimum": 0.0,
      "title": "Unmeasured Model Attempts",
      "default": 0
    },
    "tool_calls": {
      "type": "integer",
      "maximum": 9.223372036854776e+18,
      "minimum": 0.0,
      "title": "Tool Calls",
      "default": 0
    },
    "provider_names": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Provider Names"
    },
    "models": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Models"
    },
    "usage": {
      "$ref": "#/components/schemas/AggregateUsageMetrics"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "session_id"
  ],
  "title": "SessionUsageSummary",
  "description": "Usage totals derived from durable session events."
}

SessionsSummaryBody

{
  "properties": {
    "pricing": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PriceBook"
        },
        {
          "type": "null"
        }
      ]
    },
    "currency": {
      "type": "string",
      "minLength": 1,
      "title": "Currency",
      "default": "USD"
    }
  },
  "type": "object",
  "title": "SessionsSummaryBody"
}

SessionsSummaryResponse

{
  "properties": {
    "session_count": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Session Count"
    },
    "sessions": {
      "items": {
        "$ref": "#/components/schemas/ApiSessionSummaryItem"
      },
      "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": {
      "$ref": "#/components/schemas/AggregateUsageSummary"
    },
    "provider_breakdown": {
      "items": {
        "$ref": "#/components/schemas/UsageBreakdownItem"
      },
      "type": "array",
      "title": "Provider Breakdown"
    },
    "model_breakdown": {
      "items": {
        "$ref": "#/components/schemas/UsageBreakdownItem"
      },
      "type": "array",
      "title": "Model Breakdown"
    },
    "cost": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/AggregateCostSummary"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "session_count",
    "sessions",
    "next_cursor",
    "total_count",
    "usage",
    "cost"
  ],
  "title": "SessionsSummaryResponse"
}

SseContract

{
  "properties": {
    "content_type": {
      "type": "string",
      "const": "text/event-stream",
      "title": "Content Type",
      "default": "text/event-stream"
    },
    "event_id_format": {
      "type": "string",
      "const": "session_id:cayu_event_<sequence>",
      "title": "Event Id Format",
      "default": "session_id:cayu_event_<sequence>"
    },
    "replay_header": {
      "type": "string",
      "const": "Last-Event-ID",
      "title": "Replay Header",
      "default": "Last-Event-ID"
    },
    "max_event_id_chars": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Max Event Id Chars",
      "default": 512
    },
    "mutation_id_header": {
      "type": "string",
      "const": "Cayu-Mutation-ID",
      "title": "Mutation Id Header",
      "default": "Cayu-Mutation-ID"
    },
    "mutation_acceptance_event_type": {
      "type": "string",
      "const": "server.mutation.accepted",
      "title": "Mutation Acceptance Event Type",
      "default": "server.mutation.accepted"
    },
    "replay_start_marker_format": {
      "type": "string",
      "const": "session_id:",
      "title": "Replay Start Marker Format",
      "default": "session_id:"
    },
    "unknown_event_marker_behavior": {
      "type": "string",
      "const": "reject",
      "title": "Unknown Event Marker Behavior",
      "default": "reject"
    },
    "event_data_schema": {
      "type": "string",
      "const": "SseEventEnvelope",
      "title": "Event Data Schema",
      "default": "SseEventEnvelope"
    },
    "error_event_name": {
      "type": "string",
      "const": "error",
      "title": "Error Event Name",
      "default": "error"
    },
    "error_data_schema": {
      "type": "string",
      "const": "SseErrorEnvelope",
      "title": "Error Data Schema",
      "default": "SseErrorEnvelope"
    },
    "max_event_data_bytes": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Max Event Data Bytes",
      "description": "Maximum UTF-8 bytes in one live SSE event data value.",
      "default": 2097152
    },
    "max_error_text_bytes": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Max Error Text Bytes",
      "description": "Maximum UTF-8 bytes in the redacted error field.",
      "default": 4096
    },
    "examples": {
      "$ref": "#/components/schemas/SseFrameExamples"
    },
    "session_follow": {
      "$ref": "#/components/schemas/SessionFollowContract"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "SseContract"
}

SseErrorEnvelope

{
  "properties": {
    "type": {
      "type": "string",
      "const": "stream.error",
      "title": "Type"
    },
    "kind": {
      "type": "string",
      "enum": [
        "runtime",
        "observer"
      ],
      "title": "Kind"
    },
    "code": {
      "type": "string",
      "enum": [
        "runtime_failed",
        "terminal_event_publication_uncertain",
        "observer_lagged",
        "event_frame_too_large",
        "replay_idle_timeout"
      ],
      "title": "Code"
    },
    "error": {
      "type": "string",
      "title": "Error"
    },
    "error_type": {
      "type": "string",
      "title": "Error Type"
    },
    "retryable": {
      "type": "boolean",
      "title": "Retryable"
    },
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Session Id"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "type",
    "kind",
    "code",
    "error",
    "error_type",
    "retryable",
    "session_id"
  ],
  "title": "SseErrorEnvelope",
  "description": "JSON payload in classified terminal SSE ``event: error`` frames."
}

SseEventEnvelope

{
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 512,
      "title": "Id"
    },
    "type": {
      "type": "string",
      "title": "Type"
    },
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "interaction_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Interaction Id"
    },
    "agent_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent Name"
    },
    "environment_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Environment Name"
    },
    "workflow_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Workflow Name"
    },
    "tool_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Tool Name"
    },
    "payload": {
      "additionalProperties": true,
      "type": "object",
      "title": "Payload"
    },
    "timestamp": {
      "type": "string",
      "title": "Timestamp"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "id",
    "type",
    "session_id",
    "interaction_id",
    "agent_name",
    "tool_name",
    "payload",
    "timestamp"
  ],
  "title": "SseEventEnvelope",
  "description": "JSON payload in each runtime event SSE ``data:`` frame."
}

SseFrameExamples

{
  "properties": {
    "event_data": {
      "$ref": "#/components/schemas/SseEventEnvelope"
    },
    "error_data": {
      "$ref": "#/components/schemas/SseErrorEnvelope"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "SseFrameExamples"
}

SseSessionFollowEndEnvelope

{
  "properties": {
    "type": {
      "type": "string",
      "const": "session.follow.end",
      "title": "Type"
    },
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "running",
        "interrupting",
        "completed",
        "failed",
        "interrupted"
      ],
      "title": "Status"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "type",
    "session_id",
    "status"
  ],
  "title": "SseSessionFollowEndEnvelope",
  "description": "JSON payload in the final ``event: end`` frame of a session follow stream."
}

StartupRecoveryBlockedSession

{
  "properties": {
    "session_id": {
      "type": "string",
      "title": "Session Id"
    },
    "blocker_codes": {
      "items": {
        "$ref": "#/components/schemas/RecoveryBlockerCode"
      },
      "type": "array",
      "maxItems": 16,
      "minItems": 1,
      "title": "Blocker Codes"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "session_id",
    "blocker_codes"
  ],
  "title": "StartupRecoveryBlockedSession",
  "description": "Bounded operator evidence; contains no checkpoint or exception content."
}

StartupRecoveryResult

{
  "properties": {
    "schema_version": {
      "type": "integer",
      "const": 1,
      "title": "Schema Version",
      "default": 1
    },
    "completed": {
      "type": "boolean",
      "title": "Completed",
      "default": false
    },
    "status": {
      "type": "string",
      "enum": [
        "not_started",
        "running",
        "completed",
        "failed"
      ],
      "title": "Status",
      "default": "not_started"
    },
    "sweep_count": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Sweep Count",
      "default": 0
    },
    "scheduled_roots": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Scheduled Roots",
      "default": 0
    },
    "deferred_session_count": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Deferred Session Count",
      "default": 0
    },
    "skipped_session_count": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Skipped Session Count",
      "default": 0
    },
    "blocked_session_count": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Blocked Session Count",
      "default": 0
    },
    "blocked_sessions": {
      "items": {
        "$ref": "#/components/schemas/StartupRecoveryBlockedSession"
      },
      "type": "array",
      "maxItems": 100,
      "title": "Blocked Sessions",
      "default": []
    },
    "blocked_sessions_truncated": {
      "type": "boolean",
      "title": "Blocked Sessions Truncated",
      "default": false
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "StartupRecoveryResult",
  "description": "Latest process-local interruption sweep, retaining at most 100 blocked roots."
}

StructuredOutputSpec

{
  "properties": {
    "json_schema": {
      "additionalProperties": true,
      "type": "object",
      "title": "Json Schema"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    },
    "max_retries": {
      "type": "integer",
      "maximum": 8.0,
      "minimum": 0.0,
      "title": "Max Retries",
      "default": 2
    },
    "repair_prompt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Repair Prompt"
    },
    "strategy": {
      "$ref": "#/components/schemas/StructuredOutputStrategy",
      "default": "tool"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "json_schema"
  ],
  "title": "StructuredOutputSpec",
  "description": "Provider-neutral JSON structured output requirement."
}

StructuredOutputStrategy

{
  "type": "string",
  "enum": [
    "tool",
    "native"
  ],
  "title": "StructuredOutputStrategy"
}

SystemDeploymentDiagnostics

{
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 128
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    },
    "name_status": {
      "type": "string",
      "enum": [
        "available",
        "not_provided",
        "omitted"
      ],
      "title": "Name Status"
    },
    "api_access": {
      "type": "string",
      "enum": [
        "open",
        "authenticated"
      ],
      "title": "Api Access"
    },
    "dashboard_access": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "open",
            "authenticated"
          ]
        },
        {
          "type": "null"
        }
      ],
      "title": "Dashboard Access"
    },
    "dashboard_enabled": {
      "type": "boolean",
      "title": "Dashboard Enabled"
    },
    "docs_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Docs Enabled"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name_status",
    "api_access",
    "dashboard_access",
    "dashboard_enabled",
    "docs_enabled"
  ],
  "title": "SystemDeploymentDiagnostics",
  "description": "Bounded resolved server identity and effective access posture."
}

SystemDiagnosticsResponse

{
  "properties": {
    "observed_at": {
      "type": "string",
      "format": "date-time",
      "title": "Observed At"
    },
    "deployment": {
      "$ref": "#/components/schemas/SystemDeploymentDiagnostics"
    },
    "versions": {
      "$ref": "#/components/schemas/SystemVersionDiagnostics"
    },
    "capabilities": {
      "$ref": "#/components/schemas/ControlPlaneCapabilities"
    },
    "artifact_stores": {
      "$ref": "#/components/schemas/ArtifactStoreDiagnostics"
    },
    "pricing_catalog": {
      "$ref": "#/components/schemas/PricingCatalogDiagnostics"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "observed_at",
    "deployment",
    "versions",
    "capabilities",
    "artifact_stores",
    "pricing_catalog"
  ],
  "title": "SystemDiagnosticsResponse",
  "description": "Protected bounded Cayu configuration and registration diagnostics."
}

SystemVersionDiagnostics

{
  "properties": {
    "cayu": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 128
        },
        {
          "type": "null"
        }
      ],
      "title": "Cayu"
    },
    "server_contract": {
      "type": "string",
      "maxLength": 32,
      "title": "Server Contract"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "cayu",
    "server_contract"
  ],
  "title": "SystemVersionDiagnostics"
}

TaskAggregateFilter

{
  "properties": {
    "type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Type"
    },
    "session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Session Id"
    },
    "parent_task_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Parent Task Id"
    },
    "assigned_agent_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Assigned Agent Name"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "title": "TaskAggregateFilter",
  "description": "Current task attributes that may scope a store-native aggregate."
}

TaskExecutionSource

{
  "type": "string",
  "enum": [
    "http_run",
    "product_operation",
    "scheduled",
    "sdk_task",
    "task_dispatch",
    "webhook"
  ],
  "title": "TaskExecutionSource",
  "description": "The trusted boundary that created one durable task."
}

TaskHoldBody

{
  "properties": {
    "reason": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "title": "Reason"
    },
    "payload": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Payload"
    }
  },
  "type": "object",
  "title": "TaskHoldBody"
}

TaskMisfirePolicy

{
  "type": "string",
  "enum": [
    "fire_once",
    "skip"
  ],
  "title": "TaskMisfirePolicy"
}

TaskOperationalSnapshot

{
  "properties": {
    "as_of": {
      "type": "string",
      "format": "date-time",
      "title": "As Of"
    },
    "total_count": {
      "type": "string",
      "pattern": "^(0|[1-9]\\d*)$",
      "title": "Total Count"
    },
    "counts_by_status": {
      "$ref": "#/components/schemas/TaskStatusCounts"
    },
    "claimable_pending_count": {
      "type": "string",
      "pattern": "^(0|[1-9]\\d*)$",
      "title": "Claimable Pending Count"
    },
    "scheduled_pending_count": {
      "type": "string",
      "pattern": "^(0|[1-9]\\d*)$",
      "title": "Scheduled Pending Count"
    },
    "accuracy": {
      "$ref": "#/components/schemas/AggregateAccuracy"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "as_of",
    "total_count",
    "counts_by_status",
    "claimable_pending_count",
    "scheduled_pending_count",
    "accuracy"
  ],
  "title": "TaskOperationalSnapshot",
  "description": "Exact current task counts captured by one store-local read snapshot."
}