HTTP models: UsageSessionAggregateGroup – WebSearchSource
Exact OpenAPI component declarations. $ref values identify other components in the complete schema.
UsageSessionAggregateGroup
Section titled “UsageSessionAggregateGroup”{ "properties": { "session_id": { "type": "string", "title": "Session Id" }, "status": { "type": "string", "enum": [ "pending", "running", "interrupting", "completed", "failed", "interrupted" ], "title": "Status" }, "active": { "type": "boolean", "title": "Active" }, "totals": { "$ref": "#/components/schemas/UsageAggregateTotals" } }, "additionalProperties": false, "type": "object", "required": [ "session_id", "status", "active", "totals" ], "title": "UsageSessionAggregateGroup", "description": "Exact usage for one retained current session inside a bounded breakdown."}UsageSessionAggregateRemainder
Section titled “UsageSessionAggregateRemainder”{ "properties": { "group_count": { "type": "string", "pattern": "^[1-9]\\d*$", "title": "Group Count" }, "active_session_count": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Active Session Count" }, "totals": { "$ref": "#/components/schemas/UsageAggregateTotals" } }, "additionalProperties": false, "type": "object", "required": [ "group_count", "active_session_count", "totals" ], "title": "UsageSessionAggregateRemainder", "description": "Exact usage represented by current sessions omitted from bounded detail."}UsageSessionCostBreakdown
Section titled “UsageSessionCostBreakdown”{ "properties": { "price_book_version": { "type": "string", "title": "Price Book Version" }, "price_book_generated_at": { "type": "string", "title": "Price Book Generated At" }, "groups": { "items": { "$ref": "#/components/schemas/UsageSessionCostGroup" }, "type": "array", "maxItems": 100, "title": "Groups" }, "remainder": { "anyOf": [ { "$ref": "#/components/schemas/UsageSessionCostRemainder" }, { "type": "null" } ] }, "accuracy": { "$ref": "#/components/schemas/AggregateAccuracy" } }, "additionalProperties": false, "type": "object", "required": [ "price_book_version", "price_book_generated_at", "groups", "remainder", "accuracy" ], "title": "UsageSessionCostBreakdown", "description": "Bounded per-session costs plus an aggregate remainder."}UsageSessionCostGroup
Section titled “UsageSessionCostGroup”{ "properties": { "session_id": { "type": "string", "title": "Session Id" }, "cost": { "$ref": "#/components/schemas/UsageSessionCostSummary" } }, "additionalProperties": false, "type": "object", "required": [ "session_id", "cost" ], "title": "UsageSessionCostGroup", "description": "Cost accounting for one retained session."}UsageSessionCostRemainder
Section titled “UsageSessionCostRemainder”{ "properties": { "group_count": { "type": "string", "pattern": "^[1-9]\\d*$", "title": "Group Count" }, "cost": { "$ref": "#/components/schemas/UsageSessionCostSummary" } }, "additionalProperties": false, "type": "object", "required": [ "group_count", "cost" ], "title": "UsageSessionCostRemainder", "description": "Exact aggregate cost for sessions omitted from bounded detail."}UsageSessionCostSummary
Section titled “UsageSessionCostSummary”{ "properties": { "accuracy": { "$ref": "#/components/schemas/AggregateAccuracy" }, "evaluated_model_steps": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Evaluated Model Steps" }, "evaluated_auxiliary_attempts": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Evaluated Auxiliary Attempts", "default": "0" }, "priced_auxiliary_attempts": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Priced Auxiliary Attempts", "default": "0" }, "unpriced_auxiliary_attempts": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Unpriced Auxiliary Attempts", "default": "0" }, "priced_model_steps": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Priced Model Steps" }, "unpriced_model_steps": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Unpriced Model Steps" }, "unevaluated_model_steps": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Unevaluated Model Steps" }, "currencies": { "items": { "$ref": "#/components/schemas/UsageCurrencyCost" }, "type": "array", "maxItems": 5000, "title": "Currencies" }, "unpriced_reasons": { "items": { "$ref": "#/components/schemas/UsageUnpricedReason" }, "type": "array", "maxItems": 5000, "title": "Unpriced Reasons" } }, "additionalProperties": false, "type": "object", "required": [ "accuracy", "evaluated_model_steps", "priced_model_steps", "unpriced_model_steps", "unevaluated_model_steps", "currencies", "unpriced_reasons" ], "title": "UsageSessionCostSummary", "description": "Cost accounting for one session group or the exact omitted remainder."}UsageUnpricedReason
Section titled “UsageUnpricedReason”{ "properties": { "unpriced_reason": { "anyOf": [ { "type": "string", "enum": [ "missing_usage", "missing_pricing", "unsupported_pricing" ] }, { "type": "null" } ], "title": "Unpriced Reason" }, "reason": { "type": "string", "title": "Reason" }, "model_steps": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Model Steps" }, "auxiliary_attempts": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Auxiliary Attempts", "default": "0" }, "hosted_resources": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Hosted Resources", "default": "0" } }, "additionalProperties": false, "type": "object", "required": [ "reason", "model_steps" ], "title": "UsageUnpricedReason", "description": "Model-step and hosted-resource counts unpriced for one explicit reason."}UserInputRecoveryBody
Section titled “UserInputRecoveryBody”{ "properties": { "review_reference": { "anyOf": [ { "$ref": "#/components/schemas/HumanReviewReference" }, { "type": "null" } ] }, "answer_review_reference": { "anyOf": [ { "$ref": "#/components/schemas/HumanReviewReference" }, { "type": "null" } ] }, "session_id": { "type": "string", "minLength": 1, "title": "Session Id" }, "task_worker_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Task Worker Id" }, "task_handoff_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Task Handoff Id" }, "input_id": { "type": "string", "minLength": 1, "title": "Input Id" }, "answer": { "type": "string", "minLength": 1, "title": "Answer" }, "tool_call_id": { "type": "string", "minLength": 1, "title": "Tool Call Id" }, "outcome": { "$ref": "#/components/schemas/ToolApprovalRecoveryOutcome" }, "message": { "type": "string", "minLength": 1, "title": "Message" }, "structured": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured" }, "artifacts": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Artifacts" }, "reason": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Reason" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "resolved_by": { "anyOf": [ { "$ref": "#/components/schemas/ResolutionActor" }, { "type": "null" } ] }, "max_steps": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Steps" }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/RunLimits" }, { "type": "null" } ] }, "budget_limits": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BudgetLimit" }, "type": "array" }, { "type": "null" } ], "title": "Budget Limits" }, "retry_policy": { "anyOf": [ { "$ref": "#/components/schemas/RetryPolicy" }, { "type": "null" } ] }, "structured_output": { "anyOf": [ { "$ref": "#/components/schemas/StructuredOutputSpec" }, { "type": "null" } ] }, "thinking": { "anyOf": [ { "$ref": "#/components/schemas/ThinkingConfig" }, { "type": "null" } ] } }, "type": "object", "required": [ "session_id", "input_id", "answer", "tool_call_id", "outcome", "message" ], "title": "UserInputRecoveryBody", "description": "Body for recovering a user-input round stuck on ``manual_recovery_required``.\n\n``max_steps``, ``limits``, ``budget_limits``, and ``retry_policy`` default to ``None``: the\nresumed run inherits the original run's configuration persisted on the pending user input.\nExplicit values are accepted only when they preserve the invocation's frozen execution\nprofile."}UserInputResolveBody
Section titled “UserInputResolveBody”{ "properties": { "review_reference": { "anyOf": [ { "$ref": "#/components/schemas/HumanReviewReference" }, { "type": "null" } ] }, "session_id": { "type": "string", "minLength": 1, "title": "Session Id" }, "task_worker_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Task Worker Id" }, "task_handoff_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Task Handoff Id" }, "input_id": { "type": "string", "minLength": 1, "title": "Input Id" }, "answer": { "type": "string", "minLength": 1, "title": "Answer" }, "structured": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured" }, "artifacts": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Artifacts" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "resolved_by": { "anyOf": [ { "$ref": "#/components/schemas/ResolutionActor" }, { "type": "null" } ] }, "max_steps": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Steps" }, "limits": { "anyOf": [ { "$ref": "#/components/schemas/RunLimits" }, { "type": "null" } ] }, "budget_limits": { "anyOf": [ { "items": { "$ref": "#/components/schemas/BudgetLimit" }, "type": "array" }, { "type": "null" } ], "title": "Budget Limits" }, "retry_policy": { "anyOf": [ { "$ref": "#/components/schemas/RetryPolicy" }, { "type": "null" } ] }, "structured_output": { "anyOf": [ { "$ref": "#/components/schemas/StructuredOutputSpec" }, { "type": "null" } ] }, "thinking": { "anyOf": [ { "$ref": "#/components/schemas/ThinkingConfig" }, { "type": "null" } ] } }, "type": "object", "required": [ "session_id", "input_id", "answer" ], "title": "UserInputResolveBody", "description": "Body for answering a session paused by ``ask_user``.\n\n``max_steps``, ``limits``, ``budget_limits``, and ``retry_policy`` default to ``None``: the\nresumed run inherits the original run's configuration persisted on the pending user input.\nExplicit values are accepted only when they preserve the invocation's frozen execution\nprofile."}ValidationError
Section titled “ValidationError”{ "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError"}VersioningContract
Section titled “VersioningContract”{ "properties": { "contract_version": { "type": "string", "title": "Contract Version", "default": "48" }, "compatibility": { "type": "string", "const": "additive-with-explicit-breaking-review", "title": "Compatibility", "default": "additive-with-explicit-breaking-review" }, "breaking_change_requires": { "items": { "type": "string", "enum": [ "openapi_snapshot_update", "client_regeneration", "migration_note" ] }, "type": "array", "title": "Breaking Change Requires", "default": [ "openapi_snapshot_update", "client_regeneration", "migration_note" ] } }, "additionalProperties": false, "type": "object", "title": "VersioningContract"}WebSearchAPISource
Section titled “WebSearchAPISource”{ "properties": { "type": { "type": "string", "const": "api", "title": "Type", "default": "api" }, "name": { "type": "string", "maxLength": 1024, "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "WebSearchAPISource", "description": "Named API evidence returned by hosted search, without a fabricated URL."}WebSearchAction
Section titled “WebSearchAction”{ "properties": { "type": { "type": "string", "enum": [ "search", "open_page", "find_in_page" ], "title": "Type" }, "query": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Query" }, "queries": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Queries", "default": [] }, "url": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Url" }, "pattern": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ], "title": "Pattern" }, "sources": { "items": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchSource" }, { "$ref": "#/components/schemas/WebSearchAPISource" } ] }, "type": "array", "maxItems": 100, "title": "Sources", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "type" ], "title": "WebSearchAction", "description": "Bounded terminal evidence; optional provider details may be absent."}WebSearchSource
Section titled “WebSearchSource”{ "properties": { "type": { "type": "string", "const": "url", "title": "Type", "default": "url" }, "url": { "type": "string", "maxLength": 4096, "title": "Url" }, "title": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Title" } }, "additionalProperties": false, "type": "object", "required": [ "url" ], "title": "WebSearchSource", "description": "Bounded URL source returned by a provider-hosted web search."}