HTTP models: TaskOrder – ToolDiscoveryViewInspection
Exact OpenAPI component declarations. $ref values identify other components in the complete schema.
TaskOrder
Section titled “TaskOrder”{ "type": "string", "enum": [ "created_at_asc", "created_at_desc", "updated_at_asc", "updated_at_desc" ], "title": "TaskOrder"}TaskRescheduleRequest
Section titled “TaskRescheduleRequest”{ "properties": { "task_id": { "type": "string", "title": "Task Id" }, "operation_id": { "type": "string", "title": "Operation Id" }, "expected_revision": { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0, "title": "Expected Revision" }, "available_at": { "type": "string", "format": "date-time", "title": "Available At" }, "policy": { "$ref": "#/components/schemas/TaskSchedulePolicy" } }, "additionalProperties": false, "type": "object", "required": [ "task_id", "operation_id", "expected_revision", "available_at" ], "title": "TaskRescheduleRequest", "description": "Replace a not-yet-admitted schedule at one expected revision."}TaskScheduleCancelRequest
Section titled “TaskScheduleCancelRequest”{ "properties": { "task_id": { "type": "string", "title": "Task Id" }, "operation_id": { "type": "string", "title": "Operation Id" }, "expected_revision": { "type": "integer", "maximum": 9007199254740991.0, "minimum": 1.0, "title": "Expected Revision" } }, "additionalProperties": false, "type": "object", "required": [ "task_id", "operation_id", "expected_revision" ], "title": "TaskScheduleCancelRequest", "description": "Cancel one exact schedule revision without bypassing a live worker."}TaskScheduleEventType
Section titled “TaskScheduleEventType”{ "type": "string", "enum": [ "task.scheduled", "task.rescheduled", "task.schedule_eligible", "task.schedule_misfired", "task.schedule_expired", "task.schedule_skipped", "task.schedule_dependency_skipped", "task.schedule_claimed", "task.schedule_cancellation_requested", "task.schedule_cancelled", "task.schedule_started", "task.schedule_held", "task.schedule_resumed", "task.schedule_completed", "task.schedule_failed" ], "title": "TaskScheduleEventType"}TaskSchedulePolicy
Section titled “TaskSchedulePolicy”{ "properties": { "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "misfire_policy": { "$ref": "#/components/schemas/TaskMisfirePolicy", "default": "fire_once" }, "misfire_grace_seconds": { "type": "integer", "maximum": 31622400.0, "minimum": 0.0, "title": "Misfire Grace Seconds", "default": 60 } }, "additionalProperties": false, "type": "object", "title": "TaskSchedulePolicy", "description": "An optional latest admission time and deterministic late-arrival policy.\n\n``expires_at`` is exclusive. A task observed exactly at expiry cannot be\nadmitted. Lateness strictly greater than the grace interval is a misfire;\nequality stays eligible. Expiry takes precedence over the misfire policy."}TaskStatus
Section titled “TaskStatus”{ "type": "string", "enum": [ "pending", "waiting_dependencies", "waiting_group", "dependency_skipped", "claimed", "running", "paused", "blocked", "needs_attention", "completed", "failed", "cancelled" ], "title": "TaskStatus"}TaskStatusCounts
Section titled “TaskStatusCounts”{ "properties": { "pending": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Pending" }, "waiting_dependencies": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Waiting Dependencies", "default": "0" }, "waiting_group": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Waiting Group", "default": "0" }, "dependency_skipped": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Dependency Skipped", "default": "0" }, "claimed": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Claimed" }, "running": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Running" }, "paused": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Paused" }, "blocked": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Blocked" }, "needs_attention": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Needs Attention" }, "completed": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Completed" }, "failed": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Failed" }, "cancelled": { "type": "string", "pattern": "^(0|[1-9]\\d*)$", "title": "Cancelled" } }, "additionalProperties": false, "type": "object", "required": [ "pending", "claimed", "running", "paused", "blocked", "needs_attention", "completed", "failed", "cancelled" ], "title": "TaskStatusCounts", "description": "Complete current-task counts for every lifecycle status."}TextPart
Section titled “TextPart”{ "properties": { "type": { "type": "string", "const": "text", "title": "Type", "default": "text" }, "text": { "type": "string", "title": "Text" } }, "additionalProperties": false, "type": "object", "required": [ "text" ], "title": "TextPart"}ThinkingConfig
Section titled “ThinkingConfig”{ "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ] }, { "type": "null" } ], "title": "Effort" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "include_in_transcript": { "type": "boolean", "title": "Include In Transcript", "default": true } }, "additionalProperties": false, "type": "object", "title": "ThinkingConfig", "description": "Provider-neutral thinking/reasoning configuration.\n\nEffort names are native values, not a portable scale. Supported vocabulary is\n``none``, ``minimal``, ``low``, ``medium``, ``high``, ``xhigh``, and ``max``;\nadapters reject known incompatible model/transport combinations before dispatch.\nUnknown model compatibility remains backend-dependent. ``xlow`` is not a verified\nnative value in the maintained adapters and is not an alias for ``minimal``.\n\nExplicit effort maps unchanged to OpenAI ``reasoning.effort``, compatible Chat\nCompletions ``reasoning_effort``, or Anthropic adaptive thinking plus\n``output_config.effort``. Bedrock Converse has no typed effort mapping and rejects\nit. See ``cayu guide thinking`` for the matrix.\n\n``none`` requests the backend's native non-reasoning effort; ``minimal`` still\npermits reasoning. Both require ``enabled=True`` (the default), which enables\nthis configuration, not a promise that the model thinks. Neither is silently\nmapped to ``enabled=False``. The latter retains its historical best-effort\nbehavior: Anthropic disables thinking; OpenAI and generic Chat Completions no-op.\n\n``effort`` and ``max_tokens`` are mutually exclusive. A token budget selects\nAnthropic legacy thinking (OpenAI and generic Chat Completions historically\nignore it). Disabling thinking cannot be combined with either control. With\nneither control, enabled thinking uses existing provider defaults. Typed effort\nwins over conflicting raw effort; unrelated provider options remain intact."}ThinkingPart
Section titled “ThinkingPart”{ "properties": { "type": { "type": "string", "const": "thinking", "title": "Type", "default": "thinking" }, "text": { "type": "string", "title": "Text", "default": "" }, "provider_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Provider State" } }, "additionalProperties": false, "type": "object", "title": "ThinkingPart", "description": "Model reasoning/thinking content from a single reasoning block.\n\n`text` may be empty (the provider returned the reasoning in an omitted/redacted\nform). `provider_state` carries the opaque round-trip payload \u2014 the Anthropic\n`signature` or `redacted_thinking` data, or an OpenAI encrypted reasoning blob \u2014\nneeded to send the block back to the provider on a later turn. Built-in providers\ntag opaque reasoning state with its provider family, protocol, and protocol version;\nrequest adapters replay it only when all three match. Legacy untagged state remains\nreadable in the durable transcript but is not authoritative for opaque replay."}TieredPricing
Section titled “TieredPricing”{ "properties": { "currency": { "type": "string", "title": "Currency", "default": "USD" }, "standard": { "items": { "$ref": "#/components/schemas/PriceTier" }, "type": "array", "minItems": 1, "title": "Standard" }, "batch": { "anyOf": [ { "$ref": "#/components/schemas/PriceTier" }, { "type": "null" } ] }, "cache_write_5m_per_million": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cache Write 5M Per Million" }, "cache_write_1h_per_million": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Cache Write 1H Per Million" }, "web_search_per_thousand": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Web Search Per Thousand" } }, "additionalProperties": false, "type": "object", "required": [ "standard" ], "title": "TieredPricing", "description": "Full pricing for one model: context-band tiers plus optional batch and\ncache-write-duration rates.\n\nOnly the context-band ``standard`` tiers feed the cost engine today. A tier-local\ncache-write rate takes precedence over the model-wide\n``cache_write_5m_per_million`` fallback.\n``batch`` is carried for completeness and future use. Contextual pricing\napplies ``cache_write_1h_per_million`` only to usage explicitly attributed\nto a one-hour cache write."}ToolApprovalBody
Section titled “ToolApprovalBody”{ "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" }, "approval_id": { "type": "string", "minLength": 1, "title": "Approval Id" }, "tool_round_id": { "type": "string", "minLength": 1, "title": "Tool Round Id" }, "tool_call_id": { "type": "string", "minLength": 1, "title": "Tool Call Id" }, "decision": { "$ref": "#/components/schemas/ToolApprovalDecision" }, "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", "approval_id", "tool_round_id", "tool_call_id", "decision" ], "title": "ToolApprovalBody", "description": "Body for resolving a pending tool approval.\n\n``max_steps``, ``limits``, ``budget_limits``, and ``retry_policy`` default\nto ``None``: the resumed run inherits the original run's configuration\npersisted on the pending approval. Explicit values are accepted only when\nthey preserve the invocation's frozen execution profile."}ToolApprovalDecision
Section titled “ToolApprovalDecision”{ "type": "string", "enum": [ "approve", "deny" ], "title": "ToolApprovalDecision"}ToolApprovalRecoveryBody
Section titled “ToolApprovalRecoveryBody”{ "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" }, "approval_id": { "type": "string", "minLength": 1, "title": "Approval Id" }, "tool_round_id": { "type": "string", "minLength": 1, "title": "Tool Round Id" }, "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", "approval_id", "tool_round_id", "tool_call_id", "outcome", "message" ], "title": "ToolApprovalRecoveryBody", "description": "Body for recovering an approved tool call with an unknown result.\n\n``max_steps``, ``limits``, ``budget_limits``, and ``retry_policy`` default\nto ``None``: the resumed run inherits the original run's configuration\npersisted on the pending approval. Explicit values are accepted only when\nthey preserve the invocation's frozen execution profile."}ToolApprovalRecoveryOutcome
Section titled “ToolApprovalRecoveryOutcome”{ "type": "string", "enum": [ "completed", "failed" ], "title": "ToolApprovalRecoveryOutcome"}ToolCallPart
Section titled “ToolCallPart”{ "properties": { "type": { "type": "string", "const": "tool_call", "title": "Type", "default": "tool_call" }, "tool_call_id": { "type": "string", "title": "Tool Call Id" }, "tool_name": { "type": "string", "title": "Tool Name" }, "arguments": { "additionalProperties": true, "type": "object", "title": "Arguments" }, "arguments_state": { "type": "string", "enum": [ "finalized", "unavailable" ], "title": "Arguments State", "default": "finalized" }, "tool_round_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Round Id" }, "model_step_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Step Id" }, "model_attempt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Attempt Id" } }, "additionalProperties": false, "type": "object", "required": [ "tool_call_id", "tool_name" ], "title": "ToolCallPart"}ToolCompletionPolicy
Section titled “ToolCompletionPolicy”{ "properties": { "tool_names": { "items": { "type": "string" }, "type": "array", "maxItems": 64, "minItems": 1, "title": "Tool Names" } }, "additionalProperties": false, "type": "object", "required": [ "tool_names" ], "title": "ToolCompletionPolicy", "description": "Complete a single-call round from a designated successful tool.\n\nThe host renders the tool result. Eligible application tools declare\n``NONE`` or ``IDEMPOTENT`` effects. Rounds with sibling calls continue\nthrough the ordinary model loop. Supply this policy on each new run or\nresumed turn; approval and crash recovery retain the admitted policy."}ToolCompletionResult
Section titled “ToolCompletionResult”{ "properties": { "reason": { "type": "string", "const": "host_rendered_tool", "title": "Reason", "default": "host_rendered_tool" }, "status": { "type": "string", "const": "completed", "title": "Status", "default": "completed" }, "call": { "$ref": "#/components/schemas/ToolCallPart" }, "effect": { "$ref": "#/components/schemas/ToolEffect" }, "result": { "$ref": "#/components/schemas/ToolResultPart" } }, "additionalProperties": false, "type": "object", "required": [ "call", "effect", "result" ], "title": "ToolCompletionResult", "description": "Detached host-rendering basis from the canonical published tool outcome."}ToolDiscoveryGrantInspection
Section titled “ToolDiscoveryGrantInspection”{ "properties": { "schema_version": { "type": "integer", "const": 1, "title": "Schema Version", "default": 1 }, "tool_id": { "type": "string", "title": "Tool Id" }, "tool_name": { "type": "string", "title": "Tool Name" }, "descriptor_version": { "type": "string", "title": "Descriptor Version" }, "schema_fingerprint": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$", "title": "Schema Fingerprint" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "discovered_revision": { "type": "integer", "maximum": 256.0, "minimum": 1.0, "title": "Discovered Revision" } }, "additionalProperties": false, "type": "object", "required": [ "tool_id", "tool_name", "descriptor_version", "schema_fingerprint", "created_at", "discovered_revision" ], "title": "ToolDiscoveryGrantInspection", "description": "Content-minimized discovery grant state safe for control-plane reads."}ToolDiscoveryViewInspection
Section titled “ToolDiscoveryViewInspection”{ "properties": { "schema_version": { "type": "integer", "const": 1, "title": "Schema Version", "default": 1 }, "session_id": { "type": "string", "title": "Session Id" }, "generation_id": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$", "title": "Generation Id" }, "agent_name": { "type": "string", "title": "Agent Name" }, "catalogue_revision": { "type": "string", "title": "Catalogue Revision" }, "ceiling_fingerprint": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$", "title": "Ceiling Fingerprint" }, "revision": { "type": "integer", "maximum": 256.0, "minimum": 0.0, "title": "Revision" }, "grant_count": { "type": "integer", "maximum": 256.0, "minimum": 0.0, "title": "Grant Count" }, "grants": { "items": { "$ref": "#/components/schemas/ToolDiscoveryGrantInspection" }, "type": "array", "title": "Grants", "default": [] }, "grants_truncated": { "type": "boolean", "title": "Grants Truncated" } }, "additionalProperties": false, "type": "object", "required": [ "session_id", "generation_id", "agent_name", "catalogue_revision", "ceiling_fingerprint", "revision", "grant_count", "grants_truncated" ], "title": "ToolDiscoveryViewInspection", "description": "Bounded current-view projection without schemas or callable references."}