# Agents streaming events > For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL. ## agent.session.environment.ready Emitted when a hosted session environment is ready to connect. ### Schema Schema name: `SessionEventAgentSessionEnvironmentReady` ```json { "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady", "docstring": "Emitted when a hosted session environment is ready to connect.", "ident": "AgentSessionEnvironmentReadyEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment" }, { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady/properties/environment", "deprecated": false, "key": "environment", "docstring": "The current environment state.", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionEnvironmentState", "$ref": "(resource) beta.agents > (model) agent_session_environment_state > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session_environment_state", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.environment.ready`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentReady/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.ready" } ] }, "default": "agent.session.environment.ready", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/error", "deprecated": false, "key": "error", "docstring": "An error reported while preparing a session environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" }, { "ident": "type" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "deprecated": false, "key": "status", "docstring": "The environment's connection status.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "pending" }, { "kind": "HttpTypeLiteral", "literal": "ready" }, { "kind": "HttpTypeLiteral", "literal": "connected" }, { "kind": "HttpTypeLiteral", "literal": "disconnected" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/type", "deprecated": false, "key": "type", "docstring": "The environment type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEnvironmentStateResource", "docstring": "The current state of a session environment.", "ident": "AgentSessionEnvironmentState", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "error" }, { "ident": "status" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_ready_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.ready" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A machine-readable error code.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/type", "deprecated": false, "key": "type", "docstring": "The error type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The environment is being prepared.", "type": { "kind": "HttpTypeLiteral", "literal": "pending" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The environment is ready to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "ready" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The environment is connected.", "type": { "kind": "HttpTypeLiteral", "literal": "connected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The environment is disconnected.", "type": { "kind": "HttpTypeLiteral", "literal": "disconnected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The environment failed to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } } } ``` ### Example ```json { "type": "agent.session.environment.ready", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "environment": { "id": "id", "type": "type", "status": "pending", "error": { "type": "type", "code": "code", "message": "message" } } } ``` ## agent.output.command_execution_output.delta Emitted when command execution produces an output delta. ### Schema Schema name: `SessionEventAgentOutputCommandExecutionOutputDelta` ```json { "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta", "docstring": "Emitted when command execution produces an output delta.", "ident": "AgentOutputCommandExecutionOutputDeltaEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "delta" }, { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) delta", "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/delta", "deprecated": false, "key": "delta", "docstring": "The output text that was appended.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the command execution item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.output.command_execution_output.delta`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentOutputCommandExecutionOutputDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.output.command_execution_output.delta" } ] }, "default": "agent.output.command_execution_output.delta", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_output_command_execution_output_delta_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.output.command_execution_output.delta" } } } ``` ### Example ```json { "type": "agent.output.command_execution_output.delta", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "delta": "delta" } ``` ## agent.session.created Emitted when a session is created. ### Schema Schema name: `SessionEventAgentSessionCreated` ```json { "(resource) beta.agents > (model) agent_session_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionCreated", "docstring": "Emitted when a session is created.", "ident": "AgentSessionCreatedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) session", "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionCreated/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) session": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionCreated/properties/session", "deprecated": false, "key": "session", "docstring": "The session that was created.", "type": { "kind": "HttpTypeReference", "ident": "AgentSession", "$ref": "(resource) beta.agents > (model) agent_session > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionCreated/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.created`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.created" } ] }, "default": "agent.session.created", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/agent", "deprecated": false, "key": "agent", "docstring": "The agent running in the session.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "instructions" }, { "ident": "model" }, { "ident": "multi_agent" }, { "ident": "name" }, { "ident": "reasoning" }, { "ident": "service_tier" }, { "ident": "text" }, { "ident": "tools" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, when the session was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/environment", "deprecated": false, "key": "environment", "docstring": "The execution environment for the session.", "type": { "kind": "HttpTypeReference", "ident": "Environment", "$ref": "(resource) beta.agents > (model) environment > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) environment", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error that caused the session to fail, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/last_active_at", "deprecated": false, "key": "last_active_at", "docstring": "The Unix timestamp, in seconds, when the session was last active.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "deprecated": false, "key": "metadata", "docstring": "Custom string key-value pairs attached to the session.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeString" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session" } ] }, "default": "agent.session", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "deprecated": false, "key": "required_actions", "docstring": "Actions that must be completed before the session can continue.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "elementType": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/required_actions/items", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] } ] } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the session.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "idle" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "requires_action" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "deprecated": false, "key": "vault_ids", "docstring": "The IDs of vaults made available to the session.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionResource", "docstring": "A Managed Agents session.", "ident": "AgentSession", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent" }, { "ident": "created_at" }, { "ident": "environment" }, { "ident": "error" }, { "ident": "last_active_at" }, { "ident": "metadata" }, { "ident": "object" }, { "ident": "required_actions" }, { "ident": "status" }, { "ident": "usage" }, { "ident": "vault_ids" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_created_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.created" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Custom instructions appended to the agent's default base instructions.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model used by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/multi_agent", "deprecated": false, "key": "multi_agent", "docstring": "Configuration for creating and coordinating subagents.", "type": { "kind": "HttpTypeReference", "ident": "MultiAgentConfig", "$ref": "(resource) beta.agents > (model) multi_agent_config > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) multi_agent_config", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The reusable agent's name when the session was created, or null if no name was saved. Later changes to the agent's name do not affect this value.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/reasoning", "deprecated": false, "key": "reasoning", "docstring": "The agent's reasoning configuration.", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoning", "$ref": "(resource) beta.agents > (model) agent_reasoning > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_reasoning", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "deprecated": false, "key": "service_tier", "docstring": "The effective service-tier policy for model requests. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" }, { "kind": "HttpTypeLiteral", "literal": "default" }, { "kind": "HttpTypeLiteral", "literal": "flex" }, { "kind": "HttpTypeLiteral", "literal": "priority" }, { "kind": "HttpTypeLiteral", "literal": "fast" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/text", "deprecated": false, "key": "text", "docstring": "Configuration for text generated by the agent.", "type": { "kind": "HttpTypeReference", "ident": "AgentText", "$ref": "(resource) beta.agents > (model) agent_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "deprecated": false, "key": "tools", "docstring": "Tools available to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "elementType": { "kind": "HttpTypeReference", "ident": "AgentTool", "$ref": "(resource) beta.agents > (model) agent_tool > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/0", "docstring": "The session talks to CCA without selecting or provisioning an execution environment.", "ident": "None", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/1", "docstring": "An environment hosted by OpenAI.", "ident": "OpenAIHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/2", "docstring": "An environment hosted by the application.", "ident": "SelfHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory" ] }, "(resource) beta.agents > (model) environment > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource", "docstring": "The execution environment for a session.", "ident": "Environment", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/0", "docstring": "Run a function tool and submit its result.", "ident": "FunctionCall", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/1", "docstring": "Reconnect a session environment.", "ident": "EnvironmentConnection", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The session has no turn in progress and is ready for input. A hosted environment may still be provisioning.", "type": { "kind": "HttpTypeLiteral", "literal": "idle" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session is processing a turn.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The session is waiting for one or more required actions.", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The session failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether subagent tools are enabled. Defaults to false.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/max_concurrent_subagents", "deprecated": false, "key": "max_concurrent_subagents", "docstring": "Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 1, "maximum": 4294967295 }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MultiAgentConfigResource", "docstring": "The resolved configuration for creating and coordinating subagents.", "ident": "MultiAgentConfig", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "max_concurrent_subagents" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "deprecated": false, "key": "effort", "docstring": "The amount of reasoning effort used by an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" }, { "kind": "HttpTypeLiteral", "literal": "minimal" }, { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" }, { "kind": "HttpTypeLiteral", "literal": "xhigh" }, { "kind": "HttpTypeLiteral", "literal": "max" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summary format requested from an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "types": [ { "kind": "HttpTypeLiteral", "literal": "concise" }, { "kind": "HttpTypeLiteral", "literal": "detailed" }, { "kind": "HttpTypeLiteral", "literal": "auto" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningResource", "docstring": "The reasoning configuration used by an agent.", "ident": "AgentReasoning", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "effort" }, { "ident": "summary" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "default" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "flex" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "priority" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "fast" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) format": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/format", "deprecated": false, "key": "format", "docstring": "The effective output format. Defaults to ordinary text.", "type": { "kind": "HttpTypeReference", "ident": "TextFormat", "$ref": "(resource) beta.agents > (model) text_format > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) text_format", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "deprecated": false, "key": "verbosity", "docstring": "The amount of text produced by the agent. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2" ] }, "(resource) beta.agents > (model) agent_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextResource", "docstring": "The text configuration used by an agent.", "ident": "AgentText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "format" }, { "ident": "verbosity" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/0", "docstring": "A function defined by the application.", "ident": "Function", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/1", "docstring": "Enables calling tools from model-generated code.", "ident": "ProgrammaticToolCalling", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/2", "docstring": "Tools provided by a remote MCP server.", "ident": "Mcp", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/3", "docstring": "Web search.", "ident": "WebSearch", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource", "docstring": "A tool available to the agent.", "ident": "AgentTool", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `none`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" } ] }, "default": "none", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "deprecated": false, "key": "files", "docstring": "Files available in the environment, excluding their contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "elementType": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFile", "$ref": "(resource) beta.agents > (model) hosted_environment_file > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/network", "deprecated": false, "key": "network", "docstring": "The effective network access policy for the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "access" }, { "ident": "allowed_domains" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/packages", "deprecated": false, "key": "packages", "docstring": "Packages installed in the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "npm" }, { "ident": "python" }, { "ident": "system" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "deprecated": false, "key": "plugins", "docstring": "Plugins installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "elementType": { "kind": "HttpTypeReference", "ident": "HostedPlugin", "$ref": "(resource) beta.agents > (model) hosted_plugin > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "deprecated": false, "key": "skills", "docstring": "Skills installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "elementType": { "kind": "HttpTypeReference", "ident": "HostedSkill", "$ref": "(resource) beta.agents > (model) hosted_skill > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `openai_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } ] }, "default": "openai_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/remote_url", "deprecated": false, "key": "remote_url", "docstring": "Pass this URL unchanged to `codex exec-server --remote` when connecting this environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `self_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "self_hosted" } ] }, "default": "self_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/workspace_directory", "deprecated": false, "key": "workspace_directory", "docstring": "The absolute project directory inside the environment. Defaults to `/workspace`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments supplied by the model.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID to include when submitting the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/name", "deprecated": false, "key": "name", "docstring": "The function name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that requested the function call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/environment_id", "deprecated": false, "key": "environment_id", "docstring": "The ID of the environment to reconnect.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `environment_connection`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "environment_connection" } ] }, "default": "environment_connection", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "minimal" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "xhigh" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "max" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0": { "kind": "HttpDeclReference", "docstring": "Returns a concise reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "concise" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1": { "kind": "HttpDeclReference", "docstring": "Returns a detailed reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "detailed" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2": { "kind": "HttpDeclReference", "docstring": "Automatically selects the most detailed summary supported by the model.", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/0", "docstring": "Generates ordinary text without a structured-output constraint.", "ident": "Text", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/1", "docstring": "Constrains generated text to a JSON Schema.", "ident": "JSONSchema", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource", "docstring": "The effective output format for generated text.", "ident": "TextFormat", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/defer_loading", "deprecated": false, "key": "defer_loading", "docstring": "Whether the function is deferred and discovered through tool search.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/description", "deprecated": false, "key": "description", "docstring": "A description of what the function does.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "deprecated": false, "key": "parameters", "docstring": "A JSON Schema object describing the function's arguments.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } ] }, "default": "function", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether tools can be called from model-generated code.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `programmatic_tool_calling`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } ] }, "default": "programmatic_tool_calling", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "deprecated": false, "key": "allowed_tools", "docstring": "The MCP tools the agent may call.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "deprecated": false, "key": "connection_origin", "docstring": "Where outbound MCP HTTP connections originate.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "types": [ { "kind": "HttpTypeLiteral", "literal": "service" }, { "kind": "HttpTypeLiteral", "literal": "environment" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/credential_id", "deprecated": false, "key": "credential_id", "docstring": "The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "deprecated": false, "key": "request_metadata", "docstring": "Metadata included with requests to this MCP server.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/required", "deprecated": false, "key": "required", "docstring": "Whether this MCP server must initialize before the first turn.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "A label used to identify the MCP server in tool calls.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/transport", "deprecated": false, "key": "transport", "docstring": "The transport used to connect to the MCP server.", "type": { "kind": "HttpTypeReference", "ident": "McpTransport", "$ref": "(resource) beta.agents > (model) mcp_transport > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) mcp_transport", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `mcp`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } ] }, "default": "mcp", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Allowed search domains, or `null` when the search is unrestricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "deprecated": false, "key": "context_size", "docstring": "The amount of search context made available to the model. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/location", "deprecated": false, "key": "location", "docstring": "Approximate user location used to localize web search results.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "city" }, { "ident": "country" }, { "ident": "region" }, { "ident": "timezone" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "deprecated": false, "key": "mode", "docstring": "The source used for web search results.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "cached" }, { "kind": "HttpTypeLiteral", "literal": "live" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `web_search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search" } ] }, "default": "web_search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource/oneOf/1", "docstring": "A file supplied inline when the session was created.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "docstring": "Metadata for a file materialized in an OpenAI-hosted execution environment.", "ident": "HostedEnvironmentFile", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "deprecated": false, "key": "access", "docstring": "The environment's network access mode.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "types": [ { "kind": "HttpTypeLiteral", "literal": "enabled" }, { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "restricted" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Domains the environment may access when network access is restricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "deprecated": false, "key": "npm", "docstring": "npm packages installed globally in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "deprecated": false, "key": "python", "docstring": "Python packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "deprecated": false, "key": "system", "docstring": "System packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed plugin description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed plugin name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_plugin > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedPluginResource", "docstring": "A plugin installed from an inline ZIP archive.", "ident": "HostedPlugin", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource/oneOf/1", "docstring": "A skill installed from an inline ZIP archive.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource", "docstring": "A skill installed in an OpenAI-hosted environment.", "ident": "HostedSkill", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "self_hosted" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment_connection" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } ] }, "default": "text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "deprecated": false, "key": "schema", "docstring": "The JSON Schema that generated text must match.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } ] }, "default": "json_schema", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "service" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/0", "docstring": "Connects to an MCP server over HTTP.", "ident": "HTTP", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/1", "docstring": "Starts an MCP server as a local process.", "ident": "Stdio", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource", "docstring": "The transport used to connect to an MCP server.", "ident": "McpTransport", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/city", "deprecated": false, "key": "city", "docstring": "The city name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/country", "deprecated": false, "key": "country", "docstring": "The two-letter ISO country code, such as `US`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/region", "deprecated": false, "key": "region", "docstring": "The region or state name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/timezone", "deprecated": false, "key": "timezone", "docstring": "The IANA timezone, such as `America/Los_Angeles`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cached" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "live" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search" } }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/file_id", "deprecated": false, "key": "file_id", "docstring": "The ID of the uploaded file.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `file_id`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_id" } ] }, "default": "file_id", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId", "docstring": "A file copied from the OpenAI Files API.", "ident": "HostedEnvironmentFileID", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "file_id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0": { "kind": "HttpDeclReference", "docstring": "Allows unrestricted network access.", "type": { "kind": "HttpTypeLiteral", "literal": "enabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1": { "kind": "HttpDeclReference", "docstring": "Disables network access.", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2": { "kind": "HttpDeclReference", "docstring": "Allows access only to configured domains.", "type": { "kind": "HttpTypeLiteral", "literal": "restricted" } }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/skill_id", "deprecated": false, "key": "skill_id", "docstring": "The referenced skill ID.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `skill_reference`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "skill_reference" } ] }, "default": "skill_reference", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/version", "deprecated": false, "key": "version", "docstring": "The concrete skill version installed for this session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference", "docstring": "A skill installed from the Skills API.", "ident": "HostedSkillReference", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "skill_id" }, { "ident": "type" }, { "ident": "version" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "json_schema" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/server_url", "deprecated": false, "key": "server_url", "docstring": "The URL of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `http`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http" } ] }, "default": "http", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "deprecated": false, "key": "args", "docstring": "Arguments passed to the MCP server command.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/command", "deprecated": false, "key": "command", "docstring": "The command used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "deprecated": false, "key": "env_vars", "docstring": "Environment variable names inherited from the execution environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `stdio`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "stdio" } ] }, "default": "stdio", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "file_id" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "skill_reference" } }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "http" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "stdio" } } } ``` ### Example ```json { "type": "agent.session.created", "event_id": "event_id", "session": { "metadata": { "foo": "string" }, "id": "id", "object": "agent.session", "created_at": 0, "last_active_at": 0, "status": "idle", "required_actions": [ { "type": "function_call", "turn_id": "turn_id", "call_id": "call_id", "name": "name", "arguments": {} } ], "error": "error", "agent": { "id": "id", "name": "name", "model": "model", "reasoning": { "effort": "none", "summary": "concise" }, "text": { "format": { "type": "text" }, "verbosity": "low" }, "service_tier": "auto", "instructions": "instructions", "tools": [ { "type": "function", "name": "name", "description": "description", "parameters": { "foo": "bar" }, "defer_loading": true } ], "multi_agent": { "enabled": true, "max_concurrent_subagents": 1 } }, "environment": { "type": "none" }, "vault_ids": [ "string" ], "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.turn.created Emitted when a turn is created. ### Schema Schema name: `SessionEventAgentSessionTurnCreated` ```json { "(resource) beta.agents > (model) agent_session_turn_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated", "docstring": "Emitted when a turn is created.", "ident": "AgentSessionTurnCreatedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) turn", "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) turn": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated/properties/turn", "deprecated": false, "key": "turn", "docstring": "The turn at the time it was created.", "type": { "kind": "HttpTypeReference", "ident": "Turn", "$ref": "(resource) beta.agents.sessions.turns > (model) turn > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents.sessions.turns > (model) turn", "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.created`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.created" } ] }, "default": "agent.session.turn.created", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that ran the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/completed_at", "deprecated": false, "key": "completed_at", "docstring": "The Unix timestamp, in seconds, when the turn reached a terminal state.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, used to order the turn by creation time. Subagent turns use their start time, falling back to completion time or the subagent opening time when the preceding timestamps are unavailable.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/error", "deprecated": false, "key": "error", "docstring": "A customer-safe error describing why a session request failed.", "type": { "kind": "HttpTypeReference", "ident": "SessionTurnError", "$ref": "(resource) beta.agents > (model) session_turn_error > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) session_turn_error", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.turn`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } ] }, "default": "agent.session.turn", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/started_at", "deprecated": false, "key": "started_at", "docstring": "The Unix timestamp, in seconds, when the turn started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the turn.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "queued" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "waiting" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "cancelled" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/subagent_id", "deprecated": false, "key": "subagent_id", "docstring": "The ID of the subagent that ran the turn, if applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TurnResource", "docstring": "The canonical public representation of a session turn.", "ident": "Turn", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "completed_at" }, { "ident": "created_at" }, { "ident": "error" }, { "ident": "object" }, { "ident": "session_id" }, { "ident": "started_at" }, { "ident": "status" }, { "ident": "subagent_id" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_created_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.created" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A stable, machine-readable failure category.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "types": [ { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" }, { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "server_overloaded" }, { "kind": "HttpTypeLiteral", "literal": "cyber_policy" }, { "kind": "HttpTypeLiteral", "literal": "connection_failed" }, { "kind": "HttpTypeLiteral", "literal": "server_error" }, { "kind": "HttpTypeLiteral", "literal": "authentication_error" }, { "kind": "HttpTypeLiteral", "literal": "invalid_request" }, { "kind": "HttpTypeLiteral", "literal": "resource_not_found" }, { "kind": "HttpTypeLiteral", "literal": "sandbox_error" }, { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" }, { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" }, { "kind": "HttpTypeLiteral", "literal": "request_timeout" }, { "kind": "HttpTypeLiteral", "literal": "internal_error" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A customer-safe explanation of the failure.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnErrorResource", "docstring": "A customer-safe error describing why a session request failed.", "ident": "SessionTurnError", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The turn is waiting to start.", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The turn is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The turn is waiting for external input.", "type": { "kind": "HttpTypeLiteral", "literal": "waiting" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The turn completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The turn failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "docstring": "The turn was cancelled.", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0": { "kind": "HttpDeclReference", "docstring": "The request exceeds the model's context window.", "type": { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session has reached its usage budget.", "type": { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2": { "kind": "HttpDeclReference", "docstring": "The organization has reached a usage, plan, or billing limit.", "type": { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3": { "kind": "HttpDeclReference", "docstring": "The organization has no API credits remaining.", "type": { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4": { "kind": "HttpDeclReference", "docstring": "The request exceeds the available rate limit.", "type": { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5": { "kind": "HttpDeclReference", "docstring": "The model service is temporarily overloaded.", "type": { "kind": "HttpTypeLiteral", "literal": "server_overloaded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6": { "kind": "HttpDeclReference", "docstring": "The request was rejected by a safety policy.", "type": { "kind": "HttpTypeLiteral", "literal": "cyber_policy" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7": { "kind": "HttpDeclReference", "docstring": "The request could not connect to the model service.", "type": { "kind": "HttpTypeLiteral", "literal": "connection_failed" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8": { "kind": "HttpDeclReference", "docstring": "The model service encountered an unexpected error.", "type": { "kind": "HttpTypeLiteral", "literal": "server_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9": { "kind": "HttpDeclReference", "docstring": "The API credentials are invalid or lack the required access.", "type": { "kind": "HttpTypeLiteral", "literal": "authentication_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10": { "kind": "HttpDeclReference", "docstring": "The request contains invalid input or configuration.", "type": { "kind": "HttpTypeLiteral", "literal": "invalid_request" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11": { "kind": "HttpDeclReference", "docstring": "The requested model or resource is unavailable.", "type": { "kind": "HttpTypeLiteral", "literal": "resource_not_found" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12": { "kind": "HttpDeclReference", "docstring": "The request could not complete in its execution environment.", "type": { "kind": "HttpTypeLiteral", "literal": "sandbox_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13": { "kind": "HttpDeclReference", "docstring": "The executor must be upgraded before it can run this turn.", "type": { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14": { "kind": "HttpDeclReference", "docstring": "The session cannot accept additional input while a request is running.", "type": { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15": { "kind": "HttpDeclReference", "docstring": "The request timed out before the model service responded.", "type": { "kind": "HttpTypeLiteral", "literal": "request_timeout" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16": { "kind": "HttpDeclReference", "docstring": "An unexpected internal error prevented the session request from completing.", "type": { "kind": "HttpTypeLiteral", "literal": "internal_error" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] } } ``` ### Example ```json { "type": "agent.session.turn.created", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "turn": { "id": "id", "object": "agent.session.turn", "session_id": "session_id", "agent_id": "agent_id", "subagent_id": "subagent_id", "status": "queued", "created_at": 0, "started_at": 0, "completed_at": 0, "error": { "code": "context_length_exceeded", "message": "message" }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.turn.in_progress Emitted when a turn starts running. ### Schema Schema name: `SessionEventAgentSessionTurnInProgress` ```json { "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress", "docstring": "Emitted when a turn starts running.", "ident": "AgentSessionTurnInProgressEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) turn", "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) turn": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress/properties/turn", "deprecated": false, "key": "turn", "docstring": "The turn at the time it started running.", "type": { "kind": "HttpTypeReference", "ident": "Turn", "$ref": "(resource) beta.agents.sessions.turns > (model) turn > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents.sessions.turns > (model) turn", "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.in_progress`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnInProgress/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.in_progress" } ] }, "default": "agent.session.turn.in_progress", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that ran the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/completed_at", "deprecated": false, "key": "completed_at", "docstring": "The Unix timestamp, in seconds, when the turn reached a terminal state.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, used to order the turn by creation time. Subagent turns use their start time, falling back to completion time or the subagent opening time when the preceding timestamps are unavailable.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/error", "deprecated": false, "key": "error", "docstring": "A customer-safe error describing why a session request failed.", "type": { "kind": "HttpTypeReference", "ident": "SessionTurnError", "$ref": "(resource) beta.agents > (model) session_turn_error > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) session_turn_error", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.turn`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } ] }, "default": "agent.session.turn", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/started_at", "deprecated": false, "key": "started_at", "docstring": "The Unix timestamp, in seconds, when the turn started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the turn.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "queued" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "waiting" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "cancelled" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/subagent_id", "deprecated": false, "key": "subagent_id", "docstring": "The ID of the subagent that ran the turn, if applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TurnResource", "docstring": "The canonical public representation of a session turn.", "ident": "Turn", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "completed_at" }, { "ident": "created_at" }, { "ident": "error" }, { "ident": "object" }, { "ident": "session_id" }, { "ident": "started_at" }, { "ident": "status" }, { "ident": "subagent_id" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_in_progress_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.in_progress" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A stable, machine-readable failure category.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "types": [ { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" }, { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "server_overloaded" }, { "kind": "HttpTypeLiteral", "literal": "cyber_policy" }, { "kind": "HttpTypeLiteral", "literal": "connection_failed" }, { "kind": "HttpTypeLiteral", "literal": "server_error" }, { "kind": "HttpTypeLiteral", "literal": "authentication_error" }, { "kind": "HttpTypeLiteral", "literal": "invalid_request" }, { "kind": "HttpTypeLiteral", "literal": "resource_not_found" }, { "kind": "HttpTypeLiteral", "literal": "sandbox_error" }, { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" }, { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" }, { "kind": "HttpTypeLiteral", "literal": "request_timeout" }, { "kind": "HttpTypeLiteral", "literal": "internal_error" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A customer-safe explanation of the failure.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnErrorResource", "docstring": "A customer-safe error describing why a session request failed.", "ident": "SessionTurnError", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The turn is waiting to start.", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The turn is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The turn is waiting for external input.", "type": { "kind": "HttpTypeLiteral", "literal": "waiting" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The turn completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The turn failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "docstring": "The turn was cancelled.", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0": { "kind": "HttpDeclReference", "docstring": "The request exceeds the model's context window.", "type": { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session has reached its usage budget.", "type": { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2": { "kind": "HttpDeclReference", "docstring": "The organization has reached a usage, plan, or billing limit.", "type": { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3": { "kind": "HttpDeclReference", "docstring": "The organization has no API credits remaining.", "type": { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4": { "kind": "HttpDeclReference", "docstring": "The request exceeds the available rate limit.", "type": { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5": { "kind": "HttpDeclReference", "docstring": "The model service is temporarily overloaded.", "type": { "kind": "HttpTypeLiteral", "literal": "server_overloaded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6": { "kind": "HttpDeclReference", "docstring": "The request was rejected by a safety policy.", "type": { "kind": "HttpTypeLiteral", "literal": "cyber_policy" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7": { "kind": "HttpDeclReference", "docstring": "The request could not connect to the model service.", "type": { "kind": "HttpTypeLiteral", "literal": "connection_failed" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8": { "kind": "HttpDeclReference", "docstring": "The model service encountered an unexpected error.", "type": { "kind": "HttpTypeLiteral", "literal": "server_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9": { "kind": "HttpDeclReference", "docstring": "The API credentials are invalid or lack the required access.", "type": { "kind": "HttpTypeLiteral", "literal": "authentication_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10": { "kind": "HttpDeclReference", "docstring": "The request contains invalid input or configuration.", "type": { "kind": "HttpTypeLiteral", "literal": "invalid_request" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11": { "kind": "HttpDeclReference", "docstring": "The requested model or resource is unavailable.", "type": { "kind": "HttpTypeLiteral", "literal": "resource_not_found" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12": { "kind": "HttpDeclReference", "docstring": "The request could not complete in its execution environment.", "type": { "kind": "HttpTypeLiteral", "literal": "sandbox_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13": { "kind": "HttpDeclReference", "docstring": "The executor must be upgraded before it can run this turn.", "type": { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14": { "kind": "HttpDeclReference", "docstring": "The session cannot accept additional input while a request is running.", "type": { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15": { "kind": "HttpDeclReference", "docstring": "The request timed out before the model service responded.", "type": { "kind": "HttpTypeLiteral", "literal": "request_timeout" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16": { "kind": "HttpDeclReference", "docstring": "An unexpected internal error prevented the session request from completing.", "type": { "kind": "HttpTypeLiteral", "literal": "internal_error" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] } } ``` ### Example ```json { "type": "agent.session.turn.in_progress", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "turn": { "id": "id", "object": "agent.session.turn", "session_id": "session_id", "agent_id": "agent_id", "subagent_id": "subagent_id", "status": "queued", "created_at": 0, "started_at": 0, "completed_at": 0, "error": { "code": "context_length_exceeded", "message": "message" }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.turn.completed Emitted when a turn completes. ### Schema Schema name: `SessionEventAgentSessionTurnCompleted` ```json { "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted", "docstring": "Emitted when a turn completes.", "ident": "AgentSessionTurnCompletedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn" }, { "ident": "turn_id" }, { "ident": "type" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) turn", "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) type", "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) turn": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/turn", "deprecated": false, "key": "turn", "docstring": "The completed turn.", "type": { "kind": "HttpTypeReference", "ident": "Turn", "$ref": "(resource) beta.agents.sessions.turns > (model) turn > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents.sessions.turns > (model) turn", "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.completed`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.completed" } ] }, "default": "agent.session.turn.completed", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCompleted/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that ran the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/completed_at", "deprecated": false, "key": "completed_at", "docstring": "The Unix timestamp, in seconds, when the turn reached a terminal state.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, used to order the turn by creation time. Subagent turns use their start time, falling back to completion time or the subagent opening time when the preceding timestamps are unavailable.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/error", "deprecated": false, "key": "error", "docstring": "A customer-safe error describing why a session request failed.", "type": { "kind": "HttpTypeReference", "ident": "SessionTurnError", "$ref": "(resource) beta.agents > (model) session_turn_error > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) session_turn_error", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.turn`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } ] }, "default": "agent.session.turn", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/started_at", "deprecated": false, "key": "started_at", "docstring": "The Unix timestamp, in seconds, when the turn started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the turn.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "queued" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "waiting" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "cancelled" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/subagent_id", "deprecated": false, "key": "subagent_id", "docstring": "The ID of the subagent that ran the turn, if applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TurnResource", "docstring": "The canonical public representation of a session turn.", "ident": "Turn", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "completed_at" }, { "ident": "created_at" }, { "ident": "error" }, { "ident": "object" }, { "ident": "session_id" }, { "ident": "started_at" }, { "ident": "status" }, { "ident": "subagent_id" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_completed_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.completed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A stable, machine-readable failure category.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "types": [ { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" }, { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "server_overloaded" }, { "kind": "HttpTypeLiteral", "literal": "cyber_policy" }, { "kind": "HttpTypeLiteral", "literal": "connection_failed" }, { "kind": "HttpTypeLiteral", "literal": "server_error" }, { "kind": "HttpTypeLiteral", "literal": "authentication_error" }, { "kind": "HttpTypeLiteral", "literal": "invalid_request" }, { "kind": "HttpTypeLiteral", "literal": "resource_not_found" }, { "kind": "HttpTypeLiteral", "literal": "sandbox_error" }, { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" }, { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" }, { "kind": "HttpTypeLiteral", "literal": "request_timeout" }, { "kind": "HttpTypeLiteral", "literal": "internal_error" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A customer-safe explanation of the failure.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnErrorResource", "docstring": "A customer-safe error describing why a session request failed.", "ident": "SessionTurnError", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The turn is waiting to start.", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The turn is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The turn is waiting for external input.", "type": { "kind": "HttpTypeLiteral", "literal": "waiting" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The turn completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The turn failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "docstring": "The turn was cancelled.", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0": { "kind": "HttpDeclReference", "docstring": "The request exceeds the model's context window.", "type": { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session has reached its usage budget.", "type": { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2": { "kind": "HttpDeclReference", "docstring": "The organization has reached a usage, plan, or billing limit.", "type": { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3": { "kind": "HttpDeclReference", "docstring": "The organization has no API credits remaining.", "type": { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4": { "kind": "HttpDeclReference", "docstring": "The request exceeds the available rate limit.", "type": { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5": { "kind": "HttpDeclReference", "docstring": "The model service is temporarily overloaded.", "type": { "kind": "HttpTypeLiteral", "literal": "server_overloaded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6": { "kind": "HttpDeclReference", "docstring": "The request was rejected by a safety policy.", "type": { "kind": "HttpTypeLiteral", "literal": "cyber_policy" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7": { "kind": "HttpDeclReference", "docstring": "The request could not connect to the model service.", "type": { "kind": "HttpTypeLiteral", "literal": "connection_failed" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8": { "kind": "HttpDeclReference", "docstring": "The model service encountered an unexpected error.", "type": { "kind": "HttpTypeLiteral", "literal": "server_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9": { "kind": "HttpDeclReference", "docstring": "The API credentials are invalid or lack the required access.", "type": { "kind": "HttpTypeLiteral", "literal": "authentication_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10": { "kind": "HttpDeclReference", "docstring": "The request contains invalid input or configuration.", "type": { "kind": "HttpTypeLiteral", "literal": "invalid_request" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11": { "kind": "HttpDeclReference", "docstring": "The requested model or resource is unavailable.", "type": { "kind": "HttpTypeLiteral", "literal": "resource_not_found" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12": { "kind": "HttpDeclReference", "docstring": "The request could not complete in its execution environment.", "type": { "kind": "HttpTypeLiteral", "literal": "sandbox_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13": { "kind": "HttpDeclReference", "docstring": "The executor must be upgraded before it can run this turn.", "type": { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14": { "kind": "HttpDeclReference", "docstring": "The session cannot accept additional input while a request is running.", "type": { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15": { "kind": "HttpDeclReference", "docstring": "The request timed out before the model service responded.", "type": { "kind": "HttpTypeLiteral", "literal": "request_timeout" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16": { "kind": "HttpDeclReference", "docstring": "An unexpected internal error prevented the session request from completing.", "type": { "kind": "HttpTypeLiteral", "literal": "internal_error" } } } ``` ### Example ```json { "type": "agent.session.turn.completed", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "turn": { "id": "id", "object": "agent.session.turn", "session_id": "session_id", "agent_id": "agent_id", "subagent_id": "subagent_id", "status": "queued", "created_at": 0, "started_at": 0, "completed_at": 0, "error": { "code": "context_length_exceeded", "message": "message" }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } ``` ## agent.session.turn.failed Emitted when a turn fails. ### Schema Schema name: `SessionEventAgentSessionTurnFailed` ```json { "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed", "docstring": "Emitted when a turn fails.", "ident": "AgentSessionTurnFailedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn" }, { "ident": "turn_id" }, { "ident": "type" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) turn", "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) type", "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) turn": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/turn", "deprecated": false, "key": "turn", "docstring": "The failed turn.", "type": { "kind": "HttpTypeReference", "ident": "Turn", "$ref": "(resource) beta.agents.sessions.turns > (model) turn > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents.sessions.turns > (model) turn", "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.failed`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.failed" } ] }, "default": "agent.session.turn.failed", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnFailed/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that ran the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/completed_at", "deprecated": false, "key": "completed_at", "docstring": "The Unix timestamp, in seconds, when the turn reached a terminal state.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, used to order the turn by creation time. Subagent turns use their start time, falling back to completion time or the subagent opening time when the preceding timestamps are unavailable.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/error", "deprecated": false, "key": "error", "docstring": "A customer-safe error describing why a session request failed.", "type": { "kind": "HttpTypeReference", "ident": "SessionTurnError", "$ref": "(resource) beta.agents > (model) session_turn_error > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) session_turn_error", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.turn`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } ] }, "default": "agent.session.turn", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/started_at", "deprecated": false, "key": "started_at", "docstring": "The Unix timestamp, in seconds, when the turn started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the turn.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "queued" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "waiting" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "cancelled" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/subagent_id", "deprecated": false, "key": "subagent_id", "docstring": "The ID of the subagent that ran the turn, if applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TurnResource", "docstring": "The canonical public representation of a session turn.", "ident": "Turn", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "completed_at" }, { "ident": "created_at" }, { "ident": "error" }, { "ident": "object" }, { "ident": "session_id" }, { "ident": "started_at" }, { "ident": "status" }, { "ident": "subagent_id" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_failed_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.failed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A stable, machine-readable failure category.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "types": [ { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" }, { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "server_overloaded" }, { "kind": "HttpTypeLiteral", "literal": "cyber_policy" }, { "kind": "HttpTypeLiteral", "literal": "connection_failed" }, { "kind": "HttpTypeLiteral", "literal": "server_error" }, { "kind": "HttpTypeLiteral", "literal": "authentication_error" }, { "kind": "HttpTypeLiteral", "literal": "invalid_request" }, { "kind": "HttpTypeLiteral", "literal": "resource_not_found" }, { "kind": "HttpTypeLiteral", "literal": "sandbox_error" }, { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" }, { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" }, { "kind": "HttpTypeLiteral", "literal": "request_timeout" }, { "kind": "HttpTypeLiteral", "literal": "internal_error" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A customer-safe explanation of the failure.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnErrorResource", "docstring": "A customer-safe error describing why a session request failed.", "ident": "SessionTurnError", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The turn is waiting to start.", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The turn is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The turn is waiting for external input.", "type": { "kind": "HttpTypeLiteral", "literal": "waiting" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The turn completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The turn failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "docstring": "The turn was cancelled.", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0": { "kind": "HttpDeclReference", "docstring": "The request exceeds the model's context window.", "type": { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session has reached its usage budget.", "type": { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2": { "kind": "HttpDeclReference", "docstring": "The organization has reached a usage, plan, or billing limit.", "type": { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3": { "kind": "HttpDeclReference", "docstring": "The organization has no API credits remaining.", "type": { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4": { "kind": "HttpDeclReference", "docstring": "The request exceeds the available rate limit.", "type": { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5": { "kind": "HttpDeclReference", "docstring": "The model service is temporarily overloaded.", "type": { "kind": "HttpTypeLiteral", "literal": "server_overloaded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6": { "kind": "HttpDeclReference", "docstring": "The request was rejected by a safety policy.", "type": { "kind": "HttpTypeLiteral", "literal": "cyber_policy" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7": { "kind": "HttpDeclReference", "docstring": "The request could not connect to the model service.", "type": { "kind": "HttpTypeLiteral", "literal": "connection_failed" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8": { "kind": "HttpDeclReference", "docstring": "The model service encountered an unexpected error.", "type": { "kind": "HttpTypeLiteral", "literal": "server_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9": { "kind": "HttpDeclReference", "docstring": "The API credentials are invalid or lack the required access.", "type": { "kind": "HttpTypeLiteral", "literal": "authentication_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10": { "kind": "HttpDeclReference", "docstring": "The request contains invalid input or configuration.", "type": { "kind": "HttpTypeLiteral", "literal": "invalid_request" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11": { "kind": "HttpDeclReference", "docstring": "The requested model or resource is unavailable.", "type": { "kind": "HttpTypeLiteral", "literal": "resource_not_found" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12": { "kind": "HttpDeclReference", "docstring": "The request could not complete in its execution environment.", "type": { "kind": "HttpTypeLiteral", "literal": "sandbox_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13": { "kind": "HttpDeclReference", "docstring": "The executor must be upgraded before it can run this turn.", "type": { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14": { "kind": "HttpDeclReference", "docstring": "The session cannot accept additional input while a request is running.", "type": { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15": { "kind": "HttpDeclReference", "docstring": "The request timed out before the model service responded.", "type": { "kind": "HttpTypeLiteral", "literal": "request_timeout" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16": { "kind": "HttpDeclReference", "docstring": "An unexpected internal error prevented the session request from completing.", "type": { "kind": "HttpTypeLiteral", "literal": "internal_error" } } } ``` ### Example ```json { "type": "agent.session.turn.failed", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "turn": { "id": "id", "object": "agent.session.turn", "session_id": "session_id", "agent_id": "agent_id", "subagent_id": "subagent_id", "status": "queued", "created_at": 0, "started_at": 0, "completed_at": 0, "error": { "code": "context_length_exceeded", "message": "message" }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } ``` ## agent.session.turn.cancelled Emitted when a turn is cancelled. ### Schema Schema name: `SessionEventAgentSessionTurnCancelled` ```json { "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled", "docstring": "Emitted when a turn is cancelled.", "ident": "AgentSessionTurnCancelledEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn" }, { "ident": "turn_id" }, { "ident": "type" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) turn", "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) type", "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) turn": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/turn", "deprecated": false, "key": "turn", "docstring": "The cancelled turn.", "type": { "kind": "HttpTypeReference", "ident": "Turn", "$ref": "(resource) beta.agents.sessions.turns > (model) turn > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents.sessions.turns > (model) turn", "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.cancelled`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.cancelled" } ] }, "default": "agent.session.turn.cancelled", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnCancelled/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that ran the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/completed_at", "deprecated": false, "key": "completed_at", "docstring": "The Unix timestamp, in seconds, when the turn reached a terminal state.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, used to order the turn by creation time. Subagent turns use their start time, falling back to completion time or the subagent opening time when the preceding timestamps are unavailable.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/error", "deprecated": false, "key": "error", "docstring": "A customer-safe error describing why a session request failed.", "type": { "kind": "HttpTypeReference", "ident": "SessionTurnError", "$ref": "(resource) beta.agents > (model) session_turn_error > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) session_turn_error", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.turn`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } ] }, "default": "agent.session.turn", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the turn.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/started_at", "deprecated": false, "key": "started_at", "docstring": "The Unix timestamp, in seconds, when the turn started.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the turn.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TurnResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "queued" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "waiting" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "cancelled" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/subagent_id", "deprecated": false, "key": "subagent_id", "docstring": "The ID of the subagent that ran the turn, if applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TurnResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TurnResource", "docstring": "The canonical public representation of a session turn.", "ident": "Turn", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "completed_at" }, { "ident": "created_at" }, { "ident": "error" }, { "ident": "object" }, { "ident": "session_id" }, { "ident": "started_at" }, { "ident": "status" }, { "ident": "subagent_id" }, { "ident": "usage" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) agent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) completed_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) created_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) error", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) session_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) started_at", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) subagent_id", "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) usage" ] }, "(resource) beta.agents > (model) agent_session_turn_cancelled_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.cancelled" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A stable, machine-readable failure category.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/code", "types": [ { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" }, { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" }, { "kind": "HttpTypeLiteral", "literal": "server_overloaded" }, { "kind": "HttpTypeLiteral", "literal": "cyber_policy" }, { "kind": "HttpTypeLiteral", "literal": "connection_failed" }, { "kind": "HttpTypeLiteral", "literal": "server_error" }, { "kind": "HttpTypeLiteral", "literal": "authentication_error" }, { "kind": "HttpTypeLiteral", "literal": "invalid_request" }, { "kind": "HttpTypeLiteral", "literal": "resource_not_found" }, { "kind": "HttpTypeLiteral", "literal": "sandbox_error" }, { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" }, { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" }, { "kind": "HttpTypeLiteral", "literal": "request_timeout" }, { "kind": "HttpTypeLiteral", "literal": "internal_error" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16" ] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionTurnErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A customer-safe explanation of the failure.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnErrorResource", "docstring": "A customer-safe error describing why a session request failed.", "ident": "SessionTurnError", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code", "(resource) beta.agents > (model) session_turn_error > (schema) > (property) message" ] }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The turn is waiting to start.", "type": { "kind": "HttpTypeLiteral", "literal": "queued" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The turn is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The turn is waiting for external input.", "type": { "kind": "HttpTypeLiteral", "literal": "waiting" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The turn completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The turn failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents.sessions.turns > (model) turn > (schema) > (property) status > (member) 5": { "kind": "HttpDeclReference", "docstring": "The turn was cancelled.", "type": { "kind": "HttpTypeLiteral", "literal": "cancelled" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 0": { "kind": "HttpDeclReference", "docstring": "The request exceeds the model's context window.", "type": { "kind": "HttpTypeLiteral", "literal": "context_length_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session has reached its usage budget.", "type": { "kind": "HttpTypeLiteral", "literal": "session_budget_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 2": { "kind": "HttpDeclReference", "docstring": "The organization has reached a usage, plan, or billing limit.", "type": { "kind": "HttpTypeLiteral", "literal": "usage_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 3": { "kind": "HttpDeclReference", "docstring": "The organization has no API credits remaining.", "type": { "kind": "HttpTypeLiteral", "literal": "credit_balance_exhausted" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 4": { "kind": "HttpDeclReference", "docstring": "The request exceeds the available rate limit.", "type": { "kind": "HttpTypeLiteral", "literal": "rate_limit_exceeded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 5": { "kind": "HttpDeclReference", "docstring": "The model service is temporarily overloaded.", "type": { "kind": "HttpTypeLiteral", "literal": "server_overloaded" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 6": { "kind": "HttpDeclReference", "docstring": "The request was rejected by a safety policy.", "type": { "kind": "HttpTypeLiteral", "literal": "cyber_policy" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 7": { "kind": "HttpDeclReference", "docstring": "The request could not connect to the model service.", "type": { "kind": "HttpTypeLiteral", "literal": "connection_failed" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 8": { "kind": "HttpDeclReference", "docstring": "The model service encountered an unexpected error.", "type": { "kind": "HttpTypeLiteral", "literal": "server_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 9": { "kind": "HttpDeclReference", "docstring": "The API credentials are invalid or lack the required access.", "type": { "kind": "HttpTypeLiteral", "literal": "authentication_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 10": { "kind": "HttpDeclReference", "docstring": "The request contains invalid input or configuration.", "type": { "kind": "HttpTypeLiteral", "literal": "invalid_request" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 11": { "kind": "HttpDeclReference", "docstring": "The requested model or resource is unavailable.", "type": { "kind": "HttpTypeLiteral", "literal": "resource_not_found" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 12": { "kind": "HttpDeclReference", "docstring": "The request could not complete in its execution environment.", "type": { "kind": "HttpTypeLiteral", "literal": "sandbox_error" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 13": { "kind": "HttpDeclReference", "docstring": "The executor must be upgraded before it can run this turn.", "type": { "kind": "HttpTypeLiteral", "literal": "executor_version_incompatible" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 14": { "kind": "HttpDeclReference", "docstring": "The session cannot accept additional input while a request is running.", "type": { "kind": "HttpTypeLiteral", "literal": "active_turn_not_steerable" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 15": { "kind": "HttpDeclReference", "docstring": "The request timed out before the model service responded.", "type": { "kind": "HttpTypeLiteral", "literal": "request_timeout" } }, "(resource) beta.agents > (model) session_turn_error > (schema) > (property) code > (member) 16": { "kind": "HttpDeclReference", "docstring": "An unexpected internal error prevented the session request from completing.", "type": { "kind": "HttpTypeLiteral", "literal": "internal_error" } } } ``` ### Example ```json { "type": "agent.session.turn.cancelled", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "turn": { "id": "id", "object": "agent.session.turn", "session_id": "session_id", "agent_id": "agent_id", "subagent_id": "subagent_id", "status": "queued", "created_at": 0, "started_at": 0, "completed_at": 0, "error": { "code": "context_length_exceeded", "message": "message" }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } }, "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } ``` ## agent.session.turn.item.added Emitted when an item is added to a turn. ### Schema Schema name: `SessionEventAgentSessionTurnItemAdded` ```json { "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded", "docstring": "Emitted when an item is added to a turn.", "ident": "AgentSessionTurnItemAddedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "item" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) item", "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) item": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/item", "deprecated": false, "key": "item", "docstring": "The item that was added.", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionItem", "$ref": "(resource) beta.agents > (model) agent_session_item > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) agent_session_item", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 5", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 6", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 7", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 8", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 9", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 10", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 11", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 12", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 13" ] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output, when the item is agent output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.item.added`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemAdded/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.item.added" } ] }, "default": "agent.session.turn.item.added", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionMessage", "$ref": "(resource) beta.agents > (model) agent_session_message > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_message > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) content", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoningItem", "$ref": "(resource) beta.agents > (model) agent_reasoning_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) summary", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallItem", "$ref": "(resource) beta.agents > (model) agent_function_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) call_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnItemResource/oneOf/3", "docstring": "The result supplied for a function call.", "ident": "FunctionCallOutput", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "call_id" }, { "ident": "error" }, { "ident": "output" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) call_id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) error", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) output", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) status", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) turn_id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnItemResource/oneOf/4", "docstring": "A message exchanged between agent threads.", "ident": "AgentMessage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "content" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) content", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) sender_agent_id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) turn_id", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentMcpCallItem", "$ref": "(resource) beta.agents > (model) agent_mcp_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) error", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) server_label", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentWebSearchCallItem", "$ref": "(resource) beta.agents > (model) agent_web_search_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) action", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentCommandExecutionItem", "$ref": "(resource) beta.agents > (model) agent_command_execution_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) command", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) cwd", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) duration_ms", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) exit_code", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentCreateSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) agent_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) model", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) reasoning_effort", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 9": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentSendSubagentInputCallItem", "$ref": "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 10": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentResumeSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 11": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentWaitForSubagentsCallItem", "$ref": "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) recipient_agent_ids", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 12": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentInterruptSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 13": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentCloseSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionTurnItemResource", "docstring": "An item associated with a session turn.", "ident": "AgentSessionItem", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionTurnItemResource", "types": [ { "kind": "HttpTypeReference", "ident": "AgentSessionMessage", "$ref": "(resource) beta.agents > (model) agent_session_message > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentReasoningItem", "$ref": "(resource) beta.agents > (model) agent_reasoning_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentFunctionCallItem", "$ref": "(resource) beta.agents > (model) agent_function_call_item > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "call_id" }, { "ident": "error" }, { "ident": "output" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "content" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeReference", "ident": "AgentMcpCallItem", "$ref": "(resource) beta.agents > (model) agent_mcp_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentWebSearchCallItem", "$ref": "(resource) beta.agents > (model) agent_web_search_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentCommandExecutionItem", "$ref": "(resource) beta.agents > (model) agent_command_execution_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentCreateSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentSendSubagentInputCallItem", "$ref": "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentResumeSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentWaitForSubagentsCallItem", "$ref": "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentInterruptSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentCloseSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema)" } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 5", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 6", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 7", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 8", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 9", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 10", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 11", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 12", "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 13" ] }, "(resource) beta.agents > (model) agent_session_turn_item_added_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.item.added" } }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of this item, or null for legacy user messages whose ID was not recorded.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The content of the message. User messages contain input text or images; assistant messages contain output text.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/MessageItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "AgentSessionMessageContent", "$ref": "(resource) beta.agents > (model) agent_session_message_content > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/phase", "deprecated": false, "key": "phase", "docstring": "The phase of an assistant message.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageItemResource/properties/phase", "types": [ { "kind": "HttpTypeLiteral", "literal": "commentary" }, { "kind": "HttpTypeLiteral", "literal": "final_answer" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase > (member) 0", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase > (member) 1" ] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/role", "deprecated": false, "key": "role", "docstring": "The role of the message author.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageItemResource/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" }, { "kind": "HttpTypeLiteral", "literal": "assistant" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role > (member) 0", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role > (member) 1" ] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the message. User messages are always `completed`.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItemStatus", "$ref": "(resource) beta.agents > (model) agent_output_item_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_output_item_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `message`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } ] }, "default": "message", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_message > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageItemResource", "docstring": "A user or assistant message recorded in a session.", "ident": "AgentSessionMessage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "content" }, { "ident": "phase" }, { "ident": "role" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_message > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) content", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_message > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the reasoning item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of an agent output item.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItemStatus", "$ref": "(resource) beta.agents > (model) agent_output_item_status > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_output_item_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summaries produced by the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/ReasoningItemResource/properties/summary", "elementType": { "kind": "HttpTypeReference", "ident": "SummaryText", "$ref": "(resource) beta.agents > (model) summary_text > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `reasoning`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "reasoning" } ] }, "default": "reasoning", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningItemResource", "docstring": "A reasoning item produced by the agent.", "ident": "AgentReasoningItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "status" }, { "ident": "summary" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) summary", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the function call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments to pass to the function.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID used to submit the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the function call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallItemResource", "docstring": "A function call produced by the agent.", "ident": "AgentFunctionCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) call_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the function call output item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID of the function call that produced this output.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error message, if the call failed.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) output": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/output", "deprecated": false, "key": "output", "docstring": "The text or model-input content supplied as a function result.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallOutput", "$ref": "(resource) beta.agents > (model) agent_function_call_output > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) agent_function_call_output", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_function_call_output > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_function_call_output > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the function call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/FunctionCallOutputItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } ] }, "default": "function_call_output", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The content exchanged between the agents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID or name of the receiving agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID or name of the sending agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `agent_message`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentMessageItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent_message" } ] }, "default": "agent_message", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the MCP call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments passed to the MCP tool.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error returned by the MCP tool, if any.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the MCP tool.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) output": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/output", "deprecated": false, "key": "output", "docstring": "The output returned by the MCP tool, if any.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the MCP tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } ] }, "default": "mcp_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpCallItemResource", "docstring": "A call to a tool on an MCP server.", "ident": "AgentMcpCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "arguments" }, { "ident": "error" }, { "ident": "name" }, { "ident": "output" }, { "ident": "server_label" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) error", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) server_label", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the web search call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) action": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/action", "deprecated": false, "key": "action", "docstring": "An action performed by the web search tool.", "type": { "kind": "HttpTypeReference", "ident": "WebSearchAction", "$ref": "(resource) beta.agents > (model) web_search_action > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) web_search_action", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the web search call.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItemStatus", "$ref": "(resource) beta.agents > (model) agent_output_item_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_output_item_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `web_search_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search_call" } ] }, "default": "web_search_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchCallItemResource", "docstring": "A web search call produced by the agent.", "ident": "AgentWebSearchCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "action" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) action", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the command execution item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/command", "deprecated": false, "key": "command", "docstring": "The command that was executed.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to execute the command.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) duration_ms": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/duration_ms", "deprecated": false, "key": "duration_ms", "docstring": "The command duration in milliseconds.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) exit_code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/exit_code", "deprecated": false, "key": "exit_code", "docstring": "The process exit code, if the command completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) output": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/output", "deprecated": false, "key": "output", "docstring": "The command output, if available.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the command execution.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `command_execution`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "command_execution" } ] }, "default": "command_execution", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/CommandExecutionItemResource", "docstring": "A command execution produced by the agent.", "ident": "AgentCommandExecutionItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "duration_ms" }, { "ident": "exit_code" }, { "ident": "output" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) command", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) cwd", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) duration_ms", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) exit_code", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that requested the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The task given to the spawned agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model requested for the spawned agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) reasoning_effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/reasoning_effort", "deprecated": false, "key": "reasoning_effort", "docstring": "The reasoning effort requested for the spawned agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `create_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "create_subagent_call" } ] }, "default": "create_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/CreateSubagentCallItemResource", "docstring": "A request to spawn a subagent.", "ident": "AgentCreateSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "content" }, { "ident": "model" }, { "ident": "reasoning_effort" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) agent_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) model", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) reasoning_effort", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The input sent to the receiving agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent receiving the input.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent sending the input.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `send_subagent_input_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "send_subagent_input_call" } ] }, "default": "send_subagent_input_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource", "docstring": "A request to send input to another agent.", "ident": "AgentSendSubagentInputCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "content" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent to resume.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent requesting the resume.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `resume_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "resume_subagent_call" } ] }, "default": "resume_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource", "docstring": "A request to resume a subagent.", "ident": "AgentResumeSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) recipient_agent_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/recipient_agent_ids", "deprecated": false, "key": "recipient_agent_ids", "docstring": "The IDs of the agents to wait for.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/recipient_agent_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent waiting for results.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `wait_for_subagents_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "wait_for_subagents_call" } ] }, "default": "wait_for_subagents_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource", "docstring": "A request to wait for one or more subagents.", "ident": "AgentWaitForSubagentsCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_ids" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) recipient_agent_ids", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent to interrupt.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent requesting the interrupt.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `interrupt_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "interrupt_subagent_call" } ] }, "default": "interrupt_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource", "docstring": "A request to interrupt a subagent's current turn. The subagent remains available.", "ident": "AgentInterruptSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent to close.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent requesting the close.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `close_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "close_subagent_call" } ] }, "default": "close_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/CloseSubagentCallItemResource", "docstring": "A request to close a subagent.", "ident": "AgentCloseSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentResource/oneOf/0", "docstring": "Text supplied by the user.", "ident": "InputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0 > (property) text", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentResource/oneOf/1", "docstring": "An image supplied by the user.", "ident": "InputImage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "image_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1 > (property) image_url", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentResource/oneOf/2", "docstring": "Text produced by the assistant.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2 > (property) text", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2 > (property) type" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MessageContentResource", "docstring": "A content part in a session message.", "ident": "AgentSessionMessageContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageContentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "image_url" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase > (member) 0": { "kind": "HttpDeclReference", "docstring": "Commentary produced while the agent works.", "type": { "kind": "HttpTypeLiteral", "literal": "commentary" } }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) phase > (member) 1": { "kind": "HttpDeclReference", "docstring": "The agent's final answer.", "type": { "kind": "HttpTypeLiteral", "literal": "final_answer" } }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "user" } }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) role > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "assistant" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0": { "kind": "HttpDeclReference", "docstring": "The item is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1": { "kind": "HttpDeclReference", "docstring": "The item is complete.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2": { "kind": "HttpDeclReference", "docstring": "The item stopped before completing.", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputItemStatusResource", "docstring": "The status of an agent output item.", "ident": "AgentOutputItemStatus", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputItemStatusResource", "types": [ { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "incomplete" } ] }, "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_session_message > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "message" } }, "(resource) beta.agents > (model) summary_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The reasoning summary text.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `summary_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "summary_text" } ] }, "default": "summary_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SummaryTextResource", "docstring": "A reasoning summary content part.", "ident": "SummaryText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "reasoning" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0": { "kind": "HttpDeclReference", "docstring": "The call is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1": { "kind": "HttpDeclReference", "docstring": "The call completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2": { "kind": "HttpDeclReference", "docstring": "The call failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3": { "kind": "HttpDeclReference", "docstring": "The call stopped before completing.", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallStatusResource", "docstring": "The status of a tool call.", "ident": "AgentFunctionCallStatus", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/FunctionCallStatusResource", "types": [ { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "incomplete" } ] }, "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_function_call_output > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallOutputResource/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" }, "children": [] }, "(resource) beta.agents > (model) agent_function_call_output > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallOutputResource/oneOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/FunctionCallOutputResource/oneOf/1", "elementType": { "kind": "HttpTypeReference", "ident": "InputContent", "$ref": "(resource) beta.agents > (model) input_content > (schema)" } }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) input_content > (schema) > (variant) 0", "(resource) beta.agents > (model) input_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallOutputResource", "docstring": "The text or model-input content supplied as a function result.", "ident": "AgentFunctionCallOutput", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/FunctionCallOutputResource", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/FunctionCallOutputResource/oneOf/1", "elementType": { "kind": "HttpTypeReference", "ident": "InputContent", "$ref": "(resource) beta.agents > (model) input_content > (schema)" } } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_function_call_output > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_function_call_output > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call_output" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource/oneOf/1", "docstring": "Encrypted content exchanged between agents.", "ident": "EncryptedContent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource", "docstring": "A plaintext or encrypted content part exchanged between agents.", "ident": "AgentContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentContentResource", "types": [ { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session_item > (schema) > (variant) 4 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent_message" } }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp_call" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/0", "docstring": "A search query or group of search queries.", "ident": "Search", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "queries" }, { "ident": "query" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) queries", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) query", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/1", "docstring": "Opens a web page.", "ident": "OpenPage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" }, { "ident": "url" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) url" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/2", "docstring": "Finds text within a web page.", "ident": "FindInPage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "pattern" }, { "ident": "type" }, { "ident": "url" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) pattern", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) url" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/3", "docstring": "Another web search action.", "ident": "Other", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) web_search_action > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource", "docstring": "An action performed by the web search tool.", "ident": "WebSearchAction", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "queries" }, { "ident": "query" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "type" }, { "ident": "url" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "pattern" }, { "ident": "type" }, { "ident": "url" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search_call" } }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "command_execution" } }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "create_subagent_call" } }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "send_subagent_input_call" } }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "resume_subagent_call" } }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "wait_for_subagents_call" } }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "interrupt_subagent_call" } }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "close_subagent_call" } }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0 > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageContentResourceInputText/properties/text", "deprecated": false, "key": "text", "docstring": "The text supplied by the user.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageContentResourceInputText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `input_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageContentResourceInputText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } ] }, "default": "input_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1 > (property) image_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageContentResourceInputImage/properties/image_url", "deprecated": false, "key": "image_url", "docstring": "The URL of the image supplied by the user, which may be a base64-encoded data URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageContentResourceInputImage/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `input_image`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageContentResourceInputImage/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_image" } ] }, "default": "input_image", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2 > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageContentResourceOutputText/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the assistant.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MessageContentResourceOutputText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/MessageContentResourceOutputText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "summary_text" } }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputContentResource/oneOf/0", "docstring": "Text input recorded in a session item.", "ident": "InputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) input_content > (schema) > (variant) 0 > (property) text", "(resource) beta.agents > (model) input_content > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputContentResource/oneOf/1", "docstring": "Image input recorded in a session item.", "ident": "InputImage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "image_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) input_content > (schema) > (variant) 1 > (property) image_url", "(resource) beta.agents > (model) input_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) input_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputContentResource", "docstring": "User-provided content recorded in a session item.", "ident": "InputContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/InputContentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "image_url" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) input_content > (schema) > (variant) 0", "(resource) beta.agents > (model) input_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/encrypted_content", "deprecated": false, "key": "encrypted_content", "docstring": "The encrypted content payload.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `encrypted_content`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } ] }, "default": "encrypted_content", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) queries": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/queries", "deprecated": false, "key": "queries", "docstring": "The search queries, when multiple queries were used.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/queries", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) query": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/query", "deprecated": false, "key": "query", "docstring": "The search query, when a single query was used.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "search" } ] }, "default": "search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceOpenPage/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `open_page`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceOpenPage/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "open_page" } ] }, "default": "open_page", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceOpenPage/properties/url", "deprecated": false, "key": "url", "docstring": "The URL of the page that was opened.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) pattern": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/pattern", "deprecated": false, "key": "pattern", "docstring": "The text pattern that was searched for.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `find_in_page`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "find_in_page" } ] }, "default": "find_in_page", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/url", "deprecated": false, "key": "url", "docstring": "The URL of the page that was searched.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceOther/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `other`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceOther/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "other" } ] }, "default": "other", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "input_text" } }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "input_image" } }, "(resource) beta.agents > (model) agent_session_message_content > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 0 > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputContentResourceInputText/properties/text", "deprecated": false, "key": "text", "docstring": "The text supplied to the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputContentResourceInputText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `input_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/InputContentResourceInputText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } ] }, "default": "input_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) input_content > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 1 > (property) image_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputContentResourceInputImage/properties/image_url", "deprecated": false, "key": "image_url", "docstring": "The URL of the image supplied to the agent, which may be a base64-encoded data URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputContentResourceInputImage/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `input_image`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/InputContentResourceInputImage/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_image" } ] }, "default": "input_image", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) input_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "search" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "open_page" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "find_in_page" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "other" } }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "input_text" } }, "(resource) beta.agents > (model) input_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "input_image" } } } ``` ### Example ```json { "type": "agent.session.turn.item.added", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "output_index": 0, "item": { "type": "message", "id": "id", "turn_id": "turn_id", "role": "user", "content": [ { "type": "input_text", "text": "text" } ], "status": "in_progress", "phase": "commentary" } } ``` ## agent.session.idle Emitted when a session becomes idle. ### Schema Schema name: `SessionEventAgentSessionIdle` ```json { "(resource) beta.agents > (model) agent_session_idle_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionIdle", "docstring": "Emitted when a session becomes idle.", "ident": "AgentSessionIdleEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) session", "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionIdle/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) session": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionIdle/properties/session", "deprecated": false, "key": "session", "docstring": "The session that became idle.", "type": { "kind": "HttpTypeReference", "ident": "AgentSession", "$ref": "(resource) beta.agents > (model) agent_session > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionIdle/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.idle`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionIdle/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.idle" } ] }, "default": "agent.session.idle", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/agent", "deprecated": false, "key": "agent", "docstring": "The agent running in the session.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "instructions" }, { "ident": "model" }, { "ident": "multi_agent" }, { "ident": "name" }, { "ident": "reasoning" }, { "ident": "service_tier" }, { "ident": "text" }, { "ident": "tools" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, when the session was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/environment", "deprecated": false, "key": "environment", "docstring": "The execution environment for the session.", "type": { "kind": "HttpTypeReference", "ident": "Environment", "$ref": "(resource) beta.agents > (model) environment > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) environment", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error that caused the session to fail, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/last_active_at", "deprecated": false, "key": "last_active_at", "docstring": "The Unix timestamp, in seconds, when the session was last active.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "deprecated": false, "key": "metadata", "docstring": "Custom string key-value pairs attached to the session.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeString" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session" } ] }, "default": "agent.session", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "deprecated": false, "key": "required_actions", "docstring": "Actions that must be completed before the session can continue.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "elementType": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/required_actions/items", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] } ] } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the session.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "idle" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "requires_action" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "deprecated": false, "key": "vault_ids", "docstring": "The IDs of vaults made available to the session.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionResource", "docstring": "A Managed Agents session.", "ident": "AgentSession", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent" }, { "ident": "created_at" }, { "ident": "environment" }, { "ident": "error" }, { "ident": "last_active_at" }, { "ident": "metadata" }, { "ident": "object" }, { "ident": "required_actions" }, { "ident": "status" }, { "ident": "usage" }, { "ident": "vault_ids" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_idle_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.idle" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Custom instructions appended to the agent's default base instructions.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model used by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/multi_agent", "deprecated": false, "key": "multi_agent", "docstring": "Configuration for creating and coordinating subagents.", "type": { "kind": "HttpTypeReference", "ident": "MultiAgentConfig", "$ref": "(resource) beta.agents > (model) multi_agent_config > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) multi_agent_config", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The reusable agent's name when the session was created, or null if no name was saved. Later changes to the agent's name do not affect this value.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/reasoning", "deprecated": false, "key": "reasoning", "docstring": "The agent's reasoning configuration.", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoning", "$ref": "(resource) beta.agents > (model) agent_reasoning > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_reasoning", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "deprecated": false, "key": "service_tier", "docstring": "The effective service-tier policy for model requests. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" }, { "kind": "HttpTypeLiteral", "literal": "default" }, { "kind": "HttpTypeLiteral", "literal": "flex" }, { "kind": "HttpTypeLiteral", "literal": "priority" }, { "kind": "HttpTypeLiteral", "literal": "fast" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/text", "deprecated": false, "key": "text", "docstring": "Configuration for text generated by the agent.", "type": { "kind": "HttpTypeReference", "ident": "AgentText", "$ref": "(resource) beta.agents > (model) agent_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "deprecated": false, "key": "tools", "docstring": "Tools available to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "elementType": { "kind": "HttpTypeReference", "ident": "AgentTool", "$ref": "(resource) beta.agents > (model) agent_tool > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/0", "docstring": "The session talks to CCA without selecting or provisioning an execution environment.", "ident": "None", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/1", "docstring": "An environment hosted by OpenAI.", "ident": "OpenAIHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/2", "docstring": "An environment hosted by the application.", "ident": "SelfHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory" ] }, "(resource) beta.agents > (model) environment > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource", "docstring": "The execution environment for a session.", "ident": "Environment", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/0", "docstring": "Run a function tool and submit its result.", "ident": "FunctionCall", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/1", "docstring": "Reconnect a session environment.", "ident": "EnvironmentConnection", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The session has no turn in progress and is ready for input. A hosted environment may still be provisioning.", "type": { "kind": "HttpTypeLiteral", "literal": "idle" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session is processing a turn.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The session is waiting for one or more required actions.", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The session failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether subagent tools are enabled. Defaults to false.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/max_concurrent_subagents", "deprecated": false, "key": "max_concurrent_subagents", "docstring": "Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 1, "maximum": 4294967295 }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MultiAgentConfigResource", "docstring": "The resolved configuration for creating and coordinating subagents.", "ident": "MultiAgentConfig", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "max_concurrent_subagents" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "deprecated": false, "key": "effort", "docstring": "The amount of reasoning effort used by an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" }, { "kind": "HttpTypeLiteral", "literal": "minimal" }, { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" }, { "kind": "HttpTypeLiteral", "literal": "xhigh" }, { "kind": "HttpTypeLiteral", "literal": "max" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summary format requested from an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "types": [ { "kind": "HttpTypeLiteral", "literal": "concise" }, { "kind": "HttpTypeLiteral", "literal": "detailed" }, { "kind": "HttpTypeLiteral", "literal": "auto" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningResource", "docstring": "The reasoning configuration used by an agent.", "ident": "AgentReasoning", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "effort" }, { "ident": "summary" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "default" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "flex" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "priority" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "fast" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) format": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/format", "deprecated": false, "key": "format", "docstring": "The effective output format. Defaults to ordinary text.", "type": { "kind": "HttpTypeReference", "ident": "TextFormat", "$ref": "(resource) beta.agents > (model) text_format > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) text_format", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "deprecated": false, "key": "verbosity", "docstring": "The amount of text produced by the agent. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2" ] }, "(resource) beta.agents > (model) agent_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextResource", "docstring": "The text configuration used by an agent.", "ident": "AgentText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "format" }, { "ident": "verbosity" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/0", "docstring": "A function defined by the application.", "ident": "Function", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/1", "docstring": "Enables calling tools from model-generated code.", "ident": "ProgrammaticToolCalling", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/2", "docstring": "Tools provided by a remote MCP server.", "ident": "Mcp", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/3", "docstring": "Web search.", "ident": "WebSearch", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource", "docstring": "A tool available to the agent.", "ident": "AgentTool", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `none`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" } ] }, "default": "none", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "deprecated": false, "key": "files", "docstring": "Files available in the environment, excluding their contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "elementType": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFile", "$ref": "(resource) beta.agents > (model) hosted_environment_file > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/network", "deprecated": false, "key": "network", "docstring": "The effective network access policy for the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "access" }, { "ident": "allowed_domains" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/packages", "deprecated": false, "key": "packages", "docstring": "Packages installed in the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "npm" }, { "ident": "python" }, { "ident": "system" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "deprecated": false, "key": "plugins", "docstring": "Plugins installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "elementType": { "kind": "HttpTypeReference", "ident": "HostedPlugin", "$ref": "(resource) beta.agents > (model) hosted_plugin > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "deprecated": false, "key": "skills", "docstring": "Skills installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "elementType": { "kind": "HttpTypeReference", "ident": "HostedSkill", "$ref": "(resource) beta.agents > (model) hosted_skill > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `openai_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } ] }, "default": "openai_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/remote_url", "deprecated": false, "key": "remote_url", "docstring": "Pass this URL unchanged to `codex exec-server --remote` when connecting this environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `self_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "self_hosted" } ] }, "default": "self_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/workspace_directory", "deprecated": false, "key": "workspace_directory", "docstring": "The absolute project directory inside the environment. Defaults to `/workspace`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments supplied by the model.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID to include when submitting the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/name", "deprecated": false, "key": "name", "docstring": "The function name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that requested the function call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/environment_id", "deprecated": false, "key": "environment_id", "docstring": "The ID of the environment to reconnect.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `environment_connection`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "environment_connection" } ] }, "default": "environment_connection", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "minimal" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "xhigh" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "max" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0": { "kind": "HttpDeclReference", "docstring": "Returns a concise reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "concise" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1": { "kind": "HttpDeclReference", "docstring": "Returns a detailed reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "detailed" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2": { "kind": "HttpDeclReference", "docstring": "Automatically selects the most detailed summary supported by the model.", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/0", "docstring": "Generates ordinary text without a structured-output constraint.", "ident": "Text", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/1", "docstring": "Constrains generated text to a JSON Schema.", "ident": "JSONSchema", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource", "docstring": "The effective output format for generated text.", "ident": "TextFormat", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/defer_loading", "deprecated": false, "key": "defer_loading", "docstring": "Whether the function is deferred and discovered through tool search.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/description", "deprecated": false, "key": "description", "docstring": "A description of what the function does.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "deprecated": false, "key": "parameters", "docstring": "A JSON Schema object describing the function's arguments.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } ] }, "default": "function", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether tools can be called from model-generated code.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `programmatic_tool_calling`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } ] }, "default": "programmatic_tool_calling", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "deprecated": false, "key": "allowed_tools", "docstring": "The MCP tools the agent may call.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "deprecated": false, "key": "connection_origin", "docstring": "Where outbound MCP HTTP connections originate.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "types": [ { "kind": "HttpTypeLiteral", "literal": "service" }, { "kind": "HttpTypeLiteral", "literal": "environment" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/credential_id", "deprecated": false, "key": "credential_id", "docstring": "The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "deprecated": false, "key": "request_metadata", "docstring": "Metadata included with requests to this MCP server.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/required", "deprecated": false, "key": "required", "docstring": "Whether this MCP server must initialize before the first turn.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "A label used to identify the MCP server in tool calls.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/transport", "deprecated": false, "key": "transport", "docstring": "The transport used to connect to the MCP server.", "type": { "kind": "HttpTypeReference", "ident": "McpTransport", "$ref": "(resource) beta.agents > (model) mcp_transport > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) mcp_transport", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `mcp`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } ] }, "default": "mcp", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Allowed search domains, or `null` when the search is unrestricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "deprecated": false, "key": "context_size", "docstring": "The amount of search context made available to the model. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/location", "deprecated": false, "key": "location", "docstring": "Approximate user location used to localize web search results.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "city" }, { "ident": "country" }, { "ident": "region" }, { "ident": "timezone" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "deprecated": false, "key": "mode", "docstring": "The source used for web search results.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "cached" }, { "kind": "HttpTypeLiteral", "literal": "live" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `web_search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search" } ] }, "default": "web_search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource/oneOf/1", "docstring": "A file supplied inline when the session was created.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "docstring": "Metadata for a file materialized in an OpenAI-hosted execution environment.", "ident": "HostedEnvironmentFile", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "deprecated": false, "key": "access", "docstring": "The environment's network access mode.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "types": [ { "kind": "HttpTypeLiteral", "literal": "enabled" }, { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "restricted" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Domains the environment may access when network access is restricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "deprecated": false, "key": "npm", "docstring": "npm packages installed globally in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "deprecated": false, "key": "python", "docstring": "Python packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "deprecated": false, "key": "system", "docstring": "System packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed plugin description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed plugin name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_plugin > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedPluginResource", "docstring": "A plugin installed from an inline ZIP archive.", "ident": "HostedPlugin", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource/oneOf/1", "docstring": "A skill installed from an inline ZIP archive.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource", "docstring": "A skill installed in an OpenAI-hosted environment.", "ident": "HostedSkill", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "self_hosted" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment_connection" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } ] }, "default": "text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "deprecated": false, "key": "schema", "docstring": "The JSON Schema that generated text must match.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } ] }, "default": "json_schema", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "service" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/0", "docstring": "Connects to an MCP server over HTTP.", "ident": "HTTP", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/1", "docstring": "Starts an MCP server as a local process.", "ident": "Stdio", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource", "docstring": "The transport used to connect to an MCP server.", "ident": "McpTransport", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/city", "deprecated": false, "key": "city", "docstring": "The city name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/country", "deprecated": false, "key": "country", "docstring": "The two-letter ISO country code, such as `US`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/region", "deprecated": false, "key": "region", "docstring": "The region or state name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/timezone", "deprecated": false, "key": "timezone", "docstring": "The IANA timezone, such as `America/Los_Angeles`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cached" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "live" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search" } }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/file_id", "deprecated": false, "key": "file_id", "docstring": "The ID of the uploaded file.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `file_id`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_id" } ] }, "default": "file_id", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId", "docstring": "A file copied from the OpenAI Files API.", "ident": "HostedEnvironmentFileID", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "file_id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0": { "kind": "HttpDeclReference", "docstring": "Allows unrestricted network access.", "type": { "kind": "HttpTypeLiteral", "literal": "enabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1": { "kind": "HttpDeclReference", "docstring": "Disables network access.", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2": { "kind": "HttpDeclReference", "docstring": "Allows access only to configured domains.", "type": { "kind": "HttpTypeLiteral", "literal": "restricted" } }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/skill_id", "deprecated": false, "key": "skill_id", "docstring": "The referenced skill ID.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `skill_reference`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "skill_reference" } ] }, "default": "skill_reference", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/version", "deprecated": false, "key": "version", "docstring": "The concrete skill version installed for this session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference", "docstring": "A skill installed from the Skills API.", "ident": "HostedSkillReference", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "skill_id" }, { "ident": "type" }, { "ident": "version" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "json_schema" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/server_url", "deprecated": false, "key": "server_url", "docstring": "The URL of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `http`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http" } ] }, "default": "http", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "deprecated": false, "key": "args", "docstring": "Arguments passed to the MCP server command.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/command", "deprecated": false, "key": "command", "docstring": "The command used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "deprecated": false, "key": "env_vars", "docstring": "Environment variable names inherited from the execution environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `stdio`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "stdio" } ] }, "default": "stdio", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "file_id" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "skill_reference" } }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "http" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "stdio" } } } ``` ### Example ```json { "type": "agent.session.idle", "event_id": "event_id", "session": { "metadata": { "foo": "string" }, "id": "id", "object": "agent.session", "created_at": 0, "last_active_at": 0, "status": "idle", "required_actions": [ { "type": "function_call", "turn_id": "turn_id", "call_id": "call_id", "name": "name", "arguments": {} } ], "error": "error", "agent": { "id": "id", "name": "name", "model": "model", "reasoning": { "effort": "none", "summary": "concise" }, "text": { "format": { "type": "text" }, "verbosity": "low" }, "service_tier": "auto", "instructions": "instructions", "tools": [ { "type": "function", "name": "name", "description": "description", "parameters": { "foo": "bar" }, "defer_loading": true } ], "multi_agent": { "enabled": true, "max_concurrent_subagents": 1 } }, "environment": { "type": "none" }, "vault_ids": [ "string" ], "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.in_progress Emitted when a session starts processing a turn. ### Schema Schema name: `SessionEventAgentSessionInProgress` ```json { "(resource) beta.agents > (model) agent_session_in_progress_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionInProgress", "docstring": "Emitted when a session starts processing a turn.", "ident": "AgentSessionInProgressEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) session", "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionInProgress/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) session": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionInProgress/properties/session", "deprecated": false, "key": "session", "docstring": "The session that started processing.", "type": { "kind": "HttpTypeReference", "ident": "AgentSession", "$ref": "(resource) beta.agents > (model) agent_session > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionInProgress/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.in_progress`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionInProgress/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.in_progress" } ] }, "default": "agent.session.in_progress", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/agent", "deprecated": false, "key": "agent", "docstring": "The agent running in the session.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "instructions" }, { "ident": "model" }, { "ident": "multi_agent" }, { "ident": "name" }, { "ident": "reasoning" }, { "ident": "service_tier" }, { "ident": "text" }, { "ident": "tools" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, when the session was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/environment", "deprecated": false, "key": "environment", "docstring": "The execution environment for the session.", "type": { "kind": "HttpTypeReference", "ident": "Environment", "$ref": "(resource) beta.agents > (model) environment > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) environment", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error that caused the session to fail, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/last_active_at", "deprecated": false, "key": "last_active_at", "docstring": "The Unix timestamp, in seconds, when the session was last active.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "deprecated": false, "key": "metadata", "docstring": "Custom string key-value pairs attached to the session.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeString" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session" } ] }, "default": "agent.session", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "deprecated": false, "key": "required_actions", "docstring": "Actions that must be completed before the session can continue.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "elementType": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/required_actions/items", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] } ] } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the session.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "idle" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "requires_action" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "deprecated": false, "key": "vault_ids", "docstring": "The IDs of vaults made available to the session.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionResource", "docstring": "A Managed Agents session.", "ident": "AgentSession", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent" }, { "ident": "created_at" }, { "ident": "environment" }, { "ident": "error" }, { "ident": "last_active_at" }, { "ident": "metadata" }, { "ident": "object" }, { "ident": "required_actions" }, { "ident": "status" }, { "ident": "usage" }, { "ident": "vault_ids" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_in_progress_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.in_progress" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Custom instructions appended to the agent's default base instructions.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model used by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/multi_agent", "deprecated": false, "key": "multi_agent", "docstring": "Configuration for creating and coordinating subagents.", "type": { "kind": "HttpTypeReference", "ident": "MultiAgentConfig", "$ref": "(resource) beta.agents > (model) multi_agent_config > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) multi_agent_config", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The reusable agent's name when the session was created, or null if no name was saved. Later changes to the agent's name do not affect this value.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/reasoning", "deprecated": false, "key": "reasoning", "docstring": "The agent's reasoning configuration.", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoning", "$ref": "(resource) beta.agents > (model) agent_reasoning > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_reasoning", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "deprecated": false, "key": "service_tier", "docstring": "The effective service-tier policy for model requests. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" }, { "kind": "HttpTypeLiteral", "literal": "default" }, { "kind": "HttpTypeLiteral", "literal": "flex" }, { "kind": "HttpTypeLiteral", "literal": "priority" }, { "kind": "HttpTypeLiteral", "literal": "fast" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/text", "deprecated": false, "key": "text", "docstring": "Configuration for text generated by the agent.", "type": { "kind": "HttpTypeReference", "ident": "AgentText", "$ref": "(resource) beta.agents > (model) agent_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "deprecated": false, "key": "tools", "docstring": "Tools available to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "elementType": { "kind": "HttpTypeReference", "ident": "AgentTool", "$ref": "(resource) beta.agents > (model) agent_tool > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/0", "docstring": "The session talks to CCA without selecting or provisioning an execution environment.", "ident": "None", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/1", "docstring": "An environment hosted by OpenAI.", "ident": "OpenAIHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/2", "docstring": "An environment hosted by the application.", "ident": "SelfHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory" ] }, "(resource) beta.agents > (model) environment > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource", "docstring": "The execution environment for a session.", "ident": "Environment", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/0", "docstring": "Run a function tool and submit its result.", "ident": "FunctionCall", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/1", "docstring": "Reconnect a session environment.", "ident": "EnvironmentConnection", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The session has no turn in progress and is ready for input. A hosted environment may still be provisioning.", "type": { "kind": "HttpTypeLiteral", "literal": "idle" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session is processing a turn.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The session is waiting for one or more required actions.", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The session failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether subagent tools are enabled. Defaults to false.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/max_concurrent_subagents", "deprecated": false, "key": "max_concurrent_subagents", "docstring": "Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 1, "maximum": 4294967295 }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MultiAgentConfigResource", "docstring": "The resolved configuration for creating and coordinating subagents.", "ident": "MultiAgentConfig", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "max_concurrent_subagents" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "deprecated": false, "key": "effort", "docstring": "The amount of reasoning effort used by an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" }, { "kind": "HttpTypeLiteral", "literal": "minimal" }, { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" }, { "kind": "HttpTypeLiteral", "literal": "xhigh" }, { "kind": "HttpTypeLiteral", "literal": "max" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summary format requested from an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "types": [ { "kind": "HttpTypeLiteral", "literal": "concise" }, { "kind": "HttpTypeLiteral", "literal": "detailed" }, { "kind": "HttpTypeLiteral", "literal": "auto" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningResource", "docstring": "The reasoning configuration used by an agent.", "ident": "AgentReasoning", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "effort" }, { "ident": "summary" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "default" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "flex" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "priority" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "fast" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) format": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/format", "deprecated": false, "key": "format", "docstring": "The effective output format. Defaults to ordinary text.", "type": { "kind": "HttpTypeReference", "ident": "TextFormat", "$ref": "(resource) beta.agents > (model) text_format > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) text_format", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "deprecated": false, "key": "verbosity", "docstring": "The amount of text produced by the agent. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2" ] }, "(resource) beta.agents > (model) agent_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextResource", "docstring": "The text configuration used by an agent.", "ident": "AgentText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "format" }, { "ident": "verbosity" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/0", "docstring": "A function defined by the application.", "ident": "Function", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/1", "docstring": "Enables calling tools from model-generated code.", "ident": "ProgrammaticToolCalling", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/2", "docstring": "Tools provided by a remote MCP server.", "ident": "Mcp", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/3", "docstring": "Web search.", "ident": "WebSearch", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource", "docstring": "A tool available to the agent.", "ident": "AgentTool", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `none`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" } ] }, "default": "none", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "deprecated": false, "key": "files", "docstring": "Files available in the environment, excluding their contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "elementType": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFile", "$ref": "(resource) beta.agents > (model) hosted_environment_file > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/network", "deprecated": false, "key": "network", "docstring": "The effective network access policy for the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "access" }, { "ident": "allowed_domains" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/packages", "deprecated": false, "key": "packages", "docstring": "Packages installed in the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "npm" }, { "ident": "python" }, { "ident": "system" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "deprecated": false, "key": "plugins", "docstring": "Plugins installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "elementType": { "kind": "HttpTypeReference", "ident": "HostedPlugin", "$ref": "(resource) beta.agents > (model) hosted_plugin > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "deprecated": false, "key": "skills", "docstring": "Skills installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "elementType": { "kind": "HttpTypeReference", "ident": "HostedSkill", "$ref": "(resource) beta.agents > (model) hosted_skill > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `openai_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } ] }, "default": "openai_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/remote_url", "deprecated": false, "key": "remote_url", "docstring": "Pass this URL unchanged to `codex exec-server --remote` when connecting this environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `self_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "self_hosted" } ] }, "default": "self_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/workspace_directory", "deprecated": false, "key": "workspace_directory", "docstring": "The absolute project directory inside the environment. Defaults to `/workspace`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments supplied by the model.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID to include when submitting the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/name", "deprecated": false, "key": "name", "docstring": "The function name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that requested the function call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/environment_id", "deprecated": false, "key": "environment_id", "docstring": "The ID of the environment to reconnect.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `environment_connection`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "environment_connection" } ] }, "default": "environment_connection", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "minimal" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "xhigh" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "max" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0": { "kind": "HttpDeclReference", "docstring": "Returns a concise reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "concise" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1": { "kind": "HttpDeclReference", "docstring": "Returns a detailed reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "detailed" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2": { "kind": "HttpDeclReference", "docstring": "Automatically selects the most detailed summary supported by the model.", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/0", "docstring": "Generates ordinary text without a structured-output constraint.", "ident": "Text", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/1", "docstring": "Constrains generated text to a JSON Schema.", "ident": "JSONSchema", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource", "docstring": "The effective output format for generated text.", "ident": "TextFormat", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/defer_loading", "deprecated": false, "key": "defer_loading", "docstring": "Whether the function is deferred and discovered through tool search.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/description", "deprecated": false, "key": "description", "docstring": "A description of what the function does.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "deprecated": false, "key": "parameters", "docstring": "A JSON Schema object describing the function's arguments.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } ] }, "default": "function", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether tools can be called from model-generated code.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `programmatic_tool_calling`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } ] }, "default": "programmatic_tool_calling", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "deprecated": false, "key": "allowed_tools", "docstring": "The MCP tools the agent may call.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "deprecated": false, "key": "connection_origin", "docstring": "Where outbound MCP HTTP connections originate.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "types": [ { "kind": "HttpTypeLiteral", "literal": "service" }, { "kind": "HttpTypeLiteral", "literal": "environment" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/credential_id", "deprecated": false, "key": "credential_id", "docstring": "The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "deprecated": false, "key": "request_metadata", "docstring": "Metadata included with requests to this MCP server.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/required", "deprecated": false, "key": "required", "docstring": "Whether this MCP server must initialize before the first turn.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "A label used to identify the MCP server in tool calls.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/transport", "deprecated": false, "key": "transport", "docstring": "The transport used to connect to the MCP server.", "type": { "kind": "HttpTypeReference", "ident": "McpTransport", "$ref": "(resource) beta.agents > (model) mcp_transport > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) mcp_transport", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `mcp`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } ] }, "default": "mcp", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Allowed search domains, or `null` when the search is unrestricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "deprecated": false, "key": "context_size", "docstring": "The amount of search context made available to the model. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/location", "deprecated": false, "key": "location", "docstring": "Approximate user location used to localize web search results.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "city" }, { "ident": "country" }, { "ident": "region" }, { "ident": "timezone" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "deprecated": false, "key": "mode", "docstring": "The source used for web search results.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "cached" }, { "kind": "HttpTypeLiteral", "literal": "live" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `web_search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search" } ] }, "default": "web_search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource/oneOf/1", "docstring": "A file supplied inline when the session was created.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "docstring": "Metadata for a file materialized in an OpenAI-hosted execution environment.", "ident": "HostedEnvironmentFile", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "deprecated": false, "key": "access", "docstring": "The environment's network access mode.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "types": [ { "kind": "HttpTypeLiteral", "literal": "enabled" }, { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "restricted" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Domains the environment may access when network access is restricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "deprecated": false, "key": "npm", "docstring": "npm packages installed globally in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "deprecated": false, "key": "python", "docstring": "Python packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "deprecated": false, "key": "system", "docstring": "System packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed plugin description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed plugin name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_plugin > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedPluginResource", "docstring": "A plugin installed from an inline ZIP archive.", "ident": "HostedPlugin", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource/oneOf/1", "docstring": "A skill installed from an inline ZIP archive.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource", "docstring": "A skill installed in an OpenAI-hosted environment.", "ident": "HostedSkill", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "self_hosted" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment_connection" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } ] }, "default": "text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "deprecated": false, "key": "schema", "docstring": "The JSON Schema that generated text must match.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } ] }, "default": "json_schema", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "service" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/0", "docstring": "Connects to an MCP server over HTTP.", "ident": "HTTP", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/1", "docstring": "Starts an MCP server as a local process.", "ident": "Stdio", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource", "docstring": "The transport used to connect to an MCP server.", "ident": "McpTransport", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/city", "deprecated": false, "key": "city", "docstring": "The city name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/country", "deprecated": false, "key": "country", "docstring": "The two-letter ISO country code, such as `US`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/region", "deprecated": false, "key": "region", "docstring": "The region or state name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/timezone", "deprecated": false, "key": "timezone", "docstring": "The IANA timezone, such as `America/Los_Angeles`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cached" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "live" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search" } }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/file_id", "deprecated": false, "key": "file_id", "docstring": "The ID of the uploaded file.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `file_id`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_id" } ] }, "default": "file_id", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId", "docstring": "A file copied from the OpenAI Files API.", "ident": "HostedEnvironmentFileID", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "file_id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0": { "kind": "HttpDeclReference", "docstring": "Allows unrestricted network access.", "type": { "kind": "HttpTypeLiteral", "literal": "enabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1": { "kind": "HttpDeclReference", "docstring": "Disables network access.", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2": { "kind": "HttpDeclReference", "docstring": "Allows access only to configured domains.", "type": { "kind": "HttpTypeLiteral", "literal": "restricted" } }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/skill_id", "deprecated": false, "key": "skill_id", "docstring": "The referenced skill ID.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `skill_reference`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "skill_reference" } ] }, "default": "skill_reference", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/version", "deprecated": false, "key": "version", "docstring": "The concrete skill version installed for this session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference", "docstring": "A skill installed from the Skills API.", "ident": "HostedSkillReference", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "skill_id" }, { "ident": "type" }, { "ident": "version" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "json_schema" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/server_url", "deprecated": false, "key": "server_url", "docstring": "The URL of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `http`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http" } ] }, "default": "http", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "deprecated": false, "key": "args", "docstring": "Arguments passed to the MCP server command.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/command", "deprecated": false, "key": "command", "docstring": "The command used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "deprecated": false, "key": "env_vars", "docstring": "Environment variable names inherited from the execution environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `stdio`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "stdio" } ] }, "default": "stdio", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "file_id" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "skill_reference" } }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "http" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "stdio" } } } ``` ### Example ```json { "type": "agent.session.in_progress", "event_id": "event_id", "session": { "metadata": { "foo": "string" }, "id": "id", "object": "agent.session", "created_at": 0, "last_active_at": 0, "status": "idle", "required_actions": [ { "type": "function_call", "turn_id": "turn_id", "call_id": "call_id", "name": "name", "arguments": {} } ], "error": "error", "agent": { "id": "id", "name": "name", "model": "model", "reasoning": { "effort": "none", "summary": "concise" }, "text": { "format": { "type": "text" }, "verbosity": "low" }, "service_tier": "auto", "instructions": "instructions", "tools": [ { "type": "function", "name": "name", "description": "description", "parameters": { "foo": "bar" }, "defer_loading": true } ], "multi_agent": { "enabled": true, "max_concurrent_subagents": 1 } }, "environment": { "type": "none" }, "vault_ids": [ "string" ], "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.requires_action Emitted when a session is waiting for one or more required actions. ### Schema Schema name: `SessionEventAgentSessionRequiresAction` ```json { "(resource) beta.agents > (model) agent_session_requires_action_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionRequiresAction", "docstring": "Emitted when a session is waiting for one or more required actions.", "ident": "AgentSessionRequiresActionEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) session", "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionRequiresAction/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) session": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionRequiresAction/properties/session", "deprecated": false, "key": "session", "docstring": "The session and its current required actions.", "type": { "kind": "HttpTypeReference", "ident": "AgentSession", "$ref": "(resource) beta.agents > (model) agent_session > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionRequiresAction/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.requires_action`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionRequiresAction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.requires_action" } ] }, "default": "agent.session.requires_action", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/agent", "deprecated": false, "key": "agent", "docstring": "The agent running in the session.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "instructions" }, { "ident": "model" }, { "ident": "multi_agent" }, { "ident": "name" }, { "ident": "reasoning" }, { "ident": "service_tier" }, { "ident": "text" }, { "ident": "tools" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, when the session was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/environment", "deprecated": false, "key": "environment", "docstring": "The execution environment for the session.", "type": { "kind": "HttpTypeReference", "ident": "Environment", "$ref": "(resource) beta.agents > (model) environment > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) environment", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error that caused the session to fail, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/last_active_at", "deprecated": false, "key": "last_active_at", "docstring": "The Unix timestamp, in seconds, when the session was last active.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "deprecated": false, "key": "metadata", "docstring": "Custom string key-value pairs attached to the session.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeString" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session" } ] }, "default": "agent.session", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "deprecated": false, "key": "required_actions", "docstring": "Actions that must be completed before the session can continue.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "elementType": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/required_actions/items", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] } ] } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the session.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "idle" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "requires_action" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "deprecated": false, "key": "vault_ids", "docstring": "The IDs of vaults made available to the session.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionResource", "docstring": "A Managed Agents session.", "ident": "AgentSession", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent" }, { "ident": "created_at" }, { "ident": "environment" }, { "ident": "error" }, { "ident": "last_active_at" }, { "ident": "metadata" }, { "ident": "object" }, { "ident": "required_actions" }, { "ident": "status" }, { "ident": "usage" }, { "ident": "vault_ids" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_requires_action_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.requires_action" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Custom instructions appended to the agent's default base instructions.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model used by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/multi_agent", "deprecated": false, "key": "multi_agent", "docstring": "Configuration for creating and coordinating subagents.", "type": { "kind": "HttpTypeReference", "ident": "MultiAgentConfig", "$ref": "(resource) beta.agents > (model) multi_agent_config > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) multi_agent_config", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The reusable agent's name when the session was created, or null if no name was saved. Later changes to the agent's name do not affect this value.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/reasoning", "deprecated": false, "key": "reasoning", "docstring": "The agent's reasoning configuration.", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoning", "$ref": "(resource) beta.agents > (model) agent_reasoning > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_reasoning", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "deprecated": false, "key": "service_tier", "docstring": "The effective service-tier policy for model requests. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" }, { "kind": "HttpTypeLiteral", "literal": "default" }, { "kind": "HttpTypeLiteral", "literal": "flex" }, { "kind": "HttpTypeLiteral", "literal": "priority" }, { "kind": "HttpTypeLiteral", "literal": "fast" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/text", "deprecated": false, "key": "text", "docstring": "Configuration for text generated by the agent.", "type": { "kind": "HttpTypeReference", "ident": "AgentText", "$ref": "(resource) beta.agents > (model) agent_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "deprecated": false, "key": "tools", "docstring": "Tools available to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "elementType": { "kind": "HttpTypeReference", "ident": "AgentTool", "$ref": "(resource) beta.agents > (model) agent_tool > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/0", "docstring": "The session talks to CCA without selecting or provisioning an execution environment.", "ident": "None", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/1", "docstring": "An environment hosted by OpenAI.", "ident": "OpenAIHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/2", "docstring": "An environment hosted by the application.", "ident": "SelfHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory" ] }, "(resource) beta.agents > (model) environment > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource", "docstring": "The execution environment for a session.", "ident": "Environment", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/0", "docstring": "Run a function tool and submit its result.", "ident": "FunctionCall", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/1", "docstring": "Reconnect a session environment.", "ident": "EnvironmentConnection", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The session has no turn in progress and is ready for input. A hosted environment may still be provisioning.", "type": { "kind": "HttpTypeLiteral", "literal": "idle" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session is processing a turn.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The session is waiting for one or more required actions.", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The session failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether subagent tools are enabled. Defaults to false.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/max_concurrent_subagents", "deprecated": false, "key": "max_concurrent_subagents", "docstring": "Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 1, "maximum": 4294967295 }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MultiAgentConfigResource", "docstring": "The resolved configuration for creating and coordinating subagents.", "ident": "MultiAgentConfig", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "max_concurrent_subagents" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "deprecated": false, "key": "effort", "docstring": "The amount of reasoning effort used by an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" }, { "kind": "HttpTypeLiteral", "literal": "minimal" }, { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" }, { "kind": "HttpTypeLiteral", "literal": "xhigh" }, { "kind": "HttpTypeLiteral", "literal": "max" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summary format requested from an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "types": [ { "kind": "HttpTypeLiteral", "literal": "concise" }, { "kind": "HttpTypeLiteral", "literal": "detailed" }, { "kind": "HttpTypeLiteral", "literal": "auto" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningResource", "docstring": "The reasoning configuration used by an agent.", "ident": "AgentReasoning", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "effort" }, { "ident": "summary" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "default" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "flex" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "priority" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "fast" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) format": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/format", "deprecated": false, "key": "format", "docstring": "The effective output format. Defaults to ordinary text.", "type": { "kind": "HttpTypeReference", "ident": "TextFormat", "$ref": "(resource) beta.agents > (model) text_format > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) text_format", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "deprecated": false, "key": "verbosity", "docstring": "The amount of text produced by the agent. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2" ] }, "(resource) beta.agents > (model) agent_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextResource", "docstring": "The text configuration used by an agent.", "ident": "AgentText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "format" }, { "ident": "verbosity" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/0", "docstring": "A function defined by the application.", "ident": "Function", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/1", "docstring": "Enables calling tools from model-generated code.", "ident": "ProgrammaticToolCalling", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/2", "docstring": "Tools provided by a remote MCP server.", "ident": "Mcp", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/3", "docstring": "Web search.", "ident": "WebSearch", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource", "docstring": "A tool available to the agent.", "ident": "AgentTool", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `none`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" } ] }, "default": "none", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "deprecated": false, "key": "files", "docstring": "Files available in the environment, excluding their contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "elementType": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFile", "$ref": "(resource) beta.agents > (model) hosted_environment_file > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/network", "deprecated": false, "key": "network", "docstring": "The effective network access policy for the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "access" }, { "ident": "allowed_domains" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/packages", "deprecated": false, "key": "packages", "docstring": "Packages installed in the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "npm" }, { "ident": "python" }, { "ident": "system" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "deprecated": false, "key": "plugins", "docstring": "Plugins installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "elementType": { "kind": "HttpTypeReference", "ident": "HostedPlugin", "$ref": "(resource) beta.agents > (model) hosted_plugin > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "deprecated": false, "key": "skills", "docstring": "Skills installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "elementType": { "kind": "HttpTypeReference", "ident": "HostedSkill", "$ref": "(resource) beta.agents > (model) hosted_skill > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `openai_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } ] }, "default": "openai_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/remote_url", "deprecated": false, "key": "remote_url", "docstring": "Pass this URL unchanged to `codex exec-server --remote` when connecting this environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `self_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "self_hosted" } ] }, "default": "self_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/workspace_directory", "deprecated": false, "key": "workspace_directory", "docstring": "The absolute project directory inside the environment. Defaults to `/workspace`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments supplied by the model.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID to include when submitting the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/name", "deprecated": false, "key": "name", "docstring": "The function name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that requested the function call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/environment_id", "deprecated": false, "key": "environment_id", "docstring": "The ID of the environment to reconnect.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `environment_connection`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "environment_connection" } ] }, "default": "environment_connection", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "minimal" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "xhigh" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "max" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0": { "kind": "HttpDeclReference", "docstring": "Returns a concise reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "concise" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1": { "kind": "HttpDeclReference", "docstring": "Returns a detailed reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "detailed" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2": { "kind": "HttpDeclReference", "docstring": "Automatically selects the most detailed summary supported by the model.", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/0", "docstring": "Generates ordinary text without a structured-output constraint.", "ident": "Text", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/1", "docstring": "Constrains generated text to a JSON Schema.", "ident": "JSONSchema", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource", "docstring": "The effective output format for generated text.", "ident": "TextFormat", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/defer_loading", "deprecated": false, "key": "defer_loading", "docstring": "Whether the function is deferred and discovered through tool search.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/description", "deprecated": false, "key": "description", "docstring": "A description of what the function does.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "deprecated": false, "key": "parameters", "docstring": "A JSON Schema object describing the function's arguments.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } ] }, "default": "function", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether tools can be called from model-generated code.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `programmatic_tool_calling`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } ] }, "default": "programmatic_tool_calling", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "deprecated": false, "key": "allowed_tools", "docstring": "The MCP tools the agent may call.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "deprecated": false, "key": "connection_origin", "docstring": "Where outbound MCP HTTP connections originate.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "types": [ { "kind": "HttpTypeLiteral", "literal": "service" }, { "kind": "HttpTypeLiteral", "literal": "environment" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/credential_id", "deprecated": false, "key": "credential_id", "docstring": "The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "deprecated": false, "key": "request_metadata", "docstring": "Metadata included with requests to this MCP server.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/required", "deprecated": false, "key": "required", "docstring": "Whether this MCP server must initialize before the first turn.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "A label used to identify the MCP server in tool calls.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/transport", "deprecated": false, "key": "transport", "docstring": "The transport used to connect to the MCP server.", "type": { "kind": "HttpTypeReference", "ident": "McpTransport", "$ref": "(resource) beta.agents > (model) mcp_transport > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) mcp_transport", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `mcp`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } ] }, "default": "mcp", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Allowed search domains, or `null` when the search is unrestricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "deprecated": false, "key": "context_size", "docstring": "The amount of search context made available to the model. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/location", "deprecated": false, "key": "location", "docstring": "Approximate user location used to localize web search results.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "city" }, { "ident": "country" }, { "ident": "region" }, { "ident": "timezone" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "deprecated": false, "key": "mode", "docstring": "The source used for web search results.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "cached" }, { "kind": "HttpTypeLiteral", "literal": "live" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `web_search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search" } ] }, "default": "web_search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource/oneOf/1", "docstring": "A file supplied inline when the session was created.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "docstring": "Metadata for a file materialized in an OpenAI-hosted execution environment.", "ident": "HostedEnvironmentFile", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "deprecated": false, "key": "access", "docstring": "The environment's network access mode.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "types": [ { "kind": "HttpTypeLiteral", "literal": "enabled" }, { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "restricted" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Domains the environment may access when network access is restricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "deprecated": false, "key": "npm", "docstring": "npm packages installed globally in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "deprecated": false, "key": "python", "docstring": "Python packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "deprecated": false, "key": "system", "docstring": "System packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed plugin description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed plugin name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_plugin > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedPluginResource", "docstring": "A plugin installed from an inline ZIP archive.", "ident": "HostedPlugin", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource/oneOf/1", "docstring": "A skill installed from an inline ZIP archive.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource", "docstring": "A skill installed in an OpenAI-hosted environment.", "ident": "HostedSkill", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "self_hosted" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment_connection" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } ] }, "default": "text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "deprecated": false, "key": "schema", "docstring": "The JSON Schema that generated text must match.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } ] }, "default": "json_schema", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "service" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/0", "docstring": "Connects to an MCP server over HTTP.", "ident": "HTTP", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/1", "docstring": "Starts an MCP server as a local process.", "ident": "Stdio", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource", "docstring": "The transport used to connect to an MCP server.", "ident": "McpTransport", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/city", "deprecated": false, "key": "city", "docstring": "The city name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/country", "deprecated": false, "key": "country", "docstring": "The two-letter ISO country code, such as `US`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/region", "deprecated": false, "key": "region", "docstring": "The region or state name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/timezone", "deprecated": false, "key": "timezone", "docstring": "The IANA timezone, such as `America/Los_Angeles`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cached" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "live" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search" } }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/file_id", "deprecated": false, "key": "file_id", "docstring": "The ID of the uploaded file.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `file_id`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_id" } ] }, "default": "file_id", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId", "docstring": "A file copied from the OpenAI Files API.", "ident": "HostedEnvironmentFileID", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "file_id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0": { "kind": "HttpDeclReference", "docstring": "Allows unrestricted network access.", "type": { "kind": "HttpTypeLiteral", "literal": "enabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1": { "kind": "HttpDeclReference", "docstring": "Disables network access.", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2": { "kind": "HttpDeclReference", "docstring": "Allows access only to configured domains.", "type": { "kind": "HttpTypeLiteral", "literal": "restricted" } }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/skill_id", "deprecated": false, "key": "skill_id", "docstring": "The referenced skill ID.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `skill_reference`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "skill_reference" } ] }, "default": "skill_reference", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/version", "deprecated": false, "key": "version", "docstring": "The concrete skill version installed for this session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference", "docstring": "A skill installed from the Skills API.", "ident": "HostedSkillReference", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "skill_id" }, { "ident": "type" }, { "ident": "version" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "json_schema" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/server_url", "deprecated": false, "key": "server_url", "docstring": "The URL of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `http`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http" } ] }, "default": "http", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "deprecated": false, "key": "args", "docstring": "Arguments passed to the MCP server command.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/command", "deprecated": false, "key": "command", "docstring": "The command used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "deprecated": false, "key": "env_vars", "docstring": "Environment variable names inherited from the execution environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `stdio`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "stdio" } ] }, "default": "stdio", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "file_id" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "skill_reference" } }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "http" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "stdio" } } } ``` ### Example ```json { "type": "agent.session.requires_action", "event_id": "event_id", "session": { "metadata": { "foo": "string" }, "id": "id", "object": "agent.session", "created_at": 0, "last_active_at": 0, "status": "idle", "required_actions": [ { "type": "function_call", "turn_id": "turn_id", "call_id": "call_id", "name": "name", "arguments": {} } ], "error": "error", "agent": { "id": "id", "name": "name", "model": "model", "reasoning": { "effort": "none", "summary": "concise" }, "text": { "format": { "type": "text" }, "verbosity": "low" }, "service_tier": "auto", "instructions": "instructions", "tools": [ { "type": "function", "name": "name", "description": "description", "parameters": { "foo": "bar" }, "defer_loading": true } ], "multi_agent": { "enabled": true, "max_concurrent_subagents": 1 } }, "environment": { "type": "none" }, "vault_ids": [ "string" ], "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.failed Emitted when a session fails. ### Schema Schema name: `SessionEventAgentSessionFailed` ```json { "(resource) beta.agents > (model) agent_session_failed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionFailed", "docstring": "Emitted when a session fails.", "ident": "AgentSessionFailedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "session" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) session", "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionFailed/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) session": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionFailed/properties/session", "deprecated": false, "key": "session", "docstring": "The failed session.", "type": { "kind": "HttpTypeReference", "ident": "AgentSession", "$ref": "(resource) beta.agents > (model) agent_session > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionFailed/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.failed`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionFailed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.failed" } ] }, "default": "agent.session.failed", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/agent", "deprecated": false, "key": "agent", "docstring": "The agent running in the session.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "instructions" }, { "ident": "model" }, { "ident": "multi_agent" }, { "ident": "name" }, { "ident": "reasoning" }, { "ident": "service_tier" }, { "ident": "text" }, { "ident": "tools" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/created_at", "deprecated": false, "key": "created_at", "docstring": "The Unix timestamp, in seconds, when the session was created.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/environment", "deprecated": false, "key": "environment", "docstring": "The execution environment for the session.", "type": { "kind": "HttpTypeReference", "ident": "Environment", "$ref": "(resource) beta.agents > (model) environment > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) environment", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error that caused the session to fail, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/last_active_at", "deprecated": false, "key": "last_active_at", "docstring": "The Unix timestamp, in seconds, when the session was last active.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "deprecated": false, "key": "metadata", "docstring": "Custom string key-value pairs attached to the session.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/SessionResource/properties/metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeString" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session" } ] }, "default": "agent.session", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "deprecated": false, "key": "required_actions", "docstring": "Actions that must be completed before the session can continue.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/required_actions", "elementType": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/required_actions/items", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] } ] } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the session.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "idle" }, { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "requires_action" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) usage": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/usage", "deprecated": false, "key": "usage", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "type": { "kind": "HttpTypeReference", "ident": "TokenUsage", "$ref": "(resource) beta.agents > (model) token_usage > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) token_usage", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "deprecated": false, "key": "vault_ids", "docstring": "The IDs of vaults made available to the session.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionResource/properties/vault_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionResource", "docstring": "A Managed Agents session.", "ident": "AgentSession", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent" }, { "ident": "created_at" }, { "ident": "environment" }, { "ident": "error" }, { "ident": "last_active_at" }, { "ident": "metadata" }, { "ident": "object" }, { "ident": "required_actions" }, { "ident": "status" }, { "ident": "usage" }, { "ident": "vault_ids" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) id", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent", "(resource) beta.agents > (model) agent_session > (schema) > (property) created_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session > (schema) > (property) error", "(resource) beta.agents > (model) agent_session > (schema) > (property) last_active_at", "(resource) beta.agents > (model) agent_session > (schema) > (property) metadata", "(resource) beta.agents > (model) agent_session > (schema) > (property) object", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions", "(resource) beta.agents > (model) agent_session > (schema) > (property) status", "(resource) beta.agents > (model) agent_session > (schema) > (property) usage", "(resource) beta.agents > (model) agent_session > (schema) > (property) vault_ids" ] }, "(resource) beta.agents > (model) agent_session_failed_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.failed" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Custom instructions appended to the agent's default base instructions.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model used by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) multi_agent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/multi_agent", "deprecated": false, "key": "multi_agent", "docstring": "Configuration for creating and coordinating subagents.", "type": { "kind": "HttpTypeReference", "ident": "MultiAgentConfig", "$ref": "(resource) beta.agents > (model) multi_agent_config > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) multi_agent_config", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The reusable agent's name when the session was created, or null if no name was saved. Later changes to the agent's name do not affect this value.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) reasoning": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/reasoning", "deprecated": false, "key": "reasoning", "docstring": "The agent's reasoning configuration.", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoning", "$ref": "(resource) beta.agents > (model) agent_reasoning > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_reasoning", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "deprecated": false, "key": "service_tier", "docstring": "The effective service-tier policy for model requests. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionAgentResource/properties/service_tier", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" }, { "kind": "HttpTypeLiteral", "literal": "default" }, { "kind": "HttpTypeLiteral", "literal": "flex" }, { "kind": "HttpTypeLiteral", "literal": "priority" }, { "kind": "HttpTypeLiteral", "literal": "fast" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3", "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/text", "deprecated": false, "key": "text", "docstring": "Configuration for text generated by the agent.", "type": { "kind": "HttpTypeReference", "ident": "AgentText", "$ref": "(resource) beta.agents > (model) agent_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "deprecated": false, "key": "tools", "docstring": "Tools available to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SessionAgentResource/properties/tools", "elementType": { "kind": "HttpTypeReference", "ident": "AgentTool", "$ref": "(resource) beta.agents > (model) agent_tool > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/0", "docstring": "The session talks to CCA without selecting or provisioning an execution environment.", "ident": "None", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/1", "docstring": "An environment hosted by OpenAI.", "ident": "OpenAIHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource/oneOf/2", "docstring": "An environment hosted by the application.", "ident": "SelfHosted", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory" ] }, "(resource) beta.agents > (model) environment > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/EnvironmentResource", "docstring": "The execution environment for a session.", "ident": "Environment", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "files" }, { "ident": "network" }, { "ident": "packages" }, { "ident": "plugins" }, { "ident": "skills" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "capability_directories" }, { "ident": "remote_url" }, { "ident": "type" }, { "ident": "workspace_directory" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 2" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/0", "docstring": "Run a function tool and submit its result.", "ident": "FunctionCall", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionRequiredActionResource/oneOf/1", "docstring": "Reconnect a session environment.", "ident": "EnvironmentConnection", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id", "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The session has no turn in progress and is ready for input. A hosted environment may still be provisioning.", "type": { "kind": "HttpTypeLiteral", "literal": "idle" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The session is processing a turn.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The session is waiting for one or more required actions.", "type": { "kind": "HttpTypeLiteral", "literal": "requires_action" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The session failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens", "deprecated": false, "key": "input_tokens", "docstring": "The number of input tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/input_tokens_details", "deprecated": false, "key": "input_tokens_details", "docstring": "A breakdown of the agent's input token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "cached_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens", "deprecated": false, "key": "output_tokens", "docstring": "The number of output tokens generated by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/output_tokens_details", "deprecated": false, "key": "output_tokens_details", "docstring": "A breakdown of the agent's output token usage.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "reasoning_tokens" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TokenUsageResource/properties/total_tokens", "deprecated": false, "key": "total_tokens", "docstring": "The total number of input and output tokens used by the agent.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TokenUsageResource", "docstring": "Recorded token usage for a session or turn. Usage is best effort and may change.", "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "input_tokens" }, { "ident": "input_tokens_details" }, { "ident": "output_tokens" }, { "ident": "output_tokens_details" }, { "ident": "total_tokens" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens", "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details", "(resource) beta.agents > (model) token_usage > (schema) > (property) total_tokens" ] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether subagent tools are enabled. Defaults to false.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/MultiAgentConfigResource/properties/max_concurrent_subagents", "deprecated": false, "key": "max_concurrent_subagents", "docstring": "Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 1, "maximum": 4294967295 }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) multi_agent_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MultiAgentConfigResource", "docstring": "The resolved configuration for creating and coordinating subagents.", "ident": "MultiAgentConfig", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "max_concurrent_subagents" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) enabled", "(resource) beta.agents > (model) multi_agent_config > (schema) > (property) max_concurrent_subagents" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "deprecated": false, "key": "effort", "docstring": "The amount of reasoning effort used by an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/effort", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" }, { "kind": "HttpTypeLiteral", "literal": "minimal" }, { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" }, { "kind": "HttpTypeLiteral", "literal": "xhigh" }, { "kind": "HttpTypeLiteral", "literal": "max" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summary format requested from an agent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningResource/properties/summary", "types": [ { "kind": "HttpTypeLiteral", "literal": "concise" }, { "kind": "HttpTypeLiteral", "literal": "detailed" }, { "kind": "HttpTypeLiteral", "literal": "auto" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningResource", "docstring": "The reasoning configuration used by an agent.", "ident": "AgentReasoning", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "effort" }, { "ident": "summary" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort", "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "default" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "flex" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "priority" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) agent > (property) service_tier > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "fast" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) format": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/format", "deprecated": false, "key": "format", "docstring": "The effective output format. Defaults to ordinary text.", "type": { "kind": "HttpTypeReference", "ident": "TextFormat", "$ref": "(resource) beta.agents > (model) text_format > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) text_format", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "deprecated": false, "key": "verbosity", "docstring": "The amount of text produced by the agent. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextResource/properties/verbosity", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2" ] }, "(resource) beta.agents > (model) agent_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextResource", "docstring": "The text configuration used by an agent.", "ident": "AgentText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "format" }, { "ident": "verbosity" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_text > (schema) > (property) format", "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/0", "docstring": "A function defined by the application.", "ident": "Function", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/1", "docstring": "Enables calling tools from model-generated code.", "ident": "ProgrammaticToolCalling", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/2", "docstring": "Tools provided by a remote MCP server.", "ident": "Mcp", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource/oneOf/3", "docstring": "Web search.", "ident": "WebSearch", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) agent_tool > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentToolResource", "docstring": "A tool available to the agent.", "ident": "AgentTool", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "defer_loading" }, { "ident": "description" }, { "ident": "name" }, { "ident": "parameters" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "enabled" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_tools" }, { "ident": "connection_origin" }, { "ident": "credential_id" }, { "ident": "request_metadata" }, { "ident": "required" }, { "ident": "server_label" }, { "ident": "transport" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "allowed_domains" }, { "ident": "context_size" }, { "ident": "location" }, { "ident": "mode" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `none`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceNone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "none" } ] }, "default": "none", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) files": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "deprecated": false, "key": "files", "docstring": "Files available in the environment, excluding their contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/files", "elementType": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFile", "$ref": "(resource) beta.agents > (model) hosted_environment_file > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/network", "deprecated": false, "key": "network", "docstring": "The effective network access policy for the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "access" }, { "ident": "allowed_domains" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/packages", "deprecated": false, "key": "packages", "docstring": "Packages installed in the environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "npm" }, { "ident": "python" }, { "ident": "system" } ] }, "optional": false, "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) plugins": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "deprecated": false, "key": "plugins", "docstring": "Plugins installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/plugins", "elementType": { "kind": "HttpTypeReference", "ident": "HostedPlugin", "$ref": "(resource) beta.agents > (model) hosted_plugin > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) skills": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "deprecated": false, "key": "skills", "docstring": "Skills installed in the environment, excluding their archive contents.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/skills", "elementType": { "kind": "HttpTypeReference", "ident": "HostedSkill", "$ref": "(resource) beta.agents > (model) hosted_skill > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `openai_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceOpenaiHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } ] }, "default": "openai_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) capability_directories": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "deprecated": false, "key": "capability_directories", "docstring": "Directories that contain capabilities exposed to the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/capability_directories", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) remote_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/remote_url", "deprecated": false, "key": "remote_url", "docstring": "Pass this URL unchanged to `codex exec-server --remote` when connecting this environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `self_hosted`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "self_hosted" } ] }, "default": "self_hosted", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) workspace_directory": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentResourceSelfHosted/properties/workspace_directory", "deprecated": false, "key": "workspace_directory", "docstring": "The absolute project directory inside the environment. Defaults to `/workspace`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments supplied by the model.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID to include when submitting the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/name", "deprecated": false, "key": "name", "docstring": "The function name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that requested the function call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) environment_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/environment_id", "deprecated": false, "key": "environment_id", "docstring": "The ID of the environment to reconnect.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `environment_connection`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionRequiredActionResourceEnvironmentConnection/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "environment_connection" } ] }, "default": "environment_connection", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) input_tokens_details > (property) cached_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InputTokensDetailsResource/properties/cached_tokens", "deprecated": false, "key": "cached_tokens", "docstring": "The number of input tokens retrieved from the prompt cache.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) token_usage > (schema) > (property) output_tokens_details > (property) reasoning_tokens": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTokensDetailsResource/properties/reasoning_tokens", "deprecated": false, "key": "reasoning_tokens", "docstring": "The number of output tokens used for reasoning.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "minimal" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "xhigh" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) effort > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "max" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 0": { "kind": "HttpDeclReference", "docstring": "Returns a concise reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "concise" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 1": { "kind": "HttpDeclReference", "docstring": "Returns a detailed reasoning summary when supported.", "type": { "kind": "HttpTypeLiteral", "literal": "detailed" } }, "(resource) beta.agents > (model) agent_reasoning > (schema) > (property) summary > (member) 2": { "kind": "HttpDeclReference", "docstring": "Automatically selects the most detailed summary supported by the model.", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/0", "docstring": "Generates ordinary text without a structured-output constraint.", "ident": "Text", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource/oneOf/1", "docstring": "Constrains generated text to a JSON Schema.", "ident": "JSONSchema", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) text_format > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/TextFormatResource", "docstring": "The effective output format for generated text.", "ident": "TextFormat", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "schema" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0", "(resource) beta.agents > (model) text_format > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_text > (schema) > (property) verbosity > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) defer_loading": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/defer_loading", "deprecated": false, "key": "defer_loading", "docstring": "Whether the function is deferred and discovered through tool search.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/description", "deprecated": false, "key": "description", "docstring": "A description of what the function does.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) parameters": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "deprecated": false, "key": "parameters", "docstring": "A JSON Schema object describing the function's arguments.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/parameters", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `function`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } ] }, "default": "function", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) enabled": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/enabled", "deprecated": false, "key": "enabled", "docstring": "Whether tools can be called from model-generated code.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `programmatic_tool_calling`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceProgrammaticToolCalling/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } ] }, "default": "programmatic_tool_calling", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) allowed_tools": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "deprecated": false, "key": "allowed_tools", "docstring": "The MCP tools the agent may call.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/allowed_tools", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "deprecated": false, "key": "connection_origin", "docstring": "Where outbound MCP HTTP connections originate.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/connection_origin", "types": [ { "kind": "HttpTypeLiteral", "literal": "service" }, { "kind": "HttpTypeLiteral", "literal": "environment" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) credential_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/credential_id", "deprecated": false, "key": "credential_id", "docstring": "The attached vault credential selected for this MCP server, if any. Optional when exactly one attached credential matches the server URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) request_metadata": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "deprecated": false, "key": "request_metadata", "docstring": "Metadata included with requests to this MCP server.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/request_metadata", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) required": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/required", "deprecated": false, "key": "required", "docstring": "Whether this MCP server must initialize before the first turn.", "type": { "kind": "HttpTypeBoolean" }, "optional": false, "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "A label used to identify the MCP server in tool calls.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) transport": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/transport", "deprecated": false, "key": "transport", "docstring": "The transport used to connect to the MCP server.", "type": { "kind": "HttpTypeReference", "ident": "McpTransport", "$ref": "(resource) beta.agents > (model) mcp_transport > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) mcp_transport", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `mcp`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceMcp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } ] }, "default": "mcp", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Allowed search domains, or `null` when the search is unrestricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "deprecated": false, "key": "context_size", "docstring": "The amount of search context made available to the model. Defaults to `medium`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/context_size", "types": [ { "kind": "HttpTypeLiteral", "literal": "low" }, { "kind": "HttpTypeLiteral", "literal": "medium" }, { "kind": "HttpTypeLiteral", "literal": "high" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/location", "deprecated": false, "key": "location", "docstring": "Approximate user location used to localize web search results.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "city" }, { "ident": "country" }, { "ident": "region" }, { "ident": "timezone" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "deprecated": false, "key": "mode", "docstring": "The source used for web search results.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "cached" }, { "kind": "HttpTypeLiteral", "literal": "live" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1", "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `web_search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentToolResourceWebSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search" } ] }, "default": "web_search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "none" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource/oneOf/1", "docstring": "A file supplied inline when the session was created.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "docstring": "Metadata for a file materialized in an OpenAI-hosted execution environment.", "ident": "HostedEnvironmentFile", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedEnvironmentFileID", "$ref": "(resource) beta.agents > (model) hosted_environment_file_id > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "deprecated": false, "key": "access", "docstring": "The environment's network access mode.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/access", "types": [ { "kind": "HttpTypeLiteral", "literal": "enabled" }, { "kind": "HttpTypeLiteral", "literal": "disabled" }, { "kind": "HttpTypeLiteral", "literal": "restricted" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1", "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) allowed_domains": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "deprecated": false, "key": "allowed_domains", "docstring": "Domains the environment may access when network access is restricted.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/NetworkPolicyResource/properties/allowed_domains", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) npm": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "deprecated": false, "key": "npm", "docstring": "npm packages installed globally in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/npm", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) python": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "deprecated": false, "key": "python", "docstring": "Python packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/python", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) packages > (property) system": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "deprecated": false, "key": "system", "docstring": "System packages installed in the environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/EnvironmentPackagesResource/properties/system", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed plugin description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed plugin name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedPluginResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_plugin > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedPluginResource", "docstring": "A plugin installed from an inline ZIP archive.", "ident": "HostedPlugin", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) description", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) name", "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource/oneOf/1", "docstring": "A skill installed from an inline ZIP archive.", "ident": "Inline", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) hosted_skill > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResource", "docstring": "A skill installed in an OpenAI-hosted environment.", "ident": "HostedSkill", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResource", "types": [ { "kind": "HttpTypeReference", "ident": "HostedSkillReference", "$ref": "(resource) beta.agents > (model) hosted_skill_reference > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 0", "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "openai_hosted" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "self_hosted" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_session > (schema) > (property) required_actions > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment_connection" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceText/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "text" } ] }, "default": "text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) schema": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "deprecated": false, "key": "schema", "docstring": "The JSON Schema that generated text must match.", "type": { "kind": "HttpTypeReference", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/schema", "ident": "Record", "typeParameters": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnknown" } ] }, "optional": false, "nullable": false, "schemaType": "map", "children": [] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `json_schema`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/TextFormatResourceJsonSchema/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "json_schema" } ] }, "default": "json_schema", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic_tool_calling" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "service" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) connection_origin > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "environment" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/0", "docstring": "Connects to an MCP server over HTTP.", "ident": "HTTP", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource/oneOf/1", "docstring": "Starts an MCP server as a local process.", "ident": "Stdio", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) mcp_transport > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpTransportResource", "docstring": "The transport used to connect to an MCP server.", "ident": "McpTransport", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "server_url" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "args" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "env_vars" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0", "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) context_size > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) city": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/city", "deprecated": false, "key": "city", "docstring": "The city name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) country": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/country", "deprecated": false, "key": "country", "docstring": "The two-letter ISO country code, such as `US`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) region": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/region", "deprecated": false, "key": "region", "docstring": "The region or state name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) location > (property) timezone": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchLocationResource/properties/timezone", "deprecated": false, "key": "timezone", "docstring": "The IANA timezone, such as `America/Los_Angeles`.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cached" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) mode > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "live" } }, "(resource) beta.agents > (model) agent_tool > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search" } }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/file_id", "deprecated": false, "key": "file_id", "docstring": "The ID of the uploaded file.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `file_id`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "file_id" } ] }, "default": "file_id", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceFileId", "docstring": "A file copied from the OpenAI Files API.", "ident": "HostedEnvironmentFileID", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "file_id" }, { "ident": "path" }, { "ident": "size_bytes" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) file_id", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) path", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) size_bytes", "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type" ] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/id", "deprecated": false, "key": "id", "docstring": "The session-scoped ID of the file in the execution environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) path": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/path", "deprecated": false, "key": "path", "docstring": "The file's absolute path inside the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) size_bytes": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/size_bytes", "deprecated": false, "key": "size_bytes", "docstring": "The decoded file size in bytes.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedEnvironmentFileResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 0": { "kind": "HttpDeclReference", "docstring": "Allows unrestricted network access.", "type": { "kind": "HttpTypeLiteral", "literal": "enabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 1": { "kind": "HttpDeclReference", "docstring": "Disables network access.", "type": { "kind": "HttpTypeLiteral", "literal": "disabled" } }, "(resource) beta.agents > (model) environment > (schema) > (variant) 1 > (property) network > (property) access > (member) 2": { "kind": "HttpDeclReference", "docstring": "Allows access only to configured domains.", "type": { "kind": "HttpTypeLiteral", "literal": "restricted" } }, "(resource) beta.agents > (model) hosted_plugin > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/skill_id", "deprecated": false, "key": "skill_id", "docstring": "The referenced skill ID.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `skill_reference`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "skill_reference" } ] }, "default": "skill_reference", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference/properties/version", "deprecated": false, "key": "version", "docstring": "The concrete skill version installed for this session.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill_reference > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/HostedSkillResourceSkillReference", "docstring": "A skill installed from the Skills API.", "ident": "HostedSkillReference", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "description" }, { "ident": "name" }, { "ident": "skill_id" }, { "ident": "type" }, { "ident": "version" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) description", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) name", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) skill_id", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type", "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) version" ] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) description": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/description", "deprecated": false, "key": "description", "docstring": "The installed skill description.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/name", "deprecated": false, "key": "name", "docstring": "The installed skill name.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `inline`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/HostedSkillResourceInline/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "inline" } ] }, "default": "inline", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, "(resource) beta.agents > (model) text_format > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "json_schema" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) server_url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/server_url", "deprecated": false, "key": "server_url", "docstring": "The URL of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `http`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceHttp/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http" } ] }, "default": "http", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) args": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "deprecated": false, "key": "args", "docstring": "Arguments passed to the MCP server command.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/args", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/command", "deprecated": false, "key": "command", "docstring": "The command used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to start the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) env_vars": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "deprecated": false, "key": "env_vars", "docstring": "Environment variable names inherited from the execution environment.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/env_vars", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `stdio`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpTransportResourceStdio/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "stdio" } ] }, "default": "stdio", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) hosted_environment_file_id > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "file_id" } }, "(resource) beta.agents > (model) hosted_environment_file > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) hosted_skill_reference > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "skill_reference" } }, "(resource) beta.agents > (model) hosted_skill > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inline" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "http" } }, "(resource) beta.agents > (model) mcp_transport > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "stdio" } } } ``` ### Example ```json { "type": "agent.session.failed", "event_id": "event_id", "session": { "metadata": { "foo": "string" }, "id": "id", "object": "agent.session", "created_at": 0, "last_active_at": 0, "status": "idle", "required_actions": [ { "type": "function_call", "turn_id": "turn_id", "call_id": "call_id", "name": "name", "arguments": {} } ], "error": "error", "agent": { "id": "id", "name": "name", "model": "model", "reasoning": { "effort": "none", "summary": "concise" }, "text": { "format": { "type": "text" }, "verbosity": "low" }, "service_tier": "auto", "instructions": "instructions", "tools": [ { "type": "function", "name": "name", "description": "description", "parameters": { "foo": "bar" }, "defer_loading": true } ], "multi_agent": { "enabled": true, "max_concurrent_subagents": 1 } }, "environment": { "type": "none" }, "vault_ids": [ "string" ], "usage": { "input_tokens": 0, "input_tokens_details": { "cached_tokens": 0 }, "output_tokens": 0, "output_tokens_details": { "reasoning_tokens": 0 }, "total_tokens": 0 } } } ``` ## agent.session.environment.pending Emitted while a session environment is being prepared. ### Schema Schema name: `SessionEventAgentSessionEnvironmentPending` ```json { "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending", "docstring": "Emitted while a session environment is being prepared.", "ident": "AgentSessionEnvironmentPendingEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment" }, { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending/properties/environment", "deprecated": false, "key": "environment", "docstring": "The current environment state.", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionEnvironmentState", "$ref": "(resource) beta.agents > (model) agent_session_environment_state > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session_environment_state", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.environment.pending`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentPending/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.pending" } ] }, "default": "agent.session.environment.pending", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/error", "deprecated": false, "key": "error", "docstring": "An error reported while preparing a session environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" }, { "ident": "type" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "deprecated": false, "key": "status", "docstring": "The environment's connection status.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "pending" }, { "kind": "HttpTypeLiteral", "literal": "ready" }, { "kind": "HttpTypeLiteral", "literal": "connected" }, { "kind": "HttpTypeLiteral", "literal": "disconnected" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/type", "deprecated": false, "key": "type", "docstring": "The environment type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEnvironmentStateResource", "docstring": "The current state of a session environment.", "ident": "AgentSessionEnvironmentState", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "error" }, { "ident": "status" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_pending_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.pending" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A machine-readable error code.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/type", "deprecated": false, "key": "type", "docstring": "The error type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The environment is being prepared.", "type": { "kind": "HttpTypeLiteral", "literal": "pending" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The environment is ready to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "ready" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The environment is connected.", "type": { "kind": "HttpTypeLiteral", "literal": "connected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The environment is disconnected.", "type": { "kind": "HttpTypeLiteral", "literal": "disconnected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The environment failed to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } } } ``` ### Example ```json { "type": "agent.session.environment.pending", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "environment": { "id": "id", "type": "type", "status": "pending", "error": { "type": "type", "code": "code", "message": "message" } } } ``` ## agent.session.environment.connected Emitted when a session environment connects. ### Schema Schema name: `SessionEventAgentSessionEnvironmentConnected` ```json { "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected", "docstring": "Emitted when a session environment connects.", "ident": "AgentSessionEnvironmentConnectedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment" }, { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected/properties/environment", "deprecated": false, "key": "environment", "docstring": "The current environment state.", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionEnvironmentState", "$ref": "(resource) beta.agents > (model) agent_session_environment_state > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session_environment_state", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.environment.connected`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentConnected/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.connected" } ] }, "default": "agent.session.environment.connected", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/error", "deprecated": false, "key": "error", "docstring": "An error reported while preparing a session environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" }, { "ident": "type" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "deprecated": false, "key": "status", "docstring": "The environment's connection status.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "pending" }, { "kind": "HttpTypeLiteral", "literal": "ready" }, { "kind": "HttpTypeLiteral", "literal": "connected" }, { "kind": "HttpTypeLiteral", "literal": "disconnected" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/type", "deprecated": false, "key": "type", "docstring": "The environment type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEnvironmentStateResource", "docstring": "The current state of a session environment.", "ident": "AgentSessionEnvironmentState", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "error" }, { "ident": "status" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_connected_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.connected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A machine-readable error code.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/type", "deprecated": false, "key": "type", "docstring": "The error type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The environment is being prepared.", "type": { "kind": "HttpTypeLiteral", "literal": "pending" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The environment is ready to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "ready" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The environment is connected.", "type": { "kind": "HttpTypeLiteral", "literal": "connected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The environment is disconnected.", "type": { "kind": "HttpTypeLiteral", "literal": "disconnected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The environment failed to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } } } ``` ### Example ```json { "type": "agent.session.environment.connected", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "environment": { "id": "id", "type": "type", "status": "pending", "error": { "type": "type", "code": "code", "message": "message" } } } ``` ## agent.session.environment.disconnected Emitted when a session environment disconnects. ### Schema Schema name: `SessionEventAgentSessionEnvironmentDisconnected` ```json { "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected", "docstring": "Emitted when a session environment disconnects.", "ident": "AgentSessionEnvironmentDisconnectedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment" }, { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected/properties/environment", "deprecated": false, "key": "environment", "docstring": "The current environment state.", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionEnvironmentState", "$ref": "(resource) beta.agents > (model) agent_session_environment_state > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session_environment_state", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.environment.disconnected`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentDisconnected/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.disconnected" } ] }, "default": "agent.session.environment.disconnected", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/error", "deprecated": false, "key": "error", "docstring": "An error reported while preparing a session environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" }, { "ident": "type" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "deprecated": false, "key": "status", "docstring": "The environment's connection status.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "pending" }, { "kind": "HttpTypeLiteral", "literal": "ready" }, { "kind": "HttpTypeLiteral", "literal": "connected" }, { "kind": "HttpTypeLiteral", "literal": "disconnected" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/type", "deprecated": false, "key": "type", "docstring": "The environment type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEnvironmentStateResource", "docstring": "The current state of a session environment.", "ident": "AgentSessionEnvironmentState", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "error" }, { "ident": "status" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_disconnected_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.disconnected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A machine-readable error code.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/type", "deprecated": false, "key": "type", "docstring": "The error type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The environment is being prepared.", "type": { "kind": "HttpTypeLiteral", "literal": "pending" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The environment is ready to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "ready" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The environment is connected.", "type": { "kind": "HttpTypeLiteral", "literal": "connected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The environment is disconnected.", "type": { "kind": "HttpTypeLiteral", "literal": "disconnected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The environment failed to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } } } ``` ### Example ```json { "type": "agent.session.environment.disconnected", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "environment": { "id": "id", "type": "type", "status": "pending", "error": { "type": "type", "code": "code", "message": "message" } } } ``` ## agent.session.environment.failed Emitted when a session environment fails. ### Schema Schema name: `SessionEventAgentSessionEnvironmentFailed` ```json { "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed", "docstring": "Emitted when a session environment fails.", "ident": "AgentSessionEnvironmentFailedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "environment" }, { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) environment", "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) environment": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed/properties/environment", "deprecated": false, "key": "environment", "docstring": "The current environment state.", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionEnvironmentState", "$ref": "(resource) beta.agents > (model) agent_session_environment_state > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) agent_session_environment_state", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.environment.failed`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionEnvironmentFailed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.failed" } ] }, "default": "agent.session.environment.failed", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/id", "deprecated": false, "key": "id", "docstring": "The public ID of the environment.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/error", "deprecated": false, "key": "error", "docstring": "An error reported while preparing a session environment.", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" }, { "ident": "type" } ] }, "optional": false, "nullable": true, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "deprecated": false, "key": "status", "docstring": "The environment's connection status.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "pending" }, { "kind": "HttpTypeLiteral", "literal": "ready" }, { "kind": "HttpTypeLiteral", "literal": "connected" }, { "kind": "HttpTypeLiteral", "literal": "disconnected" }, { "kind": "HttpTypeLiteral", "literal": "failed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4" ] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentStateResource/properties/type", "deprecated": false, "key": "type", "docstring": "The environment type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEnvironmentStateResource", "docstring": "The current state of a session environment.", "ident": "AgentSessionEnvironmentState", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "error" }, { "ident": "status" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_environment_failed_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.environment.failed" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "A machine-readable error code.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEnvironmentErrorResource/properties/type", "deprecated": false, "key": "type", "docstring": "The error type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The environment is being prepared.", "type": { "kind": "HttpTypeLiteral", "literal": "pending" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The environment is ready to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "ready" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 2": { "kind": "HttpDeclReference", "docstring": "The environment is connected.", "type": { "kind": "HttpTypeLiteral", "literal": "connected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 3": { "kind": "HttpDeclReference", "docstring": "The environment is disconnected.", "type": { "kind": "HttpTypeLiteral", "literal": "disconnected" } }, "(resource) beta.agents > (model) agent_session_environment_state > (schema) > (property) status > (member) 4": { "kind": "HttpDeclReference", "docstring": "The environment failed to connect.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } } } ``` ### Example ```json { "type": "agent.session.environment.failed", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "environment": { "id": "id", "type": "type", "status": "pending", "error": { "type": "type", "code": "code", "message": "message" } } } ``` ## agent.session.subagent.created Emitted when a subagent is created. ### Schema Schema name: `SessionEventAgentSessionSubagentCreated` ```json { "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentCreated", "docstring": "Emitted when a subagent is created.", "ident": "AgentSessionSubagentCreatedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "subagent" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) subagent", "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentCreated/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) subagent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentCreated/properties/subagent", "deprecated": false, "key": "subagent", "docstring": "The subagent that was created.", "type": { "kind": "HttpTypeReference", "ident": "Subagent", "$ref": "(resource) beta.agents > (model) subagent > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) subagent", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) id", "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at", "(resource) beta.agents > (model) subagent > (schema) > (property) instructions", "(resource) beta.agents > (model) subagent > (schema) > (property) name", "(resource) beta.agents > (model) subagent > (schema) > (property) object", "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at", "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id", "(resource) beta.agents > (model) subagent > (schema) > (property) session_id", "(resource) beta.agents > (model) subagent > (schema) > (property) status" ] }, "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentCreated/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.subagent.created`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent.created" } ] }, "default": "agent.session.subagent.created", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/closed_at", "deprecated": false, "key": "closed_at", "docstring": "The Unix timestamp, in seconds, when the subagent was closed. Null while active, including after resume.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Initial task content, or null when unavailable. Text may contain placeholders for images or audio when only a preview is available.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SubagentResource/properties/instructions", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": true, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The runner-assigned nickname, or null when unavailable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.subagent`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SubagentResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent" } ] }, "default": "agent.session.subagent", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/opened_at", "deprecated": false, "key": "opened_at", "docstring": "The Unix timestamp, in seconds, when the subagent was first opened. Resuming does not change it.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/parent_agent_id", "deprecated": false, "key": "parent_agent_id", "docstring": "The ID of the agent that created this subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the subagent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SubagentResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "active" }, { "kind": "HttpTypeLiteral", "literal": "closed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 1" ] }, "(resource) beta.agents > (model) subagent > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SubagentResource", "docstring": "A subagent created within a session.", "ident": "Subagent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "closed_at" }, { "ident": "instructions" }, { "ident": "name" }, { "ident": "object" }, { "ident": "opened_at" }, { "ident": "parent_agent_id" }, { "ident": "session_id" }, { "ident": "status" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) id", "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at", "(resource) beta.agents > (model) subagent > (schema) > (property) instructions", "(resource) beta.agents > (model) subagent > (schema) > (property) name", "(resource) beta.agents > (model) subagent > (schema) > (property) object", "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at", "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id", "(resource) beta.agents > (model) subagent > (schema) > (property) session_id", "(resource) beta.agents > (model) subagent > (schema) > (property) status" ] }, "(resource) beta.agents > (model) agent_session_subagent_created_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent.created" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource/oneOf/1", "docstring": "Encrypted content exchanged between agents.", "ident": "EncryptedContent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource", "docstring": "A plaintext or encrypted content part exchanged between agents.", "ident": "AgentContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentContentResource", "types": [ { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent" } }, "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The subagent remains available, including while idle between turns.", "type": { "kind": "HttpTypeLiteral", "literal": "active" } }, "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The subagent is closed.", "type": { "kind": "HttpTypeLiteral", "literal": "closed" } }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/encrypted_content", "deprecated": false, "key": "encrypted_content", "docstring": "The encrypted content payload.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `encrypted_content`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } ] }, "default": "encrypted_content", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } } } ``` ### Example ```json { "type": "agent.session.subagent.created", "event_id": "event_id", "subagent": { "id": "id", "object": "agent.session.subagent", "session_id": "session_id", "name": "name", "instructions": [ { "type": "output_text", "text": "text" } ], "parent_agent_id": "parent_agent_id", "status": "active", "opened_at": 0, "closed_at": 0 } } ``` ## agent.session.subagent.active Emitted when a closed subagent successfully resumes. ### Schema Schema name: `SessionEventAgentSessionSubagentActive` ```json { "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentActive", "docstring": "Emitted when a closed subagent successfully resumes.", "ident": "AgentSessionSubagentActiveEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "subagent" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) subagent", "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentActive/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) subagent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentActive/properties/subagent", "deprecated": false, "key": "subagent", "docstring": "The subagent that resumed.", "type": { "kind": "HttpTypeReference", "ident": "Subagent", "$ref": "(resource) beta.agents > (model) subagent > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) subagent", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) id", "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at", "(resource) beta.agents > (model) subagent > (schema) > (property) instructions", "(resource) beta.agents > (model) subagent > (schema) > (property) name", "(resource) beta.agents > (model) subagent > (schema) > (property) object", "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at", "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id", "(resource) beta.agents > (model) subagent > (schema) > (property) session_id", "(resource) beta.agents > (model) subagent > (schema) > (property) status" ] }, "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentActive/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.subagent.active`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentActive/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent.active" } ] }, "default": "agent.session.subagent.active", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/closed_at", "deprecated": false, "key": "closed_at", "docstring": "The Unix timestamp, in seconds, when the subagent was closed. Null while active, including after resume.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Initial task content, or null when unavailable. Text may contain placeholders for images or audio when only a preview is available.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SubagentResource/properties/instructions", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": true, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The runner-assigned nickname, or null when unavailable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.subagent`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SubagentResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent" } ] }, "default": "agent.session.subagent", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/opened_at", "deprecated": false, "key": "opened_at", "docstring": "The Unix timestamp, in seconds, when the subagent was first opened. Resuming does not change it.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/parent_agent_id", "deprecated": false, "key": "parent_agent_id", "docstring": "The ID of the agent that created this subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the subagent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SubagentResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "active" }, { "kind": "HttpTypeLiteral", "literal": "closed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 1" ] }, "(resource) beta.agents > (model) subagent > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SubagentResource", "docstring": "A subagent created within a session.", "ident": "Subagent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "closed_at" }, { "ident": "instructions" }, { "ident": "name" }, { "ident": "object" }, { "ident": "opened_at" }, { "ident": "parent_agent_id" }, { "ident": "session_id" }, { "ident": "status" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) id", "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at", "(resource) beta.agents > (model) subagent > (schema) > (property) instructions", "(resource) beta.agents > (model) subagent > (schema) > (property) name", "(resource) beta.agents > (model) subagent > (schema) > (property) object", "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at", "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id", "(resource) beta.agents > (model) subagent > (schema) > (property) session_id", "(resource) beta.agents > (model) subagent > (schema) > (property) status" ] }, "(resource) beta.agents > (model) agent_session_subagent_active_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent.active" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource/oneOf/1", "docstring": "Encrypted content exchanged between agents.", "ident": "EncryptedContent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource", "docstring": "A plaintext or encrypted content part exchanged between agents.", "ident": "AgentContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentContentResource", "types": [ { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent" } }, "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The subagent remains available, including while idle between turns.", "type": { "kind": "HttpTypeLiteral", "literal": "active" } }, "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The subagent is closed.", "type": { "kind": "HttpTypeLiteral", "literal": "closed" } }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/encrypted_content", "deprecated": false, "key": "encrypted_content", "docstring": "The encrypted content payload.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `encrypted_content`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } ] }, "default": "encrypted_content", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } } } ``` ### Example ```json { "type": "agent.session.subagent.active", "event_id": "event_id", "subagent": { "id": "id", "object": "agent.session.subagent", "session_id": "session_id", "name": "name", "instructions": [ { "type": "output_text", "text": "text" } ], "parent_agent_id": "parent_agent_id", "status": "active", "opened_at": 0, "closed_at": 0 } } ``` ## agent.session.subagent.closed Emitted when a subagent is closed. ### Schema Schema name: `SessionEventAgentSessionSubagentClosed` ```json { "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentClosed", "docstring": "Emitted when a subagent is closed.", "ident": "AgentSessionSubagentClosedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "subagent" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) subagent", "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentClosed/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) subagent": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentClosed/properties/subagent", "deprecated": false, "key": "subagent", "docstring": "The subagent that was closed.", "type": { "kind": "HttpTypeReference", "ident": "Subagent", "$ref": "(resource) beta.agents > (model) subagent > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) subagent", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) id", "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at", "(resource) beta.agents > (model) subagent > (schema) > (property) instructions", "(resource) beta.agents > (model) subagent > (schema) > (property) name", "(resource) beta.agents > (model) subagent > (schema) > (property) object", "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at", "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id", "(resource) beta.agents > (model) subagent > (schema) > (property) session_id", "(resource) beta.agents > (model) subagent > (schema) > (property) status" ] }, "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentClosed/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.subagent.closed`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionSubagentClosed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent.closed" } ] }, "default": "agent.session.subagent.closed", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/closed_at", "deprecated": false, "key": "closed_at", "docstring": "The Unix timestamp, in seconds, when the subagent was closed. Null while active, including after resume.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) instructions": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/instructions", "deprecated": false, "key": "instructions", "docstring": "Initial task content, or null when unavailable. Text may contain placeholders for images or audio when only a preview is available.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SubagentResource/properties/instructions", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": true, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/name", "deprecated": false, "key": "name", "docstring": "The runner-assigned nickname, or null when unavailable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) object": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/object", "deprecated": false, "key": "object", "docstring": "The object type. Always `agent.session.subagent`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SubagentResource/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent" } ] }, "default": "agent.session.subagent", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) object > (member) 0" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/opened_at", "deprecated": false, "key": "opened_at", "docstring": "The Unix timestamp, in seconds, when the subagent was first opened. Resuming does not change it.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/parent_agent_id", "deprecated": false, "key": "parent_agent_id", "docstring": "The ID of the agent that created this subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session that owns the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) subagent > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SubagentResource/properties/status", "deprecated": false, "key": "status", "docstring": "The current status of the subagent.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SubagentResource/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "active" }, { "kind": "HttpTypeLiteral", "literal": "closed" } ] }, "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 0", "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 1" ] }, "(resource) beta.agents > (model) subagent > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SubagentResource", "docstring": "A subagent created within a session.", "ident": "Subagent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "closed_at" }, { "ident": "instructions" }, { "ident": "name" }, { "ident": "object" }, { "ident": "opened_at" }, { "ident": "parent_agent_id" }, { "ident": "session_id" }, { "ident": "status" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) subagent > (schema) > (property) id", "(resource) beta.agents > (model) subagent > (schema) > (property) closed_at", "(resource) beta.agents > (model) subagent > (schema) > (property) instructions", "(resource) beta.agents > (model) subagent > (schema) > (property) name", "(resource) beta.agents > (model) subagent > (schema) > (property) object", "(resource) beta.agents > (model) subagent > (schema) > (property) opened_at", "(resource) beta.agents > (model) subagent > (schema) > (property) parent_agent_id", "(resource) beta.agents > (model) subagent > (schema) > (property) session_id", "(resource) beta.agents > (model) subagent > (schema) > (property) status" ] }, "(resource) beta.agents > (model) agent_session_subagent_closed_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent.closed" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource/oneOf/1", "docstring": "Encrypted content exchanged between agents.", "ident": "EncryptedContent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource", "docstring": "A plaintext or encrypted content part exchanged between agents.", "ident": "AgentContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentContentResource", "types": [ { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) subagent > (schema) > (property) object > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.subagent" } }, "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "docstring": "The subagent remains available, including while idle between turns.", "type": { "kind": "HttpTypeLiteral", "literal": "active" } }, "(resource) beta.agents > (model) subagent > (schema) > (property) status > (member) 1": { "kind": "HttpDeclReference", "docstring": "The subagent is closed.", "type": { "kind": "HttpTypeLiteral", "literal": "closed" } }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/encrypted_content", "deprecated": false, "key": "encrypted_content", "docstring": "The encrypted content payload.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `encrypted_content`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } ] }, "default": "encrypted_content", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } } } ``` ### Example ```json { "type": "agent.session.subagent.closed", "event_id": "event_id", "subagent": { "id": "id", "object": "agent.session.subagent", "session_id": "session_id", "name": "name", "instructions": [ { "type": "output_text", "text": "text" } ], "parent_agent_id": "parent_agent_id", "status": "active", "opened_at": 0, "closed_at": 0 } } ``` ## agent.session.turn.item.done Emitted when an output item is complete. ### Schema Schema name: `SessionEventAgentSessionTurnItemDone` ```json { "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone", "docstring": "Emitted when an output item is complete.", "ident": "AgentSessionTurnItemDoneEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "item" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) item", "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) item": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/item", "deprecated": false, "key": "item", "docstring": "The completed output item.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItem", "$ref": "(resource) beta.agents > (model) agent_output_item > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) agent_output_item", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 3", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 4", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 5", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 6", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 7", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 8", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 9", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 10", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 11" ] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the output item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.item.done`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnItemDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.item.done" } ] }, "default": "agent.session.turn.item.done", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentSessionAssistantMessage", "$ref": "(resource) beta.agents > (model) agent_session_assistant_message > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) content", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) role", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentReasoningItem", "$ref": "(resource) beta.agents > (model) agent_reasoning_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) summary", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallItem", "$ref": "(resource) beta.agents > (model) agent_function_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) call_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentMcpCallItem", "$ref": "(resource) beta.agents > (model) agent_mcp_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) error", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) server_label", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentWebSearchCallItem", "$ref": "(resource) beta.agents > (model) agent_web_search_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) action", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentCommandExecutionItem", "$ref": "(resource) beta.agents > (model) agent_command_execution_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) command", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) cwd", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) duration_ms", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) exit_code", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentCreateSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) agent_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) model", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) reasoning_effort", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentSendSubagentInputCallItem", "$ref": "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentResumeSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 9": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentWaitForSubagentsCallItem", "$ref": "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) recipient_agent_ids", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 10": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentInterruptSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 11": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "AgentCloseSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_output_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentOutputItemResource", "docstring": "An output item produced by an agent.", "ident": "AgentOutputItem", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentOutputItemResource", "types": [ { "kind": "HttpTypeReference", "ident": "AgentSessionAssistantMessage", "$ref": "(resource) beta.agents > (model) agent_session_assistant_message > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentReasoningItem", "$ref": "(resource) beta.agents > (model) agent_reasoning_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentFunctionCallItem", "$ref": "(resource) beta.agents > (model) agent_function_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentMcpCallItem", "$ref": "(resource) beta.agents > (model) agent_mcp_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentWebSearchCallItem", "$ref": "(resource) beta.agents > (model) agent_web_search_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentCommandExecutionItem", "$ref": "(resource) beta.agents > (model) agent_command_execution_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentCreateSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentSendSubagentInputCallItem", "$ref": "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentResumeSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentWaitForSubagentsCallItem", "$ref": "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentInterruptSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema)" }, { "kind": "HttpTypeReference", "ident": "AgentCloseSubagentCallItem", "$ref": "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema)" } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 1", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 2", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 3", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 4", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 5", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 6", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 7", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 8", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 9", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 10", "(resource) beta.agents > (model) agent_output_item > (schema) > (variant) 11" ] }, "(resource) beta.agents > (model) agent_session_turn_item_done_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.item.done" } }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the message.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/phase", "deprecated": false, "key": "phase", "docstring": "The phase of an assistant message.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/phase", "types": [ { "kind": "HttpTypeLiteral", "literal": "commentary" }, { "kind": "HttpTypeLiteral", "literal": "final_answer" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase > (member) 0", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase > (member) 1" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/role", "deprecated": false, "key": "role", "docstring": "The role of the message author. Always `assistant`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } ] }, "default": "assistant", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) role > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the message.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItemStatus", "$ref": "(resource) beta.agents > (model) agent_output_item_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_output_item_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `message`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AssistantMessageItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } ] }, "default": "message", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AssistantMessageItemResource", "docstring": "An assistant message produced by the agent.", "ident": "AgentSessionAssistantMessage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "content" }, { "ident": "phase" }, { "ident": "role" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) id", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) content", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) role", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the reasoning item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of an agent output item.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItemStatus", "$ref": "(resource) beta.agents > (model) agent_output_item_status > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_output_item_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) summary": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/summary", "deprecated": false, "key": "summary", "docstring": "The reasoning summaries produced by the agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/ReasoningItemResource/properties/summary", "elementType": { "kind": "HttpTypeReference", "ident": "SummaryText", "$ref": "(resource) beta.agents > (model) summary_text > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ReasoningItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `reasoning`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ReasoningItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "reasoning" } ] }, "default": "reasoning", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ReasoningItemResource", "docstring": "A reasoning item produced by the agent.", "ident": "AgentReasoningItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "status" }, { "ident": "summary" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) summary", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the function call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments to pass to the function.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) call_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/call_id", "deprecated": false, "key": "call_id", "docstring": "The ID used to submit the function result.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the function call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `function_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/FunctionCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } ] }, "default": "function_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallItemResource", "docstring": "A function call produced by the agent.", "ident": "AgentFunctionCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "arguments" }, { "ident": "call_id" }, { "ident": "name" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) call_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the MCP call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) arguments": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/arguments", "deprecated": false, "key": "arguments", "docstring": "The arguments passed to the MCP tool.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/error", "deprecated": false, "key": "error", "docstring": "The error returned by the MCP tool, if any.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) name": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/name", "deprecated": false, "key": "name", "docstring": "The name of the MCP tool.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) output": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/output", "deprecated": false, "key": "output", "docstring": "The output returned by the MCP tool, if any.", "type": { "kind": "HttpTypeUnknown" }, "optional": false, "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) server_label": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/server_label", "deprecated": false, "key": "server_label", "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the MCP tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/McpCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/McpCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } ] }, "default": "mcp_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/McpCallItemResource", "docstring": "A call to a tool on an MCP server.", "ident": "AgentMcpCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "arguments" }, { "ident": "error" }, { "ident": "name" }, { "ident": "output" }, { "ident": "server_label" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) arguments", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) error", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) name", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) server_label", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the web search call.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) action": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/action", "deprecated": false, "key": "action", "docstring": "An action performed by the web search tool.", "type": { "kind": "HttpTypeReference", "ident": "WebSearchAction", "$ref": "(resource) beta.agents > (model) web_search_action > (schema)" }, "optional": false, "nullable": true, "modelImplicit": false, "schemaType": "union", "modelPath": "(resource) beta.agents > (model) web_search_action", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the web search call.", "type": { "kind": "HttpTypeReference", "ident": "AgentOutputItemStatus", "$ref": "(resource) beta.agents > (model) agent_output_item_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_output_item_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `web_search_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "web_search_call" } ] }, "default": "web_search_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchCallItemResource", "docstring": "A web search call produced by the agent.", "ident": "AgentWebSearchCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "action" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) action", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the command execution item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) command": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/command", "deprecated": false, "key": "command", "docstring": "The command that was executed.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) cwd": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/cwd", "deprecated": false, "key": "cwd", "docstring": "The working directory used to execute the command.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) duration_ms": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/duration_ms", "deprecated": false, "key": "duration_ms", "docstring": "The command duration in milliseconds.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) exit_code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/exit_code", "deprecated": false, "key": "exit_code", "docstring": "The process exit code, if the command completed.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64" }, "optional": false, "nullable": true, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) output": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/output", "deprecated": false, "key": "output", "docstring": "The command output, if available.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the command execution.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `command_execution`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/CommandExecutionItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "command_execution" } ] }, "default": "command_execution", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_command_execution_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/CommandExecutionItemResource", "docstring": "A command execution produced by the agent.", "ident": "AgentCommandExecutionItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "command" }, { "ident": "cwd" }, { "ident": "duration_ms" }, { "ident": "exit_code" }, { "ident": "output" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) command", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) cwd", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) duration_ms", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) exit_code", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) output", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/agent_id", "deprecated": false, "key": "agent_id", "docstring": "The ID of the agent that requested the subagent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The task given to the spawned agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) model": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/model", "deprecated": false, "key": "model", "docstring": "The model requested for the spawned agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) reasoning_effort": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/reasoning_effort", "deprecated": false, "key": "reasoning_effort", "docstring": "The reasoning effort requested for the spawned agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `create_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/CreateSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "create_subagent_call" } ] }, "default": "create_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/CreateSubagentCallItemResource", "docstring": "A request to spawn a subagent.", "ident": "AgentCreateSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "agent_id" }, { "ident": "content" }, { "ident": "model" }, { "ident": "reasoning_effort" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) agent_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) model", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) reasoning_effort", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/content", "deprecated": false, "key": "content", "docstring": "The input sent to the receiving agent.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/content", "elementType": { "kind": "HttpTypeReference", "ident": "AgentContent", "$ref": "(resource) beta.agents > (model) agent_content > (schema)" } }, "optional": false, "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent receiving the input.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent sending the input.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `send_subagent_input_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "send_subagent_input_call" } ] }, "default": "send_subagent_input_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SendSubagentInputCallItemResource", "docstring": "A request to send input to another agent.", "ident": "AgentSendSubagentInputCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "content" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) content", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent to resume.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent requesting the resume.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `resume_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "resume_subagent_call" } ] }, "default": "resume_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ResumeSubagentCallItemResource", "docstring": "A request to resume a subagent.", "ident": "AgentResumeSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) recipient_agent_ids": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/recipient_agent_ids", "deprecated": false, "key": "recipient_agent_ids", "docstring": "The IDs of the agents to wait for.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/recipient_agent_ids", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": false, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent waiting for results.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `wait_for_subagents_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "wait_for_subagents_call" } ] }, "default": "wait_for_subagents_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WaitForSubagentsCallItemResource", "docstring": "A request to wait for one or more subagents.", "ident": "AgentWaitForSubagentsCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_ids" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) recipient_agent_ids", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent to interrupt.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent requesting the interrupt.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `interrupt_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "interrupt_subagent_call" } ] }, "default": "interrupt_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InterruptSubagentCallItemResource", "docstring": "A request to interrupt a subagent's current turn. The subagent remains available.", "ident": "AgentInterruptSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/id", "deprecated": false, "key": "id", "docstring": "The ID of the tool call item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) recipient_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/recipient_agent_id", "deprecated": false, "key": "recipient_agent_id", "docstring": "The ID of the agent to close.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) sender_agent_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/sender_agent_id", "deprecated": false, "key": "sender_agent_id", "docstring": "The ID of the agent requesting the close.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/status", "deprecated": false, "key": "status", "docstring": "The status of the tool call.", "type": { "kind": "HttpTypeReference", "ident": "AgentFunctionCallStatus", "$ref": "(resource) beta.agents > (model) agent_function_call_status > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "enum", "modelPath": "(resource) beta.agents > (model) agent_function_call_status", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn that contains this item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/type", "deprecated": false, "key": "type", "docstring": "The item type. Always `close_subagent_call`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/CloseSubagentCallItemResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "close_subagent_call" } ] }, "default": "close_subagent_call", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/CloseSubagentCallItemResource", "docstring": "A request to close a subagent.", "ident": "AgentCloseSubagentCallItem", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "id" }, { "ident": "recipient_agent_id" }, { "ident": "sender_agent_id" }, { "ident": "status" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) recipient_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) sender_agent_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) status", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase > (member) 0": { "kind": "HttpDeclReference", "docstring": "Commentary produced while the agent works.", "type": { "kind": "HttpTypeLiteral", "literal": "commentary" } }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) phase > (member) 1": { "kind": "HttpDeclReference", "docstring": "The agent's final answer.", "type": { "kind": "HttpTypeLiteral", "literal": "final_answer" } }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) role > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "assistant" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0": { "kind": "HttpDeclReference", "docstring": "The item is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1": { "kind": "HttpDeclReference", "docstring": "The item is complete.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2": { "kind": "HttpDeclReference", "docstring": "The item stopped before completing.", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, "(resource) beta.agents > (model) agent_output_item_status > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputItemStatusResource", "docstring": "The status of an agent output item.", "ident": "AgentOutputItemStatus", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputItemStatusResource", "types": [ { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "incomplete" } ] }, "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_output_item_status > (schema) > (member) 2" ] }, "(resource) beta.agents > (model) agent_session_assistant_message > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "message" } }, "(resource) beta.agents > (model) summary_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The reasoning summary text.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `summary_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "summary_text" } ] }, "default": "summary_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SummaryTextResource", "docstring": "A reasoning summary content part.", "ident": "SummaryText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_reasoning_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "reasoning" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0": { "kind": "HttpDeclReference", "docstring": "The call is in progress.", "type": { "kind": "HttpTypeLiteral", "literal": "in_progress" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1": { "kind": "HttpDeclReference", "docstring": "The call completed successfully.", "type": { "kind": "HttpTypeLiteral", "literal": "completed" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2": { "kind": "HttpDeclReference", "docstring": "The call failed.", "type": { "kind": "HttpTypeLiteral", "literal": "failed" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3": { "kind": "HttpDeclReference", "docstring": "The call stopped before completing.", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, "(resource) beta.agents > (model) agent_function_call_status > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/FunctionCallStatusResource", "docstring": "The status of a tool call.", "ident": "AgentFunctionCallStatus", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/FunctionCallStatusResource", "types": [ { "kind": "HttpTypeLiteral", "literal": "in_progress" }, { "kind": "HttpTypeLiteral", "literal": "completed" }, { "kind": "HttpTypeLiteral", "literal": "failed" }, { "kind": "HttpTypeLiteral", "literal": "incomplete" } ] }, "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 0", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 1", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 2", "(resource) beta.agents > (model) agent_function_call_status > (schema) > (member) 3" ] }, "(resource) beta.agents > (model) agent_function_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "function_call" } }, "(resource) beta.agents > (model) agent_mcp_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp_call" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/0", "docstring": "A search query or group of search queries.", "ident": "Search", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "queries" }, { "ident": "query" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) queries", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) query", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/1", "docstring": "Opens a web page.", "ident": "OpenPage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" }, { "ident": "url" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) url" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/2", "docstring": "Finds text within a web page.", "ident": "FindInPage", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "pattern" }, { "ident": "type" }, { "ident": "url" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) pattern", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) url" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource/oneOf/3", "docstring": "Another web search action.", "ident": "Other", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type" ] }, "(resource) beta.agents > (model) web_search_action > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/WebSearchActionResource", "docstring": "An action performed by the web search tool.", "ident": "WebSearchAction", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResource", "types": [ { "kind": "HttpTypeObject", "members": [ { "ident": "queries" }, { "ident": "query" }, { "ident": "type" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "type" }, { "ident": "url" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "pattern" }, { "ident": "type" }, { "ident": "url" } ] }, { "kind": "HttpTypeObject", "members": [ { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2", "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3" ] }, "(resource) beta.agents > (model) agent_web_search_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "web_search_call" } }, "(resource) beta.agents > (model) agent_command_execution_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "command_execution" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource/oneOf/1", "docstring": "Encrypted content exchanged between agents.", "ident": "EncryptedContent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type" ] }, "(resource) beta.agents > (model) agent_content > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AgentContentResource", "docstring": "A plaintext or encrypted content part exchanged between agents.", "ident": "AgentContent", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/AgentContentResource", "types": [ { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, { "kind": "HttpTypeObject", "members": [ { "ident": "encrypted_content" }, { "ident": "type" } ] } ] }, "childrenParentSchema": "union", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 0", "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1" ] }, "(resource) beta.agents > (model) agent_create_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "create_subagent_call" } }, "(resource) beta.agents > (model) agent_send_subagent_input_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "send_subagent_input_call" } }, "(resource) beta.agents > (model) agent_resume_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "resume_subagent_call" } }, "(resource) beta.agents > (model) agent_wait_for_subagents_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "wait_for_subagents_call" } }, "(resource) beta.agents > (model) agent_interrupt_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "interrupt_subagent_call" } }, "(resource) beta.agents > (model) agent_close_subagent_call_item > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "docstring": "The current public item type.", "type": { "kind": "HttpTypeLiteral", "literal": "close_subagent_call" } }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "summary_text" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) queries": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/queries", "deprecated": false, "key": "queries", "docstring": "The search queries, when multiple queries were used.", "type": { "kind": "HttpTypeArray", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/queries", "elementType": { "kind": "HttpTypeString" } }, "optional": false, "nullable": true, "schemaType": "array", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) query": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/query", "deprecated": false, "key": "query", "docstring": "The search query, when a single query was used.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `search`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceSearch/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "search" } ] }, "default": "search", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceOpenPage/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `open_page`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceOpenPage/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "open_page" } ] }, "default": "open_page", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceOpenPage/properties/url", "deprecated": false, "key": "url", "docstring": "The URL of the page that was opened.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) pattern": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/pattern", "deprecated": false, "key": "pattern", "docstring": "The text pattern that was searched for.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `find_in_page`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "find_in_page" } ] }, "default": "find_in_page", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) url": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceFindInPage/properties/url", "deprecated": false, "key": "url", "docstring": "The URL of the page that was searched.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/WebSearchActionResourceOther/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `other`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/WebSearchActionResourceOther/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "other" } ] }, "default": "other", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) encrypted_content": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/encrypted_content", "deprecated": false, "key": "encrypted_content", "docstring": "The encrypted content payload.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `encrypted_content`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/EncryptedContentResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } ] }, "default": "encrypted_content", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "search" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "open_page" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 2 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "find_in_page" } }, "(resource) beta.agents > (model) web_search_action > (schema) > (variant) 3 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "other" } }, "(resource) beta.agents > (model) agent_content > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "encrypted_content" } } } ``` ### Example ```json { "type": "agent.session.turn.item.done", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "output_index": 0, "item": { "type": "message", "id": "id", "turn_id": "turn_id", "role": "assistant", "status": "in_progress", "content": [ { "type": "output_text", "text": "text" } ], "phase": "commentary" } } ``` ## agent.session.turn.content_part.added Emitted when an output text content part is added. ### Schema Schema name: `SessionEventAgentSessionTurnContentPartAdded` ```json { "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded", "docstring": "Emitted when an output text content part is added.", "ident": "AgentSessionTurnContentPartAddedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "content_index" }, { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "part" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) content_index", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) part", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/content_index", "deprecated": false, "key": "content_index", "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the message item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) part": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/part", "deprecated": false, "key": "part", "docstring": "The initial content part.", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) output_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.content_part.added`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartAdded/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.content_part.added" } ] }, "default": "agent.session.turn.content_part.added", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_content_part_added_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.content_part.added" } }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } } } ``` ### Example ```json { "type": "agent.session.turn.content_part.added", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "content_index": 0, "part": { "type": "output_text", "text": "text" } } ``` ## agent.session.turn.content_part.done Emitted when an output content part is complete. ### Schema Schema name: `SessionEventAgentSessionTurnContentPartDone` ```json { "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone", "docstring": "Emitted when an output content part is complete.", "ident": "AgentSessionTurnContentPartDoneEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "content_index" }, { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "part" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) content_index", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) part", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/content_index", "deprecated": false, "key": "content_index", "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the message item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) part": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/part", "deprecated": false, "key": "part", "docstring": "The completed content part.", "type": { "kind": "HttpTypeReference", "ident": "OutputText", "$ref": "(resource) beta.agents > (model) output_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) output_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.content_part.done`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnContentPartDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.content_part.done" } ] }, "default": "agent.session.turn.content_part.done", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The text produced by the agent.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) output_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `output_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/OutputTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_text" } ] }, "default": "output_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) output_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/OutputTextResource", "docstring": "A text content part produced by the agent.", "ident": "OutputText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) output_text > (schema) > (property) text", "(resource) beta.agents > (model) output_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_content_part_done_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.content_part.done" } }, "(resource) beta.agents > (model) output_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "output_text" } } } ``` ### Example ```json { "type": "agent.session.turn.content_part.done", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "content_index": 0, "part": { "type": "output_text", "text": "text" } } ``` ## agent.session.turn.output_text.delta Emitted when text is appended to an output text content part. ### Schema Schema name: `SessionEventAgentSessionTurnOutputTextDelta` ```json { "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta", "docstring": "Emitted when text is appended to an output text content part.", "ident": "AgentSessionTurnOutputTextDeltaEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "content_index" }, { "ident": "delta" }, { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) content_index", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) delta", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/content_index", "deprecated": false, "key": "content_index", "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/delta", "deprecated": false, "key": "delta", "docstring": "The text that was appended.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the message item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.output_text.delta`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.output_text.delta" } ] }, "default": "agent.session.turn.output_text.delta", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_output_text_delta_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.output_text.delta" } } } ``` ### Example ```json { "type": "agent.session.turn.output_text.delta", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "content_index": 0, "delta": "delta" } ``` ## agent.session.turn.output_text.done Emitted when an output text content part is complete. ### Schema Schema name: `SessionEventAgentSessionTurnOutputTextDone` ```json { "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone", "docstring": "Emitted when an output text content part is complete.", "ident": "AgentSessionTurnOutputTextDoneEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "content_index" }, { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "text" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) content_index", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) text", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/content_index", "deprecated": false, "key": "content_index", "docstring": "The index of the content part in the message.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the message item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/text", "deprecated": false, "key": "text", "docstring": "The complete output text.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.output_text.done`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnOutputTextDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.output_text.done" } ] }, "default": "agent.session.turn.output_text.done", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_output_text_done_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.output_text.done" } } } ``` ### Example ```json { "type": "agent.session.turn.output_text.done", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "content_index": 0, "text": "text" } ``` ## agent.session.turn.reasoning_summary_part.added Emitted when a reasoning summary content part is added. ### Schema Schema name: `SessionEventAgentSessionTurnReasoningSummaryPartAdded` ```json { "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded", "docstring": "Emitted when a reasoning summary content part is added.", "ident": "AgentSessionTurnReasoningSummaryPartAddedEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "part" }, { "ident": "session_id" }, { "ident": "summary_index" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) part", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) summary_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the reasoning item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) part": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/part", "deprecated": false, "key": "part", "docstring": "The initial summary part.", "type": { "kind": "HttpTypeReference", "ident": "SummaryText", "$ref": "(resource) beta.agents > (model) summary_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) summary_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) summary_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/summary_index", "deprecated": false, "key": "summary_index", "docstring": "The index of the summary content part.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.reasoning_summary_part.added`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartAdded/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_part.added" } ] }, "default": "agent.session.turn.reasoning_summary_part.added", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The reasoning summary text.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `summary_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "summary_text" } ] }, "default": "summary_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SummaryTextResource", "docstring": "A reasoning summary content part.", "ident": "SummaryText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_added_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_part.added" } }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "summary_text" } } } ``` ### Example ```json { "type": "agent.session.turn.reasoning_summary_part.added", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "summary_index": 0, "part": { "type": "summary_text", "text": "text" } } ``` ## agent.session.turn.reasoning_summary_part.done Emitted when a reasoning summary part is complete. ### Schema Schema name: `SessionEventAgentSessionTurnReasoningSummaryPartDone` ```json { "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone", "docstring": "Emitted when a reasoning summary part is complete.", "ident": "AgentSessionTurnReasoningSummaryPartDoneEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "part" }, { "ident": "session_id" }, { "ident": "status" }, { "ident": "summary_index" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) part", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) status", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) summary_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the reasoning item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) part": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/part", "deprecated": false, "key": "part", "docstring": "The completed summary part.", "type": { "kind": "HttpTypeReference", "ident": "SummaryText", "$ref": "(resource) beta.agents > (model) summary_text > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) summary_text", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) status": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/status", "deprecated": false, "key": "status", "docstring": "Present as `incomplete` when summary generation was interrupted.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/status", "types": [ { "kind": "HttpTypeLiteral", "literal": "incomplete" } ] }, "optional": false, "nullable": true, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) status > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) summary_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/summary_index", "deprecated": false, "key": "summary_index", "docstring": "The index of the summary part.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.reasoning_summary_part.done`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryPartDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_part.done" } ] }, "default": "agent.session.turn.reasoning_summary_part.done", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/text", "deprecated": false, "key": "text", "docstring": "The reasoning summary text.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "deprecated": false, "key": "type", "docstring": "The content type. Always `summary_text`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SummaryTextResource/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "summary_text" } ] }, "default": "summary_text", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) summary_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SummaryTextResource", "docstring": "A reasoning summary content part.", "ident": "SummaryText", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "text" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) summary_text > (schema) > (property) text", "(resource) beta.agents > (model) summary_text > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) status > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "incomplete" } }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_part_done_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_part.done" } }, "(resource) beta.agents > (model) summary_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "summary_text" } } } ``` ### Example ```json { "type": "agent.session.turn.reasoning_summary_part.done", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "summary_index": 0, "part": { "type": "summary_text", "text": "text" }, "status": "incomplete" } ``` ## agent.session.turn.reasoning_summary_text.delta Emitted when text is appended to a reasoning summary. ### Schema Schema name: `SessionEventAgentSessionTurnReasoningSummaryTextDelta` ```json { "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta", "docstring": "Emitted when text is appended to a reasoning summary.", "ident": "AgentSessionTurnReasoningSummaryTextDeltaEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "delta" }, { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "summary_index" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) delta", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) summary_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/delta", "deprecated": false, "key": "delta", "docstring": "The summary text that was appended.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the reasoning item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) summary_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/summary_index", "deprecated": false, "key": "summary_index", "docstring": "The index of the summary content part.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.reasoning_summary_text.delta`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_text.delta" } ] }, "default": "agent.session.turn.reasoning_summary_text.delta", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_delta_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_text.delta" } } } ``` ### Example ```json { "type": "agent.session.turn.reasoning_summary_text.delta", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "summary_index": 0, "delta": "delta" } ``` ## agent.session.turn.reasoning_summary_text.done Emitted when a reasoning summary content part is complete. ### Schema Schema name: `SessionEventAgentSessionTurnReasoningSummaryTextDone` ```json { "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone", "docstring": "Emitted when a reasoning summary content part is complete.", "ident": "AgentSessionTurnReasoningSummaryTextDoneEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "event_id" }, { "ident": "item_id" }, { "ident": "output_index" }, { "ident": "session_id" }, { "ident": "summary_index" }, { "ident": "text" }, { "ident": "turn_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) item_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) output_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) summary_index", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) text", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) turn_id", "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/item_id", "deprecated": false, "key": "item_id", "docstring": "The ID of the reasoning item.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/output_index", "deprecated": false, "key": "output_index", "docstring": "The index of the item in the turn output.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) summary_index": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/summary_index", "deprecated": false, "key": "summary_index", "docstring": "The index of the summary content part.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "int64", "minimum": 0, "maximum": 4294967295 }, "optional": false, "nullable": false, "schemaType": "integer", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) text": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/text", "deprecated": false, "key": "text", "docstring": "The complete reasoning summary text.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) turn_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/turn_id", "deprecated": false, "key": "turn_id", "docstring": "The ID of the turn associated with the event, when applicable.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `agent.session.turn.reasoning_summary_text.done`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventAgentSessionTurnReasoningSummaryTextDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_text.done" } ] }, "default": "agent.session.turn.reasoning_summary_text.done", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) agent_session_turn_reasoning_summary_text_done_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "agent.session.turn.reasoning_summary_text.done" } } } ``` ### Example ```json { "type": "agent.session.turn.reasoning_summary_text.done", "event_id": "event_id", "session_id": "session_id", "turn_id": "turn_id", "item_id": "item_id", "output_index": 0, "summary_index": 0, "text": "text" } ``` ## error Emitted when a turn or session fails. ### Schema Schema name: `SessionEventError` ```json { "(resource) beta.agents > (model) agent_session_error_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionEventError", "docstring": "Emitted when a turn or session fails.", "ident": "AgentSessionErrorEvent", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "error" }, { "ident": "event_id" }, { "ident": "session_id" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) error", "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) event_id", "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) session_id", "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) error": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventError/properties/error", "deprecated": false, "key": "error", "docstring": "The error that occurred.", "type": { "kind": "HttpTypeReference", "ident": "SessionError", "$ref": "(resource) beta.agents > (model) session_error > (schema)" }, "optional": false, "nullable": false, "modelImplicit": false, "schemaType": "object", "modelPath": "(resource) beta.agents > (model) session_error", "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_error > (schema) > (property) code", "(resource) beta.agents > (model) session_error > (schema) > (property) message", "(resource) beta.agents > (model) session_error > (schema) > (property) param", "(resource) beta.agents > (model) session_error > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventError/properties/event_id", "deprecated": false, "key": "event_id", "docstring": "The unique ID of the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) session_id": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventError/properties/session_id", "deprecated": false, "key": "session_id", "docstring": "The ID of the session associated with the event.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionEventError/properties/type", "deprecated": false, "key": "type", "docstring": "The type of the object. Always `error`.", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/SessionEventError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "error" } ] }, "default": "error", "optional": false, "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) type > (member) 0" ] }, "(resource) beta.agents > (model) session_error > (schema) > (property) code": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionErrorResource/properties/code", "deprecated": false, "key": "code", "docstring": "The machine-readable error code, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_error > (schema) > (property) message": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionErrorResource/properties/message", "deprecated": false, "key": "message", "docstring": "A customer-safe explanation of the error.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_error > (schema) > (property) param": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionErrorResource/properties/param", "deprecated": false, "key": "param", "docstring": "The request parameter associated with the error, if any.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": true, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_error > (schema) > (property) type": { "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/SessionErrorResource/properties/type", "deprecated": false, "key": "type", "docstring": "The error type.", "type": { "kind": "HttpTypeString" }, "constraints": { "minLength": 0 }, "optional": false, "nullable": false, "schemaType": "string", "children": [] }, "(resource) beta.agents > (model) session_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/SessionErrorResource", "docstring": "An error payload with the same public fields as Responses API streaming errors.", "ident": "SessionError", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "code" }, { "ident": "message" }, { "ident": "param" }, { "ident": "type" } ] }, "childrenParentSchema": "object", "children": [ "(resource) beta.agents > (model) session_error > (schema) > (property) code", "(resource) beta.agents > (model) session_error > (schema) > (property) message", "(resource) beta.agents > (model) session_error > (schema) > (property) param", "(resource) beta.agents > (model) session_error > (schema) > (property) type" ] }, "(resource) beta.agents > (model) agent_session_error_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "error" } } } ``` ### Example ```json { "type": "error", "event_id": "event_123", "session_id": "sess_123", "error": { "type": "server_error", "code": null, "message": "The session failed due to an internal server error.", "param": null } } ```