Skip to content

HTTP models: ApiTaskScheduleState – CapabilityOperation

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

{
"properties": {
"schema_version": {
"type": "integer",
"const": 1,
"title": "Schema Version"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"policy": {
"$ref": "#/components/schemas/ApiTaskSchedulePolicy"
},
"admitted_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Admitted At"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"schema_version",
"revision",
"policy",
"admitted_at"
],
"title": "ApiTaskScheduleState"
}
{
"properties": {
"parent_task_id": {
"type": "string",
"maxLength": 1024,
"minLength": 1,
"title": "Parent Task Id"
},
"children": {
"items": {
"$ref": "#/components/schemas/ApiTaskTopologyNode"
},
"type": "array",
"maxItems": 100,
"title": "Children"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 4096,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"has_more": {
"type": "boolean",
"title": "Has More"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"parent_task_id",
"children",
"next_cursor",
"has_more"
],
"title": "ApiTaskTopologyChildBranch"
}
{
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"minLength": 1,
"title": "Id"
},
"type": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Type"
},
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Title"
},
"status": {
"type": "string",
"title": "Status"
},
"status_reason": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Status Reason"
},
"session_id": {
"anyOf": [
{
"type": "string",
"maxLength": 1024,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Session Id"
},
"parent_task_id": {
"anyOf": [
{
"type": "string",
"maxLength": 1024,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Parent Task Id"
},
"assigned_agent_name": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Assigned Agent Name"
},
"created_at": {
"type": "string",
"title": "Created At"
},
"updated_at": {
"type": "string",
"title": "Updated At"
},
"truncated_fields": {
"items": {
"type": "string",
"enum": [
"type",
"title",
"assigned_agent_name",
"status_reason"
]
},
"type": "array",
"maxItems": 4,
"title": "Truncated Fields"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"type",
"title",
"status",
"status_reason",
"session_id",
"parent_task_id",
"assigned_agent_name",
"created_at",
"updated_at",
"truncated_fields"
],
"title": "ApiTaskTopologyNode"
}
{
"properties": {
"status": {
"type": "string",
"enum": [
"available",
"not_configured",
"unsupported"
],
"title": "Status"
},
"observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Observed At"
},
"session_branches": {
"items": {
"$ref": "#/components/schemas/ApiTaskTopologySessionBranch"
},
"type": "array",
"maxItems": 50,
"title": "Session Branches"
},
"expanded_parents": {
"items": {
"$ref": "#/components/schemas/ApiTaskTopologyNode"
},
"type": "array",
"maxItems": 50,
"title": "Expanded Parents"
},
"child_branches": {
"items": {
"$ref": "#/components/schemas/ApiTaskTopologyChildBranch"
},
"type": "array",
"maxItems": 50,
"title": "Child Branches"
},
"unique_node_count": {
"type": "integer",
"maximum": 500.0,
"minimum": 0.0,
"title": "Unique Node Count"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"status",
"observed_at",
"session_branches",
"expanded_parents",
"child_branches",
"unique_node_count"
],
"title": "ApiTaskTopologyProjection"
}
{
"properties": {
"session_id": {
"type": "string",
"maxLength": 1024,
"minLength": 1,
"title": "Session Id"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/ApiTaskTopologyNode"
},
"type": "array",
"maxItems": 100,
"title": "Tasks"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 4096,
"minLength": 1
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"has_more": {
"type": "boolean",
"title": "Has More"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"session_id",
"tasks",
"next_cursor",
"has_more"
],
"title": "ApiTaskTopologySessionBranch"
}
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"input_schema": {
"additionalProperties": true,
"type": "object",
"title": "Input Schema"
},
"parallel_safe": {
"type": "boolean",
"title": "Parallel Safe"
},
"effect": {
"type": "string",
"title": "Effect"
},
"workspace_mutation": {
"type": "boolean",
"title": "Workspace Mutation"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"description",
"input_schema",
"parallel_safe",
"effect",
"workspace_mutation"
],
"title": "ApiToolSummary"
}
{
"properties": {
"index": {
"type": "integer",
"minimum": 0.0,
"title": "Index"
},
"interaction_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Interaction Id"
},
"role": {
"type": "string",
"title": "Role"
},
"content": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Content"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"index",
"interaction_id",
"role",
"content"
],
"title": "ApiTranscriptMessage"
}
{
"properties": {
"isolation": {
"type": "boolean",
"title": "Isolation"
},
"net_changes": {
"type": "boolean",
"title": "Net Changes"
},
"publication": {
"type": "string",
"enum": [
"unsupported",
"cooperative_atomic"
],
"title": "Publication"
},
"recovery": {
"type": "string",
"enum": [
"unsupported",
"process_local",
"durable"
],
"title": "Recovery"
},
"retention": {
"type": "string",
"enum": [
"unsupported",
"process_local",
"durable"
],
"title": "Retention"
},
"lifecycle_inspection": {
"type": "string",
"enum": [
"unsupported",
"attached",
"recoverable_by_id"
],
"title": "Lifecycle Inspection"
},
"detail_code": {
"type": "string",
"title": "Detail Code"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"isolation",
"net_changes",
"publication",
"recovery",
"retention",
"lifecycle_inspection",
"detail_code"
],
"title": "ApiWorkspaceBranchCapabilities"
}
{
"properties": {
"attached_count": {
"type": "integer",
"maximum": 256.0,
"minimum": 0.0,
"title": "Attached Count"
},
"statuses": {
"items": {
"type": "string",
"enum": [
"active",
"publishing",
"rolling_back",
"committed",
"rolled_back",
"fenced"
]
},
"type": "array",
"maxItems": 256,
"title": "Statuses"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"attached_count",
"statuses",
"truncated"
],
"title": "ApiWorkspaceBranchLifecycle"
}
{
"properties": {
"artifact": {
"$ref": "#/components/schemas/ApiArtifactSummary"
},
"preview_base64": {
"type": "string",
"title": "Preview Base64"
},
"text_preview": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text Preview"
},
"total_bytes": {
"type": "integer",
"minimum": 0.0,
"title": "Total Bytes"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"artifact",
"preview_base64",
"text_preview",
"total_bytes",
"truncated"
],
"title": "ArtifactReadResponse"
}
{
"type": "string",
"enum": [
"session",
"environment"
],
"title": "ArtifactScope"
}
{
"properties": {
"fingerprint": {
"type": "string",
"maxLength": 71,
"pattern": "^sha256:[0-9a-f]{64}$",
"title": "Fingerprint"
},
"store_contract_operations": {
"prefixItems": [
{
"type": "string",
"const": "list"
},
{
"type": "string",
"const": "read"
},
{
"type": "string",
"const": "write"
},
{
"type": "string",
"const": "delete"
}
],
"type": "array",
"maxItems": 4,
"minItems": 4,
"title": "Store Contract Operations",
"default": [
"list",
"read",
"write",
"delete"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"fingerprint"
],
"title": "ArtifactStoreDiagnostic",
"description": "Path-safe registration identity and the required ArtifactStore contract."
}
{
"properties": {
"registrations": {
"items": {
"$ref": "#/components/schemas/ArtifactStoreDiagnostic"
},
"type": "array",
"maxItems": 64,
"title": "Registrations"
},
"total_count": {
"type": "integer",
"minimum": 0.0,
"title": "Total Count"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"registrations",
"total_count",
"truncated"
],
"title": "ArtifactStoreDiagnostics"
}
{
"properties": {
"artifacts": {
"items": {
"$ref": "#/components/schemas/ApiArtifactSummary"
},
"type": "array",
"title": "Artifacts"
},
"total_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Total Count"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
},
"limit": {
"type": "integer",
"minimum": 1.0,
"title": "Limit"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset"
},
"next_offset": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Next Offset"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"artifacts",
"truncated",
"limit",
"offset"
],
"title": "ArtifactsResponse"
}
{
"properties": {
"provider_name": {
"type": "string",
"title": "Provider Name"
},
"resource_id": {
"type": "string",
"title": "Resource Id"
},
"request_evidence": {
"additionalProperties": true,
"type": "object",
"title": "Request Evidence"
},
"completion_evidence": {
"additionalProperties": true,
"type": "object",
"title": "Completion Evidence"
},
"pricing_contexts": {
"items": {
"$ref": "#/components/schemas/PricingContext"
},
"type": "array",
"title": "Pricing Contexts",
"default": []
}
},
"additionalProperties": false,
"type": "object",
"required": [
"provider_name",
"resource_id"
],
"title": "BillingIdentity",
"description": "Provider-neutral commercial identity and possible pricing contexts.\n\nProviders own the meaning of their evidence. Core preserves it durably and\nenforces that completion cannot rewrite request evidence or widen the set of\npricing outcomes established before dispatch."
}
{
"properties": {
"module_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Module Url"
},
"types_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Types Url"
},
"version": {
"type": "string",
"const": "1",
"title": "Version",
"default": "1"
},
"guide_topic": {
"type": "string",
"const": "app-ui",
"title": "Guide Topic",
"default": "app-ui"
}
},
"additionalProperties": false,
"type": "object",
"title": "BrowserClientContract",
"description": "Where to load the dependency-free browser client served with the API.\n\n``module_url`` and ``types_url`` are ``None`` when the host did not serve\nthe module, for example when it composed ``create_router`` itself or used\nan API path whose last segment is not ``api``."
}
{
"properties": {
"scope": {
"type": "string",
"enum": [
"app",
"agent",
"causal",
"session",
"run"
],
"title": "Scope",
"default": "session"
},
"max_estimated_cost": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
}
],
"title": "Max Estimated Cost"
},
"pricing": {
"$ref": "#/components/schemas/PriceBook"
},
"currency": {
"type": "string",
"title": "Currency",
"default": "USD"
},
"window": {
"$ref": "#/components/schemas/BudgetWindow"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"allow_unpriced": {
"type": "boolean",
"title": "Allow Unpriced",
"default": false
},
"reservation": {
"anyOf": [
{
"$ref": "#/components/schemas/BudgetReservation"
},
{
"type": "null"
}
]
},
"action": {
"type": "string",
"enum": [
"interrupt",
"notify"
],
"title": "Action",
"default": "interrupt"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"max_estimated_cost",
"pricing"
],
"title": "BudgetLimit",
"description": "Estimated-cost budget that applies across one durable runtime scope."
}
{
"properties": {
"max_input_tokens": {
"type": "integer",
"maximum": 9.223372036854776e+18,
"minimum": 0.0,
"title": "Max Input Tokens"
},
"max_output_tokens": {
"type": "integer",
"maximum": 9.223372036854776e+18,
"minimum": 0.0,
"title": "Max Output Tokens"
},
"max_cache_read_input_tokens": {
"type": "integer",
"maximum": 9.223372036854776e+18,
"minimum": 0.0,
"title": "Max Cache Read Input Tokens",
"default": 0
},
"max_cache_write_input_tokens": {
"type": "integer",
"maximum": 9.223372036854776e+18,
"minimum": 0.0,
"title": "Max Cache Write Input Tokens",
"default": 0
}
},
"additionalProperties": false,
"type": "object",
"required": [
"max_input_tokens",
"max_output_tokens"
],
"title": "BudgetReservation",
"description": "Conservative per-model-step reservation configured by the app."
}
{
"properties": {
"kind": {
"type": "string",
"enum": [
"all_time",
"rolling",
"calendar"
],
"title": "Kind",
"default": "all_time"
},
"duration_seconds": {
"anyOf": [
{
"type": "integer",
"maximum": 9.223372036854776e+18,
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Duration Seconds"
},
"period": {
"anyOf": [
{
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
{
"type": "null"
}
],
"title": "Period"
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone"
}
},
"additionalProperties": false,
"type": "object",
"title": "BudgetWindow",
"description": "Time window used when selecting events for budget accounting."
}
{
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"unavailable_reason": {
"anyOf": [
{
"type": "string",
"enum": [
"not_configured",
"unsupported"
]
},
{
"type": "null"
}
],
"title": "Unavailable Reason"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"enabled"
],
"title": "CapabilityOperation",
"description": "Availability of one control-plane read or mutation operation."
}