Codex SDK, with some useful tools for building AI applications.
pnpm install -g @openai/codex@0.150.1///|
#skip
async test {
let codex = @codex.Codex::new()
let thread = codex.start_thread()
let turn = thread.run("Hello, what model are you using?")
// I’m `GPT-5.2`, running inside the Codex CLI harness in your repo (`/Users/../codex-sdk`).
println(turn.final_response)
println(ToJson::to_json(turn.items).stringify())
println(ToJson::to_json(turn.usage).stringify())
}///|
#skip
async test {
let codex = @codex.Codex::new(
options=@codex.CodexOptions::new(base_url="https://openrouter.ai/api/v1"),
)
let thread = codex.start_thread(
options=@codex.ThreadOptions::new(model="anthropic/claude-sonnet-4.5"),
)
let turn = thread.run("Hello?")
println(turn.final_response)
println(ToJson::to_json(turn.items).stringify())
println(ToJson::to_json(turn.usage).stringify())
}///|
#skip
async test {
let codex = @codex.Codex::new(
options=@codex.CodexOptions::new(base_url="https://openrouter.ai/api/v1"),
)
let thread = codex.start_thread(
options=@codex.ThreadOptions::new(model="anthropic/claude-sonnet-4.5"),
)
@async.with_task_group(tg => {
let streamed_turn = thread.run_streamed("Hello?", tg)
while streamed_turn.events.next() is Some(event) {
println(event.to_json().stringify())
}
}) catch {
e => println(e)
}
}///|
#skip
async test {
let codex = @codex.Codex::new()
let thread = codex.start_thread()
@async.with_task_group(tg => {
let turn = thread.run_streamed("Summarize today's commits", tg)
while turn.events.next() is Some(event) {
match event {
ItemStarted(item) => println("started: \{item.to_json().stringify()}")
ItemCompleted(AgentMessageItem(text~, ..)) =>
println("assistant: \{text}")
TurnCompleted(usage) =>
println("tokens in/out: \{usage.input_tokens}/\{usage.output_tokens}")
TurnFailed(error) => fail("codex turn failed: \{error.message}")
_ => ()
}
}
})
}///|
#skip
async test {
let codex = @codex.Codex::new()
let thread = codex.start_thread()
let turn = thread.run(
"Plan the next refactor as JSON",
turn_options=@codex.TurnOptions::new(output_schema={
"type": "object",
"properties": {
"summary": { "type": "string" },
"files_to_touch": { "type": "array", "items": { "type": "string" } },
},
"required": ["summary", "files_to_touch"],
"additionalProperties": false, // required to be supplied as valid schema
}),
)
println(turn.final_response)
let plan_json = @json.parse(turn.final_response)
println(plan_json.stringify(indent=2))
}///|
#skip
async test {
@codex.Codex::new().with_app_server_session(async fn(session) {
let _ = session.plugin_list(@codex.AppPluginListParams::{
cwds: None,
marketplace_kinds: None,
})
let thread = session.start_thread()
let review_thread = session.start_thread()
let turn_input = [@codex.AppUserInput::AppInputText(text="hello")]
let turn = thread.run_streamed(turn_input, request_handler=fn(request) {
match request.details {
@codex.AppServerRequestDetails::AppCommandExecutionApprovalRequest(_) =>
@codex.AppServerResponse::AppCommandExecutionApprovalResponse(
decision=@codex.AppCommandExecutionApprovalDecision::AppCommandDecline,
)
@codex.AppServerRequestDetails::AppFileChangeApprovalRequest(_) =>
@codex.AppServerResponse::AppFileChangeApprovalResponse(
decision=@codex.AppFileChangeApprovalDecision::AppFileChangeDecline,
)
@codex.AppServerRequestDetails::AppToolRequestUserInputRequest(_) =>
@codex.AppServerResponse::AppToolRequestUserInputResponse(answers={})
@codex.AppServerRequestDetails::AppDynamicToolCallRequest(_) =>
@codex.AppServerResponse::AppDynamicToolCallResponse(
content_items=[
@codex.AppDynamicToolCallOutputContentItem::AppDynamicToolCallOutputText(
text="declined",
),
],
success=false,
)
@codex.AppServerRequestDetails::AppPermissionsRequestApprovalRequest(_) =>
@codex.AppServerResponse::AppPermissionsRequestApprovalResponse(
permissions=@codex.AppGrantedPermissionProfile::{
network: None,
file_system: None,
},
scope=@codex.AppPermissionGrantScope::AppPermissionGrantTurn,
strict_auto_review=None,
)
@codex.AppServerRequestDetails::AppChatgptAuthTokensRefreshRequest(_) =>
@codex.AppServerResponse::AppChatgptAuthTokensRefreshResponse(
access_token="",
chatgpt_account_id="",
chatgpt_plan_type=None,
)
@codex.AppServerRequestDetails::AppAttestationGenerateRequest(_) =>
@codex.AppServerResponse::AppAttestationGenerateResponse(token="")
@codex.AppServerRequestDetails::AppMcpServerElicitationRequest(_) =>
@codex.AppServerResponse::AppMcpServerElicitationResponse(
action=@codex.AppMcpServerElicitationAction::AppMcpElicitationDecline,
content=None,
meta=None,
)
@codex.AppServerRequestDetails::AppRawServerRequest(..) =>
@codex.AppServerResponse::AppRawServerResponse({})
}
})
let review_turn = review_thread.run_streamed([
@codex.AppUserInput::AppInputText(text="review this"),
])
while turn.next() is Some(event) {
match event.thread_event() {
Some(@codex.Event::ItemStarted(item)) =>
println(item.to_json().stringify())
_ => ()
}
}
review_turn.close()
while session.next_global_event() is Some(event) {
ignore(event)
}
})
}///|
#skip
async test {
@codex.Codex::new().with_app_server(async fn(connection) {
while connection.next_event() is Some(event) {
ignore(event)
}
})
}pub enum AppAccount {
AppAccountApiKey
AppAccountChatGPT(email~ : String, plan_type~ : AppPlanType)
AppAccountAmazonBedrock
} derive(Debug)impl FromJson for AppAccountLoginCancelResponsefn AppAccountLoginCancelResponse::from_json(value : Json, path : JsonPath) -> AppAccountLoginCancelResponse raise JsonDecodeErrorpub enum AppAccountLoginStartResponse {
AppAccountLoginApiKey
AppAccountLoginChatGPT(login_id~ : String, auth_url~ : String)
AppAccountLoginChatGPTDeviceCode(login_id~ : String, verification_url~ : String, user_code~ : String)
AppAccountLoginChatGPTAuthTokens
} derive(Debug)impl FromJson for AppAccountLoginStartResponsefn AppAccountLoginStartResponse::from_json(value : Json, path : JsonPath) -> AppAccountLoginStartResponse raise JsonDecodeErrorpub struct AppAccountRateLimitsReadResponse {
rate_limits : AppRateLimitSnapshot
rate_limits_by_limit_id : Map[String, AppRateLimitSnapshot]?
} derive(Debug)impl FromJson for AppAccountRateLimitsReadResponsefn from_json(value : Json, path : JsonPath) -> AppAccountRateLimitsReadResponse raise JsonDecodeErrorfn AppAccountRateLimitsReadResponse::from_json(value : Json, path : JsonPath) -> AppAccountRateLimitsReadResponse raise JsonDecodeErrorpub struct AppAccountReadResponse {
account : AppAccount?
requires_openai_auth : Bool
} derive(Debug)impl FromJson for AppAccountReadResponsefn AppAccountReadResponse::from_json(value : Json, path : JsonPath) -> AppAccountReadResponse raise JsonDecodeErrorpub struct AppAccountSendAddCreditsNudgeEmailResponse {
status : AppAddCreditsNudgeEmailStatus
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppAccountSendAddCreditsNudgeEmailResponse raise JsonDecodeErrorfn AppAccountSendAddCreditsNudgeEmailResponse::from_json(value : Json, path : JsonPath) -> AppAccountSendAddCreditsNudgeEmailResponse raise JsonDecodeErrorpub enum AppAddCreditsNudgeEmailStatus {
AppAddCreditsNudgeSent
AppAddCreditsNudgeCooldownActive
} derive(Debug)impl FromJson for AppAddCreditsNudgeEmailStatusfn AppAddCreditsNudgeEmailStatus::from_json(value : Json, path : JsonPath) -> AppAddCreditsNudgeEmailStatus raise JsonDecodeErrorimpl ToJson for AppAddCreditsNudgeKindpub(all) struct AppAdditionalFileSystemPermissions {
read : ArrayView[String]?
write : ArrayView[String]?
glob_scan_max_depth : UInt64?
entries : ArrayView[AppFileSystemSandboxEntry]?
} derive(Debug)impl ToJson for AppAdditionalFileSystemPermissionsfn from_json(value : Json, path : JsonPath) -> AppAdditionalFileSystemPermissions raise JsonDecodeErrorfn AppAdditionalFileSystemPermissions::from_json(value : Json, path : JsonPath) -> AppAdditionalFileSystemPermissions raise JsonDecodeErrorfn AppAdditionalFileSystemPermissions::to_json(permissions : AppAdditionalFileSystemPermissions) -> Jsonimpl ToJson for AppAdditionalNetworkPermissionsimpl FromJson for AppAdditionalNetworkPermissionsfn from_json(value : Json, path : JsonPath) -> AppAdditionalNetworkPermissions raise JsonDecodeErrorfn AppAdditionalNetworkPermissions::from_json(value : Json, path : JsonPath) -> AppAdditionalNetworkPermissions raise JsonDecodeErrorimpl FromJson for AppAnalyticsConfigfn AppAnalyticsConfig::from_json(value : Json, path : JsonPath) -> AppAnalyticsConfig raise JsonDecodeErrorpub(all) enum AppApprovalPolicy {
AppApprovalUntrusted
AppApprovalOnFailure
AppApprovalOnRequest
AppApprovalNever
AppApprovalGranular(sandbox_approval~ : Bool, rules~ : Bool, skill_approval~ : Bool, request_permissions~ : Bool, mcp_elicitations~ : Bool)
} derive(Debug)impl ToJson for AppApprovalPolicyimpl FromJson for AppApprovalPolicyfn AppApprovalPolicy::from_json(value : Json, path : JsonPath) -> AppApprovalPolicy raise JsonDecodeErrorpub(all) enum AppApprovalsReviewer {
AppReviewerUser
AppReviewerAutoReview
AppReviewerGuardianSubagent
} derive(Debug)impl ToJson for AppApprovalsReviewerimpl FromJson for AppApprovalsReviewerfn AppApprovalsReviewer::from_json(value : Json, path : JsonPath) -> AppApprovalsReviewer raise JsonDecodeErrorpub struct AppAppsConfig {
default_config : AppAppsDefaultConfig?
apps : Map[String, AppConnectorConfig]
} derive(Debug)pub struct AppAppsDefaultConfig {
enabled : Bool
destructive_enabled : Bool
open_world_enabled : Bool
} derive(Debug)impl FromJson for AppAppsDefaultConfigfn AppAppsDefaultConfig::from_json(value : Json, path : JsonPath) -> AppAppsDefaultConfig raise JsonDecodeErrorimpl FromJson for AppAttestationGenerateRequestfn AppAttestationGenerateRequest::from_json(value : Json, _path : JsonPath) -> AppAttestationGenerateRequest raise JsonDecodeErrorpub enum AppAuthMode {
AppAuthApiKey
AppAuthChatGPT
AppAuthChatGPTAuthTokens
AppAuthAgentIdentity
} derive(Debug)impl FromJson for AppAutoReviewDecisionSourcefn AppAutoReviewDecisionSource::from_json(value : Json, path : JsonPath) -> AppAutoReviewDecisionSource raise JsonDecodeErrorimpl ToJson for AppCancelLoginAccountParamsimpl FromJson for AppCancelLoginAccountStatusfn AppCancelLoginAccountStatus::from_json(value : Json, path : JsonPath) -> AppCancelLoginAccountStatus raise JsonDecodeErrorfn from_json(value : Json, path : JsonPath) -> AppChatgptAuthTokensRefreshReason raise JsonDecodeErrorfn AppChatgptAuthTokensRefreshReason::from_json(value : Json, path : JsonPath) -> AppChatgptAuthTokensRefreshReason raise JsonDecodeErrorpub(all) struct AppChatgptAuthTokensRefreshRequest {
reason : AppChatgptAuthTokensRefreshReason
previous_account_id : String?
// private fields
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppChatgptAuthTokensRefreshRequest raise JsonDecodeErrorfn AppChatgptAuthTokensRefreshRequest::from_json(value : Json, path : JsonPath) -> AppChatgptAuthTokensRefreshRequest raise JsonDecodeErrorpub enum AppCodexErrorInfo {
AppContextWindowExceeded
AppUsageLimitExceeded
AppServerOverloaded
AppCyberPolicy
AppHttpConnectionFailed(http_status_code~ : Int?)
AppResponseStreamConnectionFailed(http_status_code~ : Int?)
AppInternalServerError
AppUnauthorized
AppBadRequest
AppThreadRollbackFailed
AppSandboxError
AppResponseStreamDisconnected(http_status_code~ : Int?)
AppResponseTooManyFailedAttempts(http_status_code~ : Int?)
AppActiveTurnNotSteerable(turn_kind~ : AppNonSteerableTurnKind)
AppCodexOtherError
} derive(Debug)impl FromJson for AppCodexErrorInfofn AppCodexErrorInfo::from_json(value : Json, path : JsonPath) -> AppCodexErrorInfo raise JsonDecodeErrorpub(all) enum AppCollaborationModeKind {
AppCollaborationPlan
AppCollaborationDefault
} derive(Debug)impl FromJson for AppCollaborationModeKindfn AppCollaborationModeKind::from_json(value : Json, path : JsonPath) -> AppCollaborationModeKind raise JsonDecodeErrorpub(all) struct AppCollaborationModeListResponse {
data : ArrayView[AppCollaborationModeMask]
} derive(Debug)impl FromJson for AppCollaborationModeListResponsefn from_json(value : Json, path : JsonPath) -> AppCollaborationModeListResponse raise JsonDecodeErrorfn AppCollaborationModeListResponse::from_json(value : Json, path : JsonPath) -> AppCollaborationModeListResponse raise JsonDecodeErrorpub(all) struct AppCollaborationModeMask {
name : String
mode : AppCollaborationModeKind?
model : String?
reasoning_effort : AppReasoningEffort?
} derive(Debug)impl FromJson for AppCollaborationModeMaskfn AppCollaborationModeMask::from_json(value : Json, path : JsonPath) -> AppCollaborationModeMask raise JsonDecodeErrorpub enum AppCommandAction {
AppCommandReadAction(command~ : String, name~ : String, path~ : String)
AppCommandListFilesAction(command~ : String, path~ : String?)
AppCommandSearchAction(command~ : String, query~ : String?, path~ : String?)
AppCommandUnknownAction(command~ : String)
} derive(Debug)impl FromJson for AppCommandActionfn AppCommandAction::from_json(value : Json, path : JsonPath) -> AppCommandAction raise JsonDecodeErrorpub(all) struct AppCommandExecParams {
command : Array[String]
process_id : String?
tty : Bool?
stream_stdin : Bool?
stream_stdout_stderr : Bool?
output_bytes_cap : UInt64?
disable_output_cap : Bool?
disable_timeout : Bool?
timeout_ms : Int64?
cwd : String?
env : Map[String, String?]?
size : AppCommandExecTerminalSize?
sandbox_policy : AppSandboxPolicy?
} derive(Debug)impl ToJson for AppCommandExecProcessParamspub(all) struct AppCommandExecResizeParams {
process_id : String
size : AppCommandExecTerminalSize
} derive(Debug)impl ToJson for AppCommandExecResizeParamsimpl FromJson for AppCommandExecResponsefn AppCommandExecResponse::from_json(value : Json, path : JsonPath) -> AppCommandExecResponse raise JsonDecodeErrorimpl ToJson for AppCommandExecTerminalSizepub(all) struct AppCommandExecWriteParams {
process_id : String
delta_base64 : String?
close_stdin : Bool?
} derive(Debug)impl ToJson for AppCommandExecWriteParamspub(all) enum AppCommandExecutionApprovalDecision {
AppCommandAccept
AppCommandAcceptForSession
AppCommandDecline
AppCommandCancel
AppCommandAcceptWithExecpolicyAmendment(ArrayView[String])
AppCommandApplyNetworkPolicyAmendment(AppNetworkPolicyAmendment)
} derive(Debug)fn AppCommandExecutionApprovalDecision::to_json(decision : AppCommandExecutionApprovalDecision) -> Jsonpub(all) enum AppCommandExecutionApprovalKind {
AppCommandApprovalCommand
AppCommandApprovalWriteStdin
} derive(Debug)impl FromJson for AppCommandExecutionApprovalKindfn from_json(value : Json, path : JsonPath) -> AppCommandExecutionApprovalKind raise JsonDecodeErrorfn AppCommandExecutionApprovalKind::from_json(value : Json, path : JsonPath) -> AppCommandExecutionApprovalKind raise JsonDecodeErrorpub(all) struct AppCommandExecutionApprovalRequest {
kind : AppCommandExecutionApprovalKind
thread_id : String
turn_id : String
item_id : String
started_at_ms : Int64
approval_id : String?
environment_id : String?
reason : String?
network_approval_context : AppNetworkApprovalContext?
command : String?
cwd : String?
command_actions : ArrayView[AppCommandAction]?
proposed_execpolicy_amendment : ArrayView[String]?
proposed_network_policy_amendments : ArrayView[AppNetworkPolicyAmendment]?
// private fields
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppCommandExecutionApprovalRequest raise JsonDecodeErrorfn AppCommandExecutionApprovalRequest::from_json(value : Json, path : JsonPath) -> AppCommandExecutionApprovalRequest raise JsonDecodeErrorpub(all) struct AppConfigBatchWriteParams {
edits : Array[AppConfigEdit]
file_path : String?
expected_version : String?
reload_user_config : Bool?
} derive(Debug)impl ToJson for AppConfigBatchWriteParamspub struct AppConfigBatchWriteResponse {
status : AppConfigWriteStatus
version : String
file_path : String
overridden_metadata : AppConfigOverriddenMetadata?
} derive(Debug)impl FromJson for AppConfigBatchWriteResponsefn AppConfigBatchWriteResponse::from_json(value : Json, path : JsonPath) -> AppConfigBatchWriteResponse raise JsonDecodeErrorpub(all) struct AppConfigEdit {
key_path : String
value : Json
merge_strategy : AppMergeStrategy
} derive(Debug)impl ToJson for AppConfigEditpub struct AppConfigLayer {
name : AppConfigLayerSource
version : String
config : Json
disabled_reason : String?
} derive(Debug)impl FromJson for AppConfigLayerMetadatafn AppConfigLayerMetadata::from_json(value : Json, path : JsonPath) -> AppConfigLayerMetadata raise JsonDecodeErrorpub enum AppConfigLayerSource {
AppConfigLayerMdm(domain~ : String, key~ : String)
AppConfigLayerSystem(file~ : String)
AppConfigLayerUser(file~ : String)
AppConfigLayerProject(dot_codex_folder~ : String)
AppConfigLayerSessionFlags
AppConfigLayerLegacyManagedConfigTomlFromFile(file~ : String)
AppConfigLayerLegacyManagedConfigTomlFromMdm
} derive(Debug)impl FromJson for AppConfigLayerSourcefn AppConfigLayerSource::from_json(value : Json, path : JsonPath) -> AppConfigLayerSource raise JsonDecodeErrorpub struct AppConfigOverriddenMetadata {
message : String
overriding_layer : AppConfigLayerMetadata
effective_value : Json
} derive(Debug)impl FromJson for AppConfigOverriddenMetadatafn AppConfigOverriddenMetadata::from_json(value : Json, path : JsonPath) -> AppConfigOverriddenMetadata raise JsonDecodeErrorpub struct AppConfigReadResponse {
config : AppConfigSnapshot
origins : Map[String, AppConfigLayerMetadata]
layers : ArrayView[AppConfigLayer]?
} derive(Debug)impl FromJson for AppConfigReadResponsefn AppConfigReadResponse::from_json(value : Json, path : JsonPath) -> AppConfigReadResponse raise JsonDecodeErrorpub struct AppConfigRequirements {
allowed_approval_policies : ArrayView[AppApprovalPolicy]?
allowed_sandbox_modes : ArrayView[SandboxMode]?
allowed_web_search_modes : ArrayView[AppWebSearchMode]?
allow_managed_hooks_only : Bool?
feature_requirements : Map[String, Bool]?
enforce_residency : AppResidencyRequirement?
} derive(Debug)impl FromJson for AppConfigRequirementsfn AppConfigRequirements::from_json(value : Json, path : JsonPath) -> AppConfigRequirements raise JsonDecodeErrorfn from_json(value : Json, path : JsonPath) -> AppConfigRequirementsReadResponse raise JsonDecodeErrorfn AppConfigRequirementsReadResponse::from_json(value : Json, path : JsonPath) -> AppConfigRequirementsReadResponse raise JsonDecodeErrorpub struct AppConfigSnapshot {
model : String?
review_model : String?
model_context_window : Int64?
model_auto_compact_token_limit : Int64?
model_provider : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
sandbox_mode : SandboxMode?
sandbox_workspace_write : AppSandboxWorkspaceWrite?
forced_chatgpt_workspace_id : String?
forced_login_method : AppForcedLoginMethod?
web_search : AppWebSearchMode?
tools : AppConfigToolsV2?
profile : String?
profiles : Map[String, AppProfileV2]
instructions : String?
developer_instructions : String?
compact_prompt : String?
model_reasoning_effort : AppReasoningEffort?
model_reasoning_summary : AppReasoningSummary?
model_verbosity : AppModelVerbosity?
service_tier : String?
analytics : AppAnalyticsConfig?
apps : AppAppsConfig?
additional : Map[String, Json]
// private fields
} derive(Debug)impl ToJson for AppConfigSnapshotimpl FromJson for AppConfigSnapshotfn AppConfigSnapshot::from_json(value : Json, path : JsonPath) -> AppConfigSnapshot raise JsonDecodeErrorpub struct AppConfigToolsV2 {
web_search : AppWebSearchToolConfig?
view_image : Bool?
} derive(Debug)impl FromJson for AppConfigToolsV2fn AppConfigToolsV2::from_json(value : Json, path : JsonPath) -> AppConfigToolsV2 raise JsonDecodeErrorpub(all) struct AppConfigValueWriteParams {
key_path : String
value : Json
merge_strategy : AppMergeStrategy
file_path : String?
expected_version : String?
} derive(Debug)impl ToJson for AppConfigValueWriteParamspub struct AppConfigValueWriteResponse {
status : AppConfigWriteStatus
version : String
file_path : String
overridden_metadata : AppConfigOverriddenMetadata?
} derive(Debug)impl FromJson for AppConfigValueWriteResponsefn AppConfigValueWriteResponse::from_json(value : Json, path : JsonPath) -> AppConfigValueWriteResponse raise JsonDecodeErrorimpl FromJson for AppConfigWriteStatusfn AppConfigWriteStatus::from_json(value : Json, path : JsonPath) -> AppConfigWriteStatus raise JsonDecodeErrorpub struct AppConnectorConfig {
enabled : Bool
destructive_enabled : Bool?
open_world_enabled : Bool?
default_tools_approval_mode : AppToolApproval?
default_tools_enabled : Bool?
tools : AppToolsConfig?
} derive(Debug)impl FromJson for AppConnectorConfigfn AppConnectorConfig::from_json(value : Json, path : JsonPath) -> AppConnectorConfig raise JsonDecodeErrorpub struct AppConversationGitInfo {
sha : String?
branch : String?
origin_url : String?
} derive(Debug)impl FromJson for AppConversationGitInfofn AppConversationGitInfo::from_json(value : Json, path : JsonPath) -> AppConversationGitInfo raise JsonDecodeErrorpub struct AppCreditsSnapshot {
has_credits : Bool
unlimited : Bool
balance : String?
} derive(Debug)impl FromJson for AppCreditsSnapshotfn AppCreditsSnapshot::from_json(value : Json, path : JsonPath) -> AppCreditsSnapshot raise JsonDecodeErrorpub(all) enum AppDynamicToolCallOutputContentItem {
AppDynamicToolCallOutputText(text~ : String)
AppDynamicToolCallOutputImage(image_url~ : String)
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppDynamicToolCallOutputContentItem raise JsonDecodeErrorfn AppDynamicToolCallOutputContentItem::from_json(value : Json, path : JsonPath) -> AppDynamicToolCallOutputContentItem raise JsonDecodeErrorimpl FromJson for AppDynamicToolCallRequestfn AppDynamicToolCallRequest::from_json(value : Json, path : JsonPath) -> AppDynamicToolCallRequest raise JsonDecodeErrorpub struct AppExperimentalFeature {
name : String
stage : AppExperimentalFeatureStage
display_name : String?
description : String?
announcement : String?
enabled : Bool
default_enabled : Bool
} derive(Debug)impl FromJson for AppExperimentalFeaturefn AppExperimentalFeature::from_json(value : Json, path : JsonPath) -> AppExperimentalFeature raise JsonDecodeErrorfn AppExperimentalFeatureEnablementSetParams::to_json(params : AppExperimentalFeatureEnablementSetParams) -> Jsonfn from_json(value : Json, path : JsonPath) -> AppExperimentalFeatureEnablementSetResponse raise JsonDecodeErrorfn AppExperimentalFeatureEnablementSetResponse::from_json(value : Json, path : JsonPath) -> AppExperimentalFeatureEnablementSetResponse raise JsonDecodeErrorpub struct AppExperimentalFeatureListResponse {
data : ArrayView[AppExperimentalFeature]
next_cursor : String?
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppExperimentalFeatureListResponse raise JsonDecodeErrorfn AppExperimentalFeatureListResponse::from_json(value : Json, path : JsonPath) -> AppExperimentalFeatureListResponse raise JsonDecodeErrorpub enum AppExperimentalFeatureStage {
AppFeatureBeta
AppFeatureUnderDevelopment
AppFeatureStable
AppFeatureDeprecated
AppFeatureRemoved
} derive(Debug)impl FromJson for AppExperimentalFeatureStagefn AppExperimentalFeatureStage::from_json(value : Json, path : JsonPath) -> AppExperimentalFeatureStage raise JsonDecodeErrorimpl ToJson for AppExternalAgentConfigDetectParamspub struct AppExternalAgentConfigDetectResponse {
items : ArrayView[AppExternalAgentConfigMigrationItem]
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppExternalAgentConfigDetectResponse raise JsonDecodeErrorfn AppExternalAgentConfigDetectResponse::from_json(value : Json, path : JsonPath) -> AppExternalAgentConfigDetectResponse raise JsonDecodeErrorpub(all) struct AppExternalAgentConfigImportParams {
migration_items : Array[AppExternalAgentConfigMigrationItem]
} derive(Debug)impl ToJson for AppExternalAgentConfigImportParamspub(all) struct AppExternalAgentConfigMigrationItem {
item_type : AppExternalAgentConfigMigrationItemType
description : String
cwd : String?
details : AppMigrationDetails?
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppExternalAgentConfigMigrationItem raise JsonDecodeErrorfn AppExternalAgentConfigMigrationItem::from_json(value : Json, path : JsonPath) -> AppExternalAgentConfigMigrationItem raise JsonDecodeErrorpub(all) enum AppExternalAgentConfigMigrationItemType {
AppMigrationAgentsMd
AppMigrationConfig
AppMigrationSkills
AppMigrationPlugins
AppMigrationMcpServerConfig
AppMigrationSubagents
AppMigrationHooks
AppMigrationCommands
AppMigrationSessions
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppExternalAgentConfigMigrationItemType raise JsonDecodeErrorfn AppExternalAgentConfigMigrationItemType::from_json(value : Json, path : JsonPath) -> AppExternalAgentConfigMigrationItemType raise JsonDecodeErrorfn AppExternalAgentConfigMigrationItemType::to_json(item_type : AppExternalAgentConfigMigrationItemType) -> Jsonimpl ToJson for AppFeedbackUploadParamsimpl FromJson for AppFeedbackUploadResponsefn AppFeedbackUploadResponse::from_json(value : Json, path : JsonPath) -> AppFeedbackUploadResponse raise JsonDecodeErrorpub(all) enum AppFileChangeApprovalDecision {
AppFileChangeAccept
AppFileChangeAcceptForSession
AppFileChangeDecline
AppFileChangeCancel
} derive(Debug)impl ToJson for AppFileChangeApprovalDecisionpub(all) struct AppFileChangeApprovalRequest {
thread_id : String
turn_id : String
item_id : String
started_at_ms : Int64
reason : String?
grant_root : String?
// private fields
} derive(Debug)impl FromJson for AppFileChangeApprovalRequestfn AppFileChangeApprovalRequest::from_json(value : Json, path : JsonPath) -> AppFileChangeApprovalRequest raise JsonDecodeErrorpub(all) enum AppFileSystemAccessMode {
AppFileSystemReadAccess
AppFileSystemWriteAccess
AppFileSystemNoAccess
} derive(Debug)impl ToJson for AppFileSystemAccessModeimpl FromJson for AppFileSystemAccessModefn AppFileSystemAccessMode::from_json(value : Json, path : JsonPath) -> AppFileSystemAccessMode raise JsonDecodeErrorpub(all) enum AppFileSystemPath {
AppFileSystemAbsolutePath(path~ : String)
AppFileSystemGlobPattern(pattern~ : String)
AppFileSystemSpecialPath(value~ : AppFileSystemSpecialPath)
} derive(Debug)impl ToJson for AppFileSystemPathimpl FromJson for AppFileSystemPathfn AppFileSystemPath::from_json(value : Json, path : JsonPath) -> AppFileSystemPath raise JsonDecodeErrorpub(all) struct AppFileSystemSandboxEntry {
path : AppFileSystemPath
access : AppFileSystemAccessMode
} derive(Debug)impl ToJson for AppFileSystemSandboxEntryimpl FromJson for AppFileSystemSandboxEntryfn AppFileSystemSandboxEntry::from_json(value : Json, path : JsonPath) -> AppFileSystemSandboxEntry raise JsonDecodeErrorpub(all) enum AppFileSystemSpecialPath {
AppFileSystemRoot
AppFileSystemMinimal
AppFileSystemProjectRoots(subpath~ : String?)
AppFileSystemTmpdir
AppFileSystemSlashTmp
AppFileSystemUnknown(path~ : String, subpath~ : String?)
} derive(Debug)impl ToJson for AppFileSystemSpecialPathimpl FromJson for AppFileSystemSpecialPathfn AppFileSystemSpecialPath::from_json(value : Json, path : JsonPath) -> AppFileSystemSpecialPath raise JsonDecodeErrorimpl FromJson for AppForcedLoginMethodfn AppForcedLoginMethod::from_json(value : Json, path : JsonPath) -> AppForcedLoginMethod raise JsonDecodeErrorpub(all) struct AppFsCopyParams {
source_path : String
destination_path : String
recursive : Bool?
} derive(Debug)impl ToJson for AppFsCopyParamsimpl ToJson for AppFsCreateDirectoryParamspub struct AppFsGetMetadataResponse {
is_directory : Bool
is_file : Bool
is_symlink : Bool
created_at_ms : Int64
modified_at_ms : Int64
} derive(Debug)impl FromJson for AppFsGetMetadataResponsefn AppFsGetMetadataResponse::from_json(value : Json, path : JsonPath) -> AppFsGetMetadataResponse raise JsonDecodeErrorpub struct AppFsReadDirectoryEntry {
file_name : String
is_directory : Bool
is_file : Bool
} derive(Debug)impl FromJson for AppFsReadDirectoryEntryfn AppFsReadDirectoryEntry::from_json(value : Json, path : JsonPath) -> AppFsReadDirectoryEntry raise JsonDecodeErrorimpl FromJson for AppFsReadDirectoryResponsefn AppFsReadDirectoryResponse::from_json(value : Json, path : JsonPath) -> AppFsReadDirectoryResponse raise JsonDecodeErrorimpl FromJson for AppFsReadFileResponsefn AppFsReadFileResponse::from_json(value : Json, path : JsonPath) -> AppFsReadFileResponse raise JsonDecodeErrorimpl FromJson for AppFsWatchResponsefn AppFsWatchResponse::from_json(value : Json, path : JsonPath) -> AppFsWatchResponse raise JsonDecodeErrorimpl FromJson for AppFuzzyFileSearchMatchTypefn AppFuzzyFileSearchMatchType::from_json(value : Json, path : JsonPath) -> AppFuzzyFileSearchMatchType raise JsonDecodeErrorimpl ToJson for AppFuzzyFileSearchParamsimpl FromJson for AppFuzzyFileSearchResponsefn AppFuzzyFileSearchResponse::from_json(value : Json, path : JsonPath) -> AppFuzzyFileSearchResponse raise JsonDecodeErrorpub struct AppFuzzyFileSearchResult {
root : String
path : String
match_type : AppFuzzyFileSearchMatchType
file_name : String
score : UInt
indices : ArrayView[UInt]?
} derive(Debug)impl FromJson for AppFuzzyFileSearchResultfn AppFuzzyFileSearchResult::from_json(value : Json, path : JsonPath) -> AppFuzzyFileSearchResult raise JsonDecodeErrorfn AppFuzzyFileSearchSessionStartParams::to_json(params : AppFuzzyFileSearchSessionStartParams) -> Jsonfn AppFuzzyFileSearchSessionStopParams::to_json(params : AppFuzzyFileSearchSessionStopParams) -> Jsonpub(all) struct AppFuzzyFileSearchSessionUpdateParams {
session_id : String
query : String
} derive(Debug)fn AppFuzzyFileSearchSessionUpdateParams::to_json(params : AppFuzzyFileSearchSessionUpdateParams) -> Jsonpub(all) struct AppGrantedPermissionProfile {
network : AppAdditionalNetworkPermissions?
file_system : AppAdditionalFileSystemPermissions?
} derive(Debug)impl ToJson for AppGrantedPermissionProfileimpl FromJson for AppGrantedPermissionProfilefn AppGrantedPermissionProfile::from_json(value : Json, path : JsonPath) -> AppGrantedPermissionProfile raise JsonDecodeErrorpub(all) struct AppGuardianApprovalReview {
status : AppGuardianApprovalReviewStatus
risk_level : AppGuardianRiskLevel?
user_authorization : AppGuardianUserAuthorization?
rationale : String?
} derive(Debug)impl FromJson for AppGuardianApprovalReviewfn AppGuardianApprovalReview::from_json(value : Json, path : JsonPath) -> AppGuardianApprovalReview raise JsonDecodeErrorpub(all) enum AppGuardianApprovalReviewAction {
AppGuardianCommandAction(source~ : AppGuardianCommandSource, command~ : String, cwd~ : String)
AppGuardianExecveAction(source~ : AppGuardianCommandSource, program~ : String, argv~ : ArrayView[String], cwd~ : String)
AppGuardianApplyPatchAction(cwd~ : String, files~ : ArrayView[String])
AppGuardianNetworkAccessAction(target~ : String, host~ : String, protocol~ : AppNetworkApprovalProtocol, port~ : UInt)
AppGuardianMcpToolCallAction(server~ : String, tool_name~ : String, connector_id~ : String?, connector_name~ : String?, tool_title~ : String?)
AppGuardianRequestPermissionsAction(reason~ : String?, permissions~ : AppRequestPermissionProfile)
} derive(Debug)impl FromJson for AppGuardianApprovalReviewActionfn from_json(value : Json, path : JsonPath) -> AppGuardianApprovalReviewAction raise JsonDecodeErrorfn AppGuardianApprovalReviewAction::from_json(value : Json, path : JsonPath) -> AppGuardianApprovalReviewAction raise JsonDecodeErrorpub(all) enum AppGuardianApprovalReviewStatus {
AppGuardianReviewInProgress
AppGuardianReviewApproved
AppGuardianReviewDenied
AppGuardianReviewTimedOut
AppGuardianReviewAborted
} derive(Debug)impl FromJson for AppGuardianApprovalReviewStatusfn from_json(value : Json, path : JsonPath) -> AppGuardianApprovalReviewStatus raise JsonDecodeErrorfn AppGuardianApprovalReviewStatus::from_json(value : Json, path : JsonPath) -> AppGuardianApprovalReviewStatus raise JsonDecodeErrorpub(all) enum AppGuardianCommandSource {
AppGuardianCommandSourceShell
AppGuardianCommandSourceUnifiedExec
} derive(Debug)impl FromJson for AppGuardianCommandSourcefn AppGuardianCommandSource::from_json(value : Json, path : JsonPath) -> AppGuardianCommandSource raise JsonDecodeErrorpub(all) enum AppGuardianRiskLevel {
AppGuardianRiskLow
AppGuardianRiskMedium
AppGuardianRiskHigh
AppGuardianRiskCritical
} derive(Debug)impl FromJson for AppGuardianRiskLevelfn AppGuardianRiskLevel::from_json(value : Json, path : JsonPath) -> AppGuardianRiskLevel raise JsonDecodeErrorpub(all) enum AppGuardianUserAuthorization {
AppGuardianUserAuthorizationUnknown
AppGuardianUserAuthorizationLow
AppGuardianUserAuthorizationMedium
AppGuardianUserAuthorizationHigh
} derive(Debug)impl FromJson for AppGuardianUserAuthorizationfn AppGuardianUserAuthorization::from_json(value : Json, path : JsonPath) -> AppGuardianUserAuthorization raise JsonDecodeErrorimpl FromJson for AppHookErrorInfofn AppHookErrorInfo::from_json(value : Json, path : JsonPath) -> AppHookErrorInfo raise JsonDecodeErrorpub enum AppHookEventName {
AppHookPreToolUse
AppHookPermissionRequest
AppHookPostToolUse
AppHookPreCompact
AppHookPostCompact
AppHookSessionStart
AppHookUserPromptSubmit
AppHookStop
} derive(Debug)impl FromJson for AppHookEventNamefn AppHookEventName::from_json(value : Json, path : JsonPath) -> AppHookEventName raise JsonDecodeErrorimpl FromJson for AppHookExecutionModefn AppHookExecutionMode::from_json(value : Json, path : JsonPath) -> AppHookExecutionMode raise JsonDecodeErrorpub enum AppHookHandlerType {
AppHookCommandHandler
AppHookPromptHandler
AppHookAgentHandler
} derive(Debug)impl FromJson for AppHookHandlerTypefn AppHookHandlerType::from_json(value : Json, path : JsonPath) -> AppHookHandlerType raise JsonDecodeErrorpub struct AppHookMetadata {
key : String
event_name : AppHookEventName
handler_type : AppHookHandlerType
matcher : String?
command : String?
timeout_sec : UInt64
status_message : String?
source_path : String
source : AppHookSource
plugin_id : String?
display_order : Int64
enabled : Bool
is_managed : Bool
current_hash : String
trust_status : AppHookTrustStatus
// private fields
} derive(Debug)impl FromJson for AppHookMetadatafn AppHookMetadata::from_json(value : Json, path : JsonPath) -> AppHookMetadata raise JsonDecodeErrorimpl FromJson for AppHookOutputEntryfn AppHookOutputEntry::from_json(value : Json, path : JsonPath) -> AppHookOutputEntry raise JsonDecodeErrorpub(all) enum AppHookOutputEntryKind {
AppHookOutputWarning
AppHookOutputStop
AppHookOutputFeedback
AppHookOutputContext
AppHookOutputError
} derive(Debug)impl FromJson for AppHookOutputEntryKindfn AppHookOutputEntryKind::from_json(value : Json, path : JsonPath) -> AppHookOutputEntryKind raise JsonDecodeErrorimpl FromJson for AppHookPromptFragmentfn AppHookPromptFragment::from_json(value : Json, path : JsonPath) -> AppHookPromptFragment raise JsonDecodeErrorpub(all) enum AppHookRunStatus {
AppHookRunning
AppHookCompleted
AppHookFailed
AppHookBlocked
AppHookStopped
} derive(Debug)impl FromJson for AppHookRunStatusfn AppHookRunStatus::from_json(value : Json, path : JsonPath) -> AppHookRunStatus raise JsonDecodeErrorpub(all) struct AppHookRunSummary {
id : String
event_name : AppHookEventName
handler_type : AppHookHandlerType
execution_mode : AppHookExecutionMode
scope : AppHookScope
source_path : String
source : AppHookSource
display_order : Int64
status : AppHookRunStatus
status_message : String?
started_at : Int64
completed_at : Int64?
duration_ms : Int64?
entries : ArrayView[AppHookOutputEntry]
} derive(Debug)impl FromJson for AppHookRunSummaryfn AppHookRunSummary::from_json(value : Json, path : JsonPath) -> AppHookRunSummary raise JsonDecodeErrorpub enum AppHookSource {
AppHookSystemSource
AppHookUserSource
AppHookProjectSource
AppHookMdmSource
AppHookSessionFlagsSource
AppHookPluginSource
AppHookCloudRequirementsSource
AppHookLegacyManagedConfigFileSource
AppHookLegacyManagedConfigMdmSource
AppHookUnknownSource
} derive(Debug)pub enum AppHookTrustStatus {
AppHookManagedTrust
AppHookUntrusted
AppHookTrusted
AppHookModified
} derive(Debug)impl FromJson for AppHookTrustStatusfn AppHookTrustStatus::from_json(value : Json, path : JsonPath) -> AppHookTrustStatus raise JsonDecodeErrorpub struct AppHooksListEntry {
cwd : String
hooks : ArrayView[AppHookMetadata]
warnings : ArrayView[String]
errors : ArrayView[AppHookErrorInfo]
} derive(Debug)impl FromJson for AppHooksListEntryfn AppHooksListEntry::from_json(value : Json, path : JsonPath) -> AppHooksListEntry raise JsonDecodeErrorimpl FromJson for AppHooksListResponsefn AppHooksListResponse::from_json(value : Json, path : JsonPath) -> AppHooksListResponse raise JsonDecodeErrorpub(all) enum AppImageDetail {
AppImageAuto
AppImageLow
AppImageHigh
AppImageOriginal
} derive(Debug)impl ToJson for AppImageDetailimpl FromJson for AppImageDetailimpl ToJson for AppInitializeCapabilitiesfn AppInitializeCapabilities::new(experimental_api? : Bool, request_attestation? : Bool, mcp_server_openai_form_elicitation? : Bool, opt_out_notification_methods? : Array[String], extensions? : Map[String, Json]) -> AppInitializeCapabilitiespub(all) struct AppInitializeParams {
client_info : AppClientInfo
capabilities : AppInitializeCapabilities?
} derive(Debug)pub struct AppInitializeResponse {
user_agent : String
codex_home : String
platform_family : String
platform_os : String
} derive(Debug)impl FromJson for AppInitializeResponsefn AppInitializeResponse::from_json(value : Json, path : JsonPath) -> AppInitializeResponse raise JsonDecodeErrorimpl FromJson for AppInputModalityfn AppInputModality::from_json(value : Json, path : JsonPath) -> AppInputModality raise JsonDecodeErrorpub struct AppListParams {
cursor : String?
limit : UInt?
thread_id : String?
force_refetch : Bool?
} derive(Debug)impl ToJson for AppListParamsfn AppListParams::new(cursor? : String, limit? : UInt, thread_id? : String, force_refetch? : Bool) -> AppListParamsimpl FromJson for AppListResponsefn AppListResponse::from_json(value : Json, path : JsonPath) -> AppListResponse raise JsonDecodeErrorpub(all) enum AppLoginAccountParams {
AppLoginApiKey(api_key~ : String)
AppLoginChatGPT(codex_streamlined_login~ : Bool?)
AppLoginChatGPTDeviceCode
AppLoginChatGPTAuthTokens(access_token~ : String, chatgpt_account_id~ : String, chatgpt_plan_type~ : String?)
} derive(Debug)impl ToJson for AppMarketplaceAddParamspub struct AppMarketplaceAddResponse {
marketplace_name : String
installed_root : String
already_added : Bool
} derive(Debug)impl FromJson for AppMarketplaceAddResponsefn AppMarketplaceAddResponse::from_json(value : Json, path : JsonPath) -> AppMarketplaceAddResponse raise JsonDecodeErrorimpl FromJson for AppMarketplaceInterfacefn AppMarketplaceInterface::from_json(value : Json, path : JsonPath) -> AppMarketplaceInterface raise JsonDecodeErrorimpl FromJson for AppMarketplaceLoadErrorInfofn AppMarketplaceLoadErrorInfo::from_json(value : Json, path : JsonPath) -> AppMarketplaceLoadErrorInfo raise JsonDecodeErrorimpl ToJson for AppMarketplaceRemoveParamspub struct AppMarketplaceRemoveResponse {
marketplace_name : String
installed_root : String?
} derive(Debug)impl FromJson for AppMarketplaceRemoveResponsefn AppMarketplaceRemoveResponse::from_json(value : Json, path : JsonPath) -> AppMarketplaceRemoveResponse raise JsonDecodeErrorpub struct AppMarketplaceUpgradeErrorInfo {
marketplace_name : String
message : String
} derive(Debug)impl FromJson for AppMarketplaceUpgradeErrorInfofn AppMarketplaceUpgradeErrorInfo::from_json(value : Json, path : JsonPath) -> AppMarketplaceUpgradeErrorInfo raise JsonDecodeErrorimpl ToJson for AppMarketplaceUpgradeParamspub struct AppMarketplaceUpgradeResponse {
selected_marketplaces : ArrayView[String]
upgraded_roots : ArrayView[String]
errors : ArrayView[AppMarketplaceUpgradeErrorInfo]
} derive(Debug)impl FromJson for AppMarketplaceUpgradeResponsefn AppMarketplaceUpgradeResponse::from_json(value : Json, path : JsonPath) -> AppMarketplaceUpgradeResponse raise JsonDecodeErrorpub enum AppMcpAuthStatus {
AppMcpUnsupported
AppMcpNotLoggedIn
AppMcpBearerToken
AppMcpOAuth
} derive(Debug)impl FromJson for AppMcpAuthStatusfn AppMcpAuthStatus::from_json(value : Json, path : JsonPath) -> AppMcpAuthStatus raise JsonDecodeErrorpub(all) struct AppMcpElicitationBooleanSchema {
title : String?
description : String?
default : Bool?
} derive(Debug)impl FromJson for AppMcpElicitationBooleanSchemafn AppMcpElicitationBooleanSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationBooleanSchema raise JsonDecodeErrorimpl FromJson for AppMcpElicitationConstOptionfn AppMcpElicitationConstOption::from_json(value : Json, path : JsonPath) -> AppMcpElicitationConstOption raise JsonDecodeErrorpub(all) struct AppMcpElicitationNumberSchema {
number_type : AppMcpElicitationNumberType
title : String?
description : String?
minimum : Double?
maximum : Double?
default : Double?
} derive(Debug)impl FromJson for AppMcpElicitationNumberSchemafn AppMcpElicitationNumberSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationNumberSchema raise JsonDecodeErrorpub(all) enum AppMcpElicitationNumberType {
AppMcpElicitationNumberTypeNumber
AppMcpElicitationNumberTypeInteger
} derive(Debug)impl FromJson for AppMcpElicitationNumberTypefn AppMcpElicitationNumberType::from_json(value : Json, path : JsonPath) -> AppMcpElicitationNumberType raise JsonDecodeErrorimpl FromJson for AppMcpElicitationObjectTypefn AppMcpElicitationObjectType::from_json(value : Json, path : JsonPath) -> AppMcpElicitationObjectType raise JsonDecodeErrorpub(all) enum AppMcpElicitationPrimitiveSchema {
AppMcpElicitationString(AppMcpElicitationStringSchema)
AppMcpElicitationNumber(AppMcpElicitationNumberSchema)
AppMcpElicitationBoolean(AppMcpElicitationBooleanSchema)
AppMcpElicitationStringEnum(AppMcpElicitationStringEnumSchema)
AppMcpElicitationTitledStringEnum(AppMcpElicitationTitledStringEnumSchema)
AppMcpElicitationUntitledMultiSelect(AppMcpElicitationUntitledMultiSelectSchema)
AppMcpElicitationTitledMultiSelect(AppMcpElicitationTitledMultiSelectSchema)
} derive(Debug)impl FromJson for AppMcpElicitationPrimitiveSchemafn from_json(value : Json, path : JsonPath) -> AppMcpElicitationPrimitiveSchema raise JsonDecodeErrorfn AppMcpElicitationPrimitiveSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationPrimitiveSchema raise JsonDecodeErrorpub(all) struct AppMcpElicitationSchema {
schema_uri : String?
object_type : AppMcpElicitationObjectType
properties : Map[String, AppMcpElicitationPrimitiveSchema]
required : ArrayView[String]?
} derive(Debug)impl FromJson for AppMcpElicitationSchemafn AppMcpElicitationSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationSchema raise JsonDecodeErrorfn from_json(value : Json, path : JsonPath) -> AppMcpElicitationStringEnumSchema raise JsonDecodeErrorfn AppMcpElicitationStringEnumSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationStringEnumSchema raise JsonDecodeErrorpub(all) enum AppMcpElicitationStringFormat {
AppMcpElicitationEmailFormat
AppMcpElicitationUriFormat
AppMcpElicitationDateFormat
AppMcpElicitationDateTimeFormat
} derive(Debug)impl FromJson for AppMcpElicitationStringFormatfn AppMcpElicitationStringFormat::from_json(value : Json, path : JsonPath) -> AppMcpElicitationStringFormat raise JsonDecodeErrorpub(all) struct AppMcpElicitationStringSchema {
title : String?
description : String?
min_length : UInt?
max_length : UInt?
format : AppMcpElicitationStringFormat?
default : String?
} derive(Debug)impl FromJson for AppMcpElicitationStringSchemafn AppMcpElicitationStringSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationStringSchema raise JsonDecodeErrorpub(all) struct AppMcpElicitationTitledEnumItems {
any_of : ArrayView[AppMcpElicitationConstOption]
} derive(Debug)impl FromJson for AppMcpElicitationTitledEnumItemsfn from_json(value : Json, path : JsonPath) -> AppMcpElicitationTitledEnumItems raise JsonDecodeErrorfn AppMcpElicitationTitledEnumItems::from_json(value : Json, path : JsonPath) -> AppMcpElicitationTitledEnumItems raise JsonDecodeErrorpub(all) struct AppMcpElicitationTitledMultiSelectSchema {
title : String?
description : String?
min_items : UInt64?
max_items : UInt64?
items : AppMcpElicitationTitledEnumItems
default : ArrayView[String]?
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppMcpElicitationTitledMultiSelectSchema raise JsonDecodeErrorfn AppMcpElicitationTitledMultiSelectSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationTitledMultiSelectSchema raise JsonDecodeErrorpub(all) struct AppMcpElicitationTitledStringEnumSchema {
title : String?
description : String?
one_of : ArrayView[AppMcpElicitationConstOption]
default : String?
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppMcpElicitationTitledStringEnumSchema raise JsonDecodeErrorfn AppMcpElicitationTitledStringEnumSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationTitledStringEnumSchema raise JsonDecodeErrorfn from_json(value : Json, path : JsonPath) -> AppMcpElicitationUntitledEnumItems raise JsonDecodeErrorfn AppMcpElicitationUntitledEnumItems::from_json(value : Json, path : JsonPath) -> AppMcpElicitationUntitledEnumItems raise JsonDecodeErrorpub(all) struct AppMcpElicitationUntitledMultiSelectSchema {
title : String?
description : String?
min_items : UInt64?
max_items : UInt64?
items : AppMcpElicitationUntitledEnumItems
default : ArrayView[String]?
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppMcpElicitationUntitledMultiSelectSchema raise JsonDecodeErrorfn AppMcpElicitationUntitledMultiSelectSchema::from_json(value : Json, path : JsonPath) -> AppMcpElicitationUntitledMultiSelectSchema raise JsonDecodeErrorimpl FromJson for AppMcpResourceContentfn AppMcpResourceContent::from_json(value : Json, path : JsonPath) -> AppMcpResourceContent raise JsonDecodeErrorpub(all) struct AppMcpResourceReadParams {
thread_id : String?
server : String
uri : String
} derive(Debug)impl ToJson for AppMcpResourceReadParamsimpl FromJson for AppMcpResourceTemplatefn AppMcpResourceTemplate::from_json(value : Json, path : JsonPath) -> AppMcpResourceTemplate raise JsonDecodeErrorpub(all) enum AppMcpServerElicitationAction {
AppMcpElicitationAccept
AppMcpElicitationDecline
AppMcpElicitationCancel
} derive(Debug)impl ToJson for AppMcpServerElicitationActionpub(all) enum AppMcpServerElicitationContent {
AppMcpElicitationForm(meta~ : Json?, message~ : String, requested_schema~ : AppMcpElicitationSchema)
AppMcpElicitationOpenAIForm(meta~ : Json?, message~ : String, requested_schema~ : Json)
AppMcpElicitationUrl(meta~ : Json?, message~ : String, url~ : String, elicitation_id~ : String)
} derive(Debug)impl FromJson for AppMcpServerElicitationContentfn AppMcpServerElicitationContent::from_json(value : Json, path : JsonPath) -> AppMcpServerElicitationContent raise JsonDecodeErrorpub(all) struct AppMcpServerElicitationRequest {
thread_id : String
turn_id : String?
server_name : String
elicitation : AppMcpServerElicitationContent
// private fields
} derive(Debug)impl FromJson for AppMcpServerElicitationRequestfn AppMcpServerElicitationRequest::from_json(value : Json, path : JsonPath) -> AppMcpServerElicitationRequest raise JsonDecodeErrorimpl ToJson for AppMcpServerOauthLoginParamsimpl FromJson for AppMcpServerOauthLoginResponsefn AppMcpServerOauthLoginResponse::from_json(value : Json, path : JsonPath) -> AppMcpServerOauthLoginResponse raise JsonDecodeErrorpub struct AppMcpServerResourceReadResponse {
contents : ArrayView[AppMcpResourceContent]
} derive(Debug)impl FromJson for AppMcpServerResourceReadResponsefn from_json(value : Json, path : JsonPath) -> AppMcpServerResourceReadResponse raise JsonDecodeErrorfn AppMcpServerResourceReadResponse::from_json(value : Json, path : JsonPath) -> AppMcpServerResourceReadResponse raise JsonDecodeErrorpub enum AppMcpServerStartupState {
AppMcpServerStarting
AppMcpServerReady
AppMcpServerFailed
AppMcpServerCancelled
} derive(Debug)impl FromJson for AppMcpServerStartupStatefn AppMcpServerStartupState::from_json(value : Json, path : JsonPath) -> AppMcpServerStartupState raise JsonDecodeErrorpub struct AppMcpServerStatus {
name : String
tools : Map[String, AppMcpTool]
resources : ArrayView[AppMcpResource]
resource_templates : ArrayView[AppMcpResourceTemplate]
auth_status : AppMcpAuthStatus
} derive(Debug)impl FromJson for AppMcpServerStatusfn AppMcpServerStatus::from_json(value : Json, path : JsonPath) -> AppMcpServerStatus raise JsonDecodeErrorpub(all) enum AppMcpServerStatusDetail {
AppMcpServerStatusFull
AppMcpServerStatusToolsAndAuthOnly
} derive(Debug)impl ToJson for AppMcpServerStatusDetailpub(all) struct AppMcpServerStatusListParams {
cursor : String?
limit : UInt?
detail : AppMcpServerStatusDetail?
} derive(Debug)impl ToJson for AppMcpServerStatusListParamspub struct AppMcpServerStatusListResponse {
data : ArrayView[AppMcpServerStatus]
next_cursor : String?
} derive(Debug)impl FromJson for AppMcpServerStatusListResponsefn AppMcpServerStatusListResponse::from_json(value : Json, path : JsonPath) -> AppMcpServerStatusListResponse raise JsonDecodeErrorimpl ToJson for AppMcpServerToolCallParamsimpl FromJson for AppMcpServerToolCallResponsefn AppMcpServerToolCallResponse::from_json(value : Json, path : JsonPath) -> AppMcpServerToolCallResponse raise JsonDecodeErrorpub struct AppMemoryCitation {
entries : ArrayView[AppMemoryCitationEntry]
thread_ids : ArrayView[String]
} derive(Debug)impl FromJson for AppMemoryCitationfn AppMemoryCitation::from_json(value : Json, path : JsonPath) -> AppMemoryCitation raise JsonDecodeErrorpub struct AppMemoryCitationEntry {
path : String
line_start : UInt
line_end : UInt
note : String
} derive(Debug)impl FromJson for AppMemoryCitationEntryfn AppMemoryCitationEntry::from_json(value : Json, path : JsonPath) -> AppMemoryCitationEntry raise JsonDecodeErrorimpl FromJson for AppMessagePhasefn AppMessagePhase::from_json(value : Json, path : JsonPath) -> AppMessagePhase raise JsonDecodeErrorpub(all) struct AppMigrationDetails {
plugins : ArrayView[AppPluginsMigration]
sessions : ArrayView[AppSessionMigration]
mcp_servers : ArrayView[AppNamedMigration]
hooks : ArrayView[AppNamedMigration]
subagents : ArrayView[AppNamedMigration]
commands : ArrayView[AppNamedMigration]
} derive(Debug)impl ToJson for AppMigrationDetailsimpl FromJson for AppMigrationDetailsfn AppMigrationDetails::from_json(value : Json, path : JsonPath) -> AppMigrationDetails raise JsonDecodeErrorimpl ToJson for AppMockExperimentalMethodParamsfn from_json(value : Json, path : JsonPath) -> AppMockExperimentalMethodResponse raise JsonDecodeErrorfn AppMockExperimentalMethodResponse::from_json(value : Json, path : JsonPath) -> AppMockExperimentalMethodResponse raise JsonDecodeErrorpub struct AppModel {
id : String
model : String
upgrade : String?
upgrade_info : AppModelUpgradeInfo?
availability_nux : AppModelAvailabilityNux?
display_name : String
description : String
model_specialty : String?
hidden : Bool
supported_reasoning_efforts : ArrayView[AppReasoningEffortOption]
default_reasoning_effort : AppReasoningEffort
input_modalities : ArrayView[AppInputModality]
supports_personality : Bool
multi_agent_version : AppMultiAgentVersion?
additional_speed_tiers : ArrayView[String]
service_tiers : ArrayView[AppModelServiceTier]
default_service_tier : String?
is_default : Bool
// private fields
} derive(Debug)impl FromJson for AppModelAvailabilityNuxfn AppModelAvailabilityNux::from_json(value : Json, path : JsonPath) -> AppModelAvailabilityNux raise JsonDecodeErrorpub struct AppModelListParams {
cursor : String?
limit : UInt?
include_hidden : Bool?
} derive(Debug)impl ToJson for AppModelListParamsfn AppModelListParams::new(cursor? : String, limit? : UInt, include_hidden? : Bool) -> AppModelListParamsimpl FromJson for AppModelListResponsefn AppModelListResponse::from_json(value : Json, path : JsonPath) -> AppModelListResponse raise JsonDecodeErrorpub struct AppModelProviderCapabilitiesReadResponse {
namespace_tools : Bool
image_generation : Bool
web_search : Bool
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppModelProviderCapabilitiesReadResponse raise JsonDecodeErrorfn AppModelProviderCapabilitiesReadResponse::from_json(value : Json, path : JsonPath) -> AppModelProviderCapabilitiesReadResponse raise JsonDecodeErrorimpl FromJson for AppModelRerouteReasonfn AppModelRerouteReason::from_json(value : Json, path : JsonPath) -> AppModelRerouteReason raise JsonDecodeErrorimpl FromJson for AppModelServiceTierfn AppModelServiceTier::from_json(value : Json, path : JsonPath) -> AppModelServiceTier raise JsonDecodeErrorpub struct AppModelUpgradeInfo {
model : String
upgrade_copy : String?
model_link : String?
migration_markdown : String?
} derive(Debug)impl FromJson for AppModelUpgradeInfofn AppModelUpgradeInfo::from_json(value : Json, path : JsonPath) -> AppModelUpgradeInfo raise JsonDecodeErrorimpl FromJson for AppModelVerbosityfn AppModelVerbosity::from_json(value : Json, path : JsonPath) -> AppModelVerbosity raise JsonDecodeErrorimpl FromJson for AppModelVerificationfn AppModelVerification::from_json(value : Json, path : JsonPath) -> AppModelVerification raise JsonDecodeErrorpub(all) enum AppMultiAgentVersion {
AppMultiAgentDisabled
AppMultiAgentV1
AppMultiAgentV2
AppMultiAgentCustom(String)
} derive(Debug)impl FromJson for AppMultiAgentVersionfn AppMultiAgentVersion::from_json(value : Json, path : JsonPath) -> AppMultiAgentVersion raise JsonDecodeErrorimpl ToJson for AppNamedMigrationimpl FromJson for AppNamedMigrationfn AppNamedMigration::from_json(value : Json, path : JsonPath) -> AppNamedMigration raise JsonDecodeErrorimpl ToJson for AppNetworkAccessimpl FromJson for AppNetworkAccessfn AppNetworkAccess::from_json(value : Json, path : JsonPath) -> AppNetworkAccess raise JsonDecodeErrorpub struct AppNetworkApprovalContext {
host : String
protocol : AppNetworkApprovalProtocol
} derive(Debug)impl FromJson for AppNetworkApprovalContextfn AppNetworkApprovalContext::from_json(value : Json, path : JsonPath) -> AppNetworkApprovalContext raise JsonDecodeErrorpub enum AppNetworkApprovalProtocol {
AppNetworkApprovalHttp
AppNetworkApprovalHttps
AppNetworkApprovalSocks5Tcp
AppNetworkApprovalSocks5Udp
} derive(Debug)impl FromJson for AppNetworkApprovalProtocolfn AppNetworkApprovalProtocol::from_json(value : Json, path : JsonPath) -> AppNetworkApprovalProtocol raise JsonDecodeErrorpub(all) struct AppNetworkPolicyAmendment {
host : String
action : AppNetworkPolicyRuleAction
} derive(Debug)impl ToJson for AppNetworkPolicyAmendmentimpl FromJson for AppNetworkPolicyAmendmentfn AppNetworkPolicyAmendment::from_json(value : Json, path : JsonPath) -> AppNetworkPolicyAmendment raise JsonDecodeErrorpub(all) enum AppNetworkPolicyRuleAction {
AppNetworkPolicyAllow
AppNetworkPolicyDeny
} derive(Debug)impl ToJson for AppNetworkPolicyRuleActionimpl FromJson for AppNetworkPolicyRuleActionfn AppNetworkPolicyRuleAction::from_json(value : Json, path : JsonPath) -> AppNetworkPolicyRuleAction raise JsonDecodeErrorimpl FromJson for AppNonSteerableTurnKindfn AppNonSteerableTurnKind::from_json(value : Json, path : JsonPath) -> AppNonSteerableTurnKind raise JsonDecodeErrorpub(all) enum AppNullableString {
AppNullableStringNull
AppNullableStringValue(String)
} derive(Debug)impl ToJson for AppNullableStringimpl FromJson for AppOutputStreamfn AppOutputStream::from_json(value : Json, path : JsonPath) -> AppOutputStream raise JsonDecodeErrorpub(all) enum AppPermissionGrantScope {
AppPermissionGrantTurn
AppPermissionGrantSession
} derive(Debug)impl ToJson for AppPermissionGrantScopeimpl FromJson for AppPermissionGrantScopefn AppPermissionGrantScope::from_json(value : Json, path : JsonPath) -> AppPermissionGrantScope raise JsonDecodeErrorpub(all) struct AppPermissionsRequestApprovalRequest {
thread_id : String
turn_id : String
item_id : String
environment_id : String?
started_at_ms : Int64
cwd : String
reason : String?
permissions : AppRequestPermissionProfile
// private fields
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppPermissionsRequestApprovalRequest raise JsonDecodeErrorfn AppPermissionsRequestApprovalRequest::from_json(value : Json, path : JsonPath) -> AppPermissionsRequestApprovalRequest raise JsonDecodeErrorpub(all) enum AppPersonality {
AppNoPersonality
AppFriendlyPersonality
AppPragmaticPersonality
} derive(Debug)impl ToJson for AppPersonalitypub enum AppPlanType {
AppPlanFree
AppPlanGo
AppPlanPlus
AppPlanPro
AppPlanProlite
AppPlanTeam
AppPlanSelfServeBusinessUsageBased
AppPlanBusiness
AppPlanEnterpriseCbpUsageBased
AppPlanEnterprise
AppPlanEdu
AppPlanUnknown
} derive(Debug)impl FromJson for AppPluginAuthPolicyfn AppPluginAuthPolicy::from_json(value : Json, path : JsonPath) -> AppPluginAuthPolicy raise JsonDecodeErrorpub struct AppPluginDetail {
marketplace_name : String
marketplace_path : String?
summary : AppPluginSummary
description : String?
skills : ArrayView[AppSkillSummary]
apps : ArrayView[AppSummary]
mcp_servers : ArrayView[String]
// private fields
} derive(Debug)impl FromJson for AppPluginDetailfn AppPluginDetail::from_json(value : Json, path : JsonPath) -> AppPluginDetail raise JsonDecodeErrorpub(all) struct AppPluginInstallParams {
marketplace_path : String?
remote_marketplace_name : String?
plugin_name : String
} derive(Debug)impl ToJson for AppPluginInstallParamspub enum AppPluginInstallPolicy {
AppPluginInstallNotAvailable
AppPluginInstallAvailable
AppPluginInstallInstalledByDefault
} derive(Debug)impl FromJson for AppPluginInstallPolicyfn AppPluginInstallPolicy::from_json(value : Json, path : JsonPath) -> AppPluginInstallPolicy raise JsonDecodeErrorpub struct AppPluginInstallResponse {
auth_policy : AppPluginAuthPolicy
apps_needing_auth : ArrayView[AppSummary]
} derive(Debug)impl FromJson for AppPluginInstallResponsefn AppPluginInstallResponse::from_json(value : Json, path : JsonPath) -> AppPluginInstallResponse raise JsonDecodeErrorpub struct AppPluginInterface {
display_name : String?
short_description : String?
long_description : String?
developer_name : String?
category : String?
capabilities : ArrayView[String]
website_url : String?
privacy_policy_url : String?
terms_of_service_url : String?
default_prompt : ArrayView[String]?
brand_color : String?
composer_icon : String?
composer_icon_url : String?
logo : String?
logo_url : String?
screenshots : ArrayView[String]
screenshot_urls : ArrayView[String]
// private fields
} derive(Debug)impl FromJson for AppPluginInterfacefn AppPluginInterface::from_json(value : Json, path : JsonPath) -> AppPluginInterface raise JsonDecodeErrorpub(all) enum AppPluginListMarketplaceKind {
AppPluginMarketplaceLocal
AppPluginMarketplaceWorkspaceDirectory
AppPluginMarketplaceSharedWithMe
} derive(Debug)impl ToJson for AppPluginListMarketplaceKindpub(all) struct AppPluginListParams {
cwds : Array[String]?
marketplace_kinds : Array[AppPluginListMarketplaceKind]?
} derive(Debug)pub struct AppPluginListResponse {
marketplaces : ArrayView[AppPluginMarketplaceEntry]
marketplace_load_errors : ArrayView[AppMarketplaceLoadErrorInfo]
featured_plugin_ids : ArrayView[String]
} derive(Debug)impl FromJson for AppPluginListResponsefn AppPluginListResponse::from_json(value : Json, path : JsonPath) -> AppPluginListResponse raise JsonDecodeErrorpub struct AppPluginMarketplaceEntry {
name : String
path : String?
interface : AppMarketplaceInterface?
plugins : ArrayView[AppPluginSummary]
// private fields
} derive(Debug)impl FromJson for AppPluginMarketplaceEntryfn AppPluginMarketplaceEntry::from_json(value : Json, path : JsonPath) -> AppPluginMarketplaceEntry raise JsonDecodeErrorpub(all) struct AppPluginReadParams {
marketplace_path : String?
remote_marketplace_name : String?
plugin_name : String
} derive(Debug)impl FromJson for AppPluginReadResponsefn AppPluginReadResponse::from_json(value : Json, path : JsonPath) -> AppPluginReadResponse raise JsonDecodeErrorpub enum AppPluginSource {
AppPluginSourceLocal(path~ : String)
AppPluginSourceGit(url~ : String, path~ : String?, ref_name~ : String?, sha~ : String?)
AppPluginSourceRemote
} derive(Debug)impl FromJson for AppPluginSourcefn AppPluginSource::from_json(value : Json, path : JsonPath) -> AppPluginSource raise JsonDecodeErrorpub struct AppPluginSummary {
id : String
name : String
source : AppPluginSource
installed : Bool
enabled : Bool
install_policy : AppPluginInstallPolicy
auth_policy : AppPluginAuthPolicy
interface : AppPluginInterface?
// private fields
} derive(Debug)impl FromJson for AppPluginSummaryfn AppPluginSummary::from_json(value : Json, path : JsonPath) -> AppPluginSummary raise JsonDecodeErrorimpl ToJson for AppPluginUninstallParamsimpl ToJson for AppPluginsMigrationimpl FromJson for AppPluginsMigrationfn AppPluginsMigration::from_json(value : Json, path : JsonPath) -> AppPluginsMigration raise JsonDecodeErrorpub struct AppProfileV2 {
model : String?
model_provider : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
service_tier : String?
model_reasoning_effort : AppReasoningEffort?
model_reasoning_summary : AppReasoningSummary?
model_verbosity : AppModelVerbosity?
web_search : AppWebSearchMode?
tools : AppConfigToolsV2?
chatgpt_base_url : String?
additional : Map[String, Json]
// private fields
} derive(Debug)pub enum AppRateLimitReachedType {
AppRateLimitReached
AppWorkspaceOwnerCreditsDepleted
AppWorkspaceMemberCreditsDepleted
AppWorkspaceOwnerUsageLimitReached
AppWorkspaceMemberUsageLimitReached
} derive(Debug)impl FromJson for AppRateLimitReachedTypefn AppRateLimitReachedType::from_json(value : Json, path : JsonPath) -> AppRateLimitReachedType raise JsonDecodeErrorpub struct AppRateLimitSnapshot {
limit_id : String?
limit_name : String?
primary : AppRateLimitWindow?
secondary : AppRateLimitWindow?
credits : AppCreditsSnapshot?
plan_type : AppPlanType?
rate_limit_reached_type : AppRateLimitReachedType?
// private fields
} derive(Debug)impl FromJson for AppRateLimitSnapshotfn AppRateLimitSnapshot::from_json(value : Json, path : JsonPath) -> AppRateLimitSnapshot raise JsonDecodeErrorpub struct AppRateLimitWindow {
used_percent : Int
window_duration_mins : Int64?
resets_at : Int64?
} derive(Debug)impl FromJson for AppRateLimitWindowfn AppRateLimitWindow::from_json(value : Json, path : JsonPath) -> AppRateLimitWindow raise JsonDecodeErrorpub(all) enum AppRealtimeConversationVersion {
AppRealtimeConversationV1
AppRealtimeConversationV2
} derive(Debug)impl FromJson for AppRealtimeConversationVersionfn AppRealtimeConversationVersion::from_json(value : Json, path : JsonPath) -> AppRealtimeConversationVersion raise JsonDecodeErrorimpl ToJson for AppRealtimeOutputModalitypub(all) enum AppRealtimeVoice {
AppRealtimeVoiceAlloy
AppRealtimeVoiceArbor
AppRealtimeVoiceAsh
AppRealtimeVoiceBallad
AppRealtimeVoiceBreeze
AppRealtimeVoiceCedar
AppRealtimeVoiceCoral
AppRealtimeVoiceCove
AppRealtimeVoiceEcho
AppRealtimeVoiceEmber
AppRealtimeVoiceJuniper
AppRealtimeVoiceMaple
AppRealtimeVoiceMarin
AppRealtimeVoiceSage
AppRealtimeVoiceShimmer
AppRealtimeVoiceSol
AppRealtimeVoiceSpruce
AppRealtimeVoiceVale
AppRealtimeVoiceVerse
} derive(Debug)impl ToJson for AppRealtimeVoiceimpl FromJson for AppRealtimeVoicefn AppRealtimeVoice::from_json(value : Json, path : JsonPath) -> AppRealtimeVoice raise JsonDecodeErrorpub(all) struct AppRealtimeVoicesList {
v1 : ArrayView[AppRealtimeVoice]
v2 : ArrayView[AppRealtimeVoice]
default_v1 : AppRealtimeVoice
default_v2 : AppRealtimeVoice
} derive(Debug)impl FromJson for AppRealtimeVoicesListfn AppRealtimeVoicesList::from_json(value : Json, path : JsonPath) -> AppRealtimeVoicesList raise JsonDecodeErrorpub(all) enum AppReasoningEffort {
AppEffortNone
AppEffortMinimal
AppEffortLow
AppEffortMedium
AppEffortHigh
AppEffortXhigh
AppEffortMax
AppEffortUltra
AppEffortCustom(String)
} derive(Debug)impl ToJson for AppReasoningEffortimpl FromJson for AppReasoningEffortfn AppReasoningEffort::from_json(value : Json, path : JsonPath) -> AppReasoningEffort raise JsonDecodeErrorpub struct AppReasoningEffortOption {
reasoning_effort : AppReasoningEffort
description : String
} derive(Debug)impl FromJson for AppReasoningEffortOptionfn AppReasoningEffortOption::from_json(value : Json, path : JsonPath) -> AppReasoningEffortOption raise JsonDecodeErrorpub(all) enum AppReasoningSummary {
AppSummaryAuto
AppSummaryConcise
AppSummaryDetailed
AppSummaryNone
} derive(Debug)impl ToJson for AppReasoningSummaryimpl FromJson for AppReasoningSummaryfn AppReasoningSummary::from_json(value : Json, path : JsonPath) -> AppReasoningSummary raise JsonDecodeErrorpub(all) enum AppRemoteControlConnectionStatus {
AppRemoteControlDisabled
AppRemoteControlConnecting
AppRemoteControlConnected
AppRemoteControlErrored
} derive(Debug)impl FromJson for AppRemoteControlConnectionStatusfn from_json(value : Json, path : JsonPath) -> AppRemoteControlConnectionStatus raise JsonDecodeErrorfn AppRemoteControlConnectionStatus::from_json(value : Json, path : JsonPath) -> AppRemoteControlConnectionStatus raise JsonDecodeErrorimpl ToJson for AppRequestIdimpl FromJson for AppRequestIdpub(all) struct AppRequestPermissionProfile {
network : AppAdditionalNetworkPermissions?
file_system : AppAdditionalFileSystemPermissions?
} derive(Debug)impl FromJson for AppRequestPermissionProfilefn AppRequestPermissionProfile::from_json(value : Json, path : JsonPath) -> AppRequestPermissionProfile raise JsonDecodeErrorimpl FromJson for AppResidencyRequirementfn AppResidencyRequirement::from_json(value : Json, path : JsonPath) -> AppResidencyRequirement raise JsonDecodeErrorpub(all) enum AppResponseContentItem {
AppResponseInputText(text~ : String)
AppResponseInputImage(image_url~ : String, detail~ : AppResponseImageDetail?)
AppResponseOutputText(text~ : String)
} derive(Debug)impl FromJson for AppResponseContentItemfn AppResponseContentItem::from_json(value : Json, path : JsonPath) -> AppResponseContentItem raise JsonDecodeErrorpub(all) enum AppResponseFunctionCallOutputBody {
AppResponseFunctionOutputText(String)
AppResponseFunctionOutputContentItems(ArrayView[AppResponseFunctionCallOutputContentItem])
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppResponseFunctionCallOutputBody raise JsonDecodeErrorfn AppResponseFunctionCallOutputBody::from_json(value : Json, path : JsonPath) -> AppResponseFunctionCallOutputBody raise JsonDecodeErrorpub(all) enum AppResponseFunctionCallOutputContentItem {
AppResponseFunctionOutputInputText(text~ : String)
AppResponseFunctionOutputInputImage(image_url~ : String, detail~ : AppResponseImageDetail?)
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppResponseFunctionCallOutputContentItem raise JsonDecodeErrorfn AppResponseFunctionCallOutputContentItem::from_json(value : Json, path : JsonPath) -> AppResponseFunctionCallOutputContentItem raise JsonDecodeErrorpub(all) enum AppResponseImageDetail {
AppResponseImageAuto
AppResponseImageLow
AppResponseImageHigh
AppResponseImageOriginal
} derive(Debug)impl FromJson for AppResponseImageDetailfn AppResponseImageDetail::from_json(value : Json, path : JsonPath) -> AppResponseImageDetail raise JsonDecodeErrorpub(all) enum AppResponseItem {
AppResponseMessage(role~ : String, content~ : ArrayView[AppResponseContentItem], phase~ : AppResponseMessagePhase?)
AppResponseReasoning(summary~ : ArrayView[AppResponseReasoningSummary], content~ : ArrayView[AppResponseReasoningContent]?, encrypted_content~ : String?)
AppResponseLocalShellCall(call_id~ : String?, status~ : AppResponseLocalShellStatus, action~ : AppResponseLocalShellAction)
AppResponseFunctionCall(name~ : String, tool_namespace~ : String?, arguments~ : String, call_id~ : String)
AppResponseToolSearchCall(call_id~ : String?, status~ : String?, execution~ : String, arguments~ : Json)
AppResponseFunctionCallOutput(call_id~ : String, output~ : AppResponseFunctionCallOutputBody)
AppResponseCustomToolCall(status~ : String?, call_id~ : String, name~ : String, input~ : String)
AppResponseCustomToolCallOutput(call_id~ : String, name~ : String?, output~ : AppResponseFunctionCallOutputBody)
AppResponseToolSearchOutput(call_id~ : String?, status~ : String, execution~ : String, tools~ : ArrayView[Json])
AppResponseWebSearchCall(status~ : String?, action~ : AppResponseWebSearchAction?)
AppResponseImageGenerationCall(id~ : String, status~ : String, revised_prompt~ : String?, result~ : String)
AppResponseCompaction(encrypted_content~ : String)
AppResponseContextCompaction(encrypted_content~ : String?)
AppResponseOther
} derive(Debug)impl FromJson for AppResponseItemfn AppResponseItem::from_json(value : Json, path : JsonPath) -> AppResponseItem raise JsonDecodeErrorimpl FromJson for AppResponseLocalShellActionfn AppResponseLocalShellAction::from_json(value : Json, path : JsonPath) -> AppResponseLocalShellAction raise JsonDecodeErrorpub(all) enum AppResponseLocalShellStatus {
AppResponseLocalShellCompleted
AppResponseLocalShellInProgress
AppResponseLocalShellIncomplete
} derive(Debug)impl FromJson for AppResponseLocalShellStatusfn AppResponseLocalShellStatus::from_json(value : Json, path : JsonPath) -> AppResponseLocalShellStatus raise JsonDecodeErrorimpl FromJson for AppResponseMessagePhasefn AppResponseMessagePhase::from_json(value : Json, path : JsonPath) -> AppResponseMessagePhase raise JsonDecodeErrorpub(all) enum AppResponseReasoningContent {
AppResponseReasoningText(text~ : String)
AppResponseReasoningPlainText(text~ : String)
} derive(Debug)impl FromJson for AppResponseReasoningContentfn AppResponseReasoningContent::from_json(value : Json, path : JsonPath) -> AppResponseReasoningContent raise JsonDecodeErrorimpl FromJson for AppResponseReasoningSummaryfn AppResponseReasoningSummary::from_json(value : Json, path : JsonPath) -> AppResponseReasoningSummary raise JsonDecodeErrorimpl FromJson for AppResponseWebSearchActionfn AppResponseWebSearchAction::from_json(value : Json, path : JsonPath) -> AppResponseWebSearchAction raise JsonDecodeErrorpub(all) struct AppReviewStartParams {
thread_id : String
target : AppReviewTarget
delivery : AppReviewDelivery?
} derive(Debug)impl FromJson for AppReviewStartResponsefn AppReviewStartResponse::from_json(value : Json, path : JsonPath) -> AppReviewStartResponse raise JsonDecodeErrorpub(all) enum AppReviewTarget {
AppReviewUncommittedChanges
AppReviewBaseBranch(branch~ : String)
AppReviewCommit(sha~ : String, title~ : String?)
AppReviewCustom(instructions~ : String)
} derive(Debug)impl ToJson for AppReviewTargetpub(all) enum AppSandboxPolicy {
AppDangerFullAccess
AppReadOnly(network_access~ : Bool)
AppExternalSandbox(network_access~ : AppNetworkAccess)
AppWorkspaceWrite(writable_roots~ : Array[String], network_access~ : Bool, exclude_tmpdir_env_var~ : Bool, exclude_slash_tmp~ : Bool)
} derive(Debug)impl ToJson for AppSandboxPolicyimpl FromJson for AppSandboxPolicyfn AppSandboxPolicy::from_json(value : Json, path : JsonPath) -> AppSandboxPolicy raise JsonDecodeErrorimpl FromJson for AppSandboxWorkspaceWritefn AppSandboxWorkspaceWrite::from_json(value : Json, path : JsonPath) -> AppSandboxWorkspaceWrite raise JsonDecodeErrorimpl ToJson for AppSendAddCreditsNudgeEmailParamspub enum AppServerEvent {
AppRawNotification(rpc_method~ : String, params~ : Json?)
AppThreadStarted(AppThread)
AppThreadStatusChanged(thread_id~ : String, status~ : AppThreadStatus)
AppThreadArchived(thread_id~ : String)
AppThreadUnarchived(thread_id~ : String)
AppThreadClosed(thread_id~ : String)
AppSkillsChanged
AppThreadNameUpdated(thread_id~ : String, thread_name~ : String?)
AppThreadGoalUpdated(thread_id~ : String, turn_id~ : String?, goal~ : AppThreadGoal)
AppThreadGoalCleared(thread_id~ : String)
AppTurnStarted(thread_id~ : String, turn~ : AppTurn)
AppHookStarted(thread_id~ : String, turn_id~ : String?, run~ : AppHookRunSummary)
AppTurnCompleted(thread_id~ : String, turn~ : AppTurn)
AppHookCompleted(thread_id~ : String, turn_id~ : String?, run~ : AppHookRunSummary)
AppTurnDiffUpdated(thread_id~ : String, turn_id~ : String, diff~ : String)
AppTurnPlanUpdated(thread_id~ : String, turn_id~ : String, explanation~ : String?, plan~ : ArrayView[AppTurnPlanStep])
AppTurnError(thread_id~ : String, turn_id~ : String, error~ : AppTurnError, will_retry~ : Bool)
AppItemStarted(AppThreadItemEvent)
AppItemGuardianApprovalReviewStarted(thread_id~ : String, turn_id~ : String, started_at_ms~ : Int64, review_id~ : String, target_item_id~ : String?, review~ : AppGuardianApprovalReview, action~ : AppGuardianApprovalReviewAction)
AppItemGuardianApprovalReviewCompleted(thread_id~ : String, turn_id~ : String, started_at_ms~ : Int64, completed_at_ms~ : Int64, review_id~ : String, target_item_id~ : String?, decision_source~ : AppAutoReviewDecisionSource, review~ : AppGuardianApprovalReview, action~ : AppGuardianApprovalReviewAction)
AppItemCompleted(AppThreadItemEvent)
AppRawResponseItemCompleted(thread_id~ : String, turn_id~ : String, item~ : AppResponseItem)
AppAgentMessageDelta(thread_id~ : String, turn_id~ : String, item_id~ : String, delta~ : String)
AppPlanDelta(thread_id~ : String, turn_id~ : String, item_id~ : String, delta~ : String)
AppCommandExecOutputDelta(process_id~ : String, stream~ : AppOutputStream, delta_base64~ : String, cap_reached~ : Bool)
AppCommandExecutionOutputDelta(thread_id~ : String, turn_id~ : String, item_id~ : String, delta~ : String)
AppTerminalInteraction(thread_id~ : String, turn_id~ : String, item_id~ : String, process_id~ : String, stdin~ : String)
AppFileChangeOutputDelta(thread_id~ : String, turn_id~ : String, item_id~ : String, delta~ : String)
AppFileChangePatchUpdated(thread_id~ : String, turn_id~ : String, item_id~ : String, changes~ : ArrayView[AppThreadFileUpdateChange])
AppServerRequestResolved(thread_id~ : String, request_id~ : AppRequestId)
AppMcpToolCallProgress(thread_id~ : String, turn_id~ : String, item_id~ : String, message~ : String)
AppMcpServerOauthLoginCompleted(name~ : String, success~ : Bool, error~ : String?)
AppMcpServerStatusUpdated(name~ : String, status~ : AppMcpServerStartupState, error~ : String?)
AppAccountUpdated(auth_mode~ : AppAuthMode?, plan_type~ : AppPlanType?)
AppAccountRateLimitsUpdated(rate_limits~ : AppRateLimitSnapshot)
AppAppListUpdated(data~ : ArrayView[AppInfo])
AppRemoteControlStatusChanged(status~ : AppRemoteControlConnectionStatus, installation_id~ : String, environment_id~ : String?)
AppExternalAgentConfigImportCompleted
AppFsChanged(watch_id~ : String, changed_paths~ : ArrayView[String])
AppContextCompacted(thread_id~ : String, turn_id~ : String)
AppFuzzyFileSearchSessionUpdated(session_id~ : String, query~ : String, files~ : ArrayView[AppFuzzyFileSearchResult])
AppFuzzyFileSearchSessionCompleted(session_id~ : String)
AppReasoningSummaryTextDelta(thread_id~ : String, turn_id~ : String, item_id~ : String, delta~ : String, summary_index~ : Int64)
AppReasoningSummaryPartAdded(thread_id~ : String, turn_id~ : String, item_id~ : String, summary_index~ : Int64)
AppReasoningTextDelta(thread_id~ : String, turn_id~ : String, item_id~ : String, delta~ : String, content_index~ : Int64)
AppWindowsWorldWritableWarning(sample_paths~ : ArrayView[String], extra_count~ : UInt64, failed_scan~ : Bool)
AppWindowsSandboxSetupCompleted(mode~ : AppWindowsSandboxSetupMode, success~ : Bool, error~ : String?)
AppAccountLoginCompleted(login_id~ : String?, success~ : Bool, error~ : String?)
AppModelRerouted(thread_id~ : String, turn_id~ : String, from_model~ : String, to_model~ : String, reason~ : AppModelRerouteReason)
AppModelVerification(thread_id~ : String, turn_id~ : String, verifications~ : ArrayView[AppModelVerification])
AppWarning(thread_id~ : String?, message~ : String)
AppGuardianWarning(thread_id~ : String, message~ : String)
AppDeprecationNotice(summary~ : String, details~ : String?)
AppConfigWarning(summary~ : String, details~ : String?, path~ : String?, range~ : AppTextRange?)
AppThreadTokenUsageUpdated(thread_id~ : String, turn_id~ : String, token_usage~ : AppThreadTokenUsage)
AppThreadRealtimeStarted(thread_id~ : String, realtime_session_id~ : String?, version~ : AppRealtimeConversationVersion)
AppThreadRealtimeItemAdded(thread_id~ : String, item~ : Json)
AppThreadRealtimeTranscriptDelta(thread_id~ : String, role~ : String, delta~ : String)
AppThreadRealtimeTranscriptDone(thread_id~ : String, role~ : String, text~ : String)
AppThreadRealtimeOutputAudioDelta(thread_id~ : String, audio~ : AppThreadRealtimeAudioChunk)
AppThreadRealtimeSdp(thread_id~ : String, sdp~ : String)
AppThreadRealtimeError(thread_id~ : String, message~ : String)
AppThreadRealtimeClosed(thread_id~ : String, reason~ : String?)
} derive(Debug)impl FromJson for AppServerEventpub struct AppServerOptions {
executable_path_override : String?
client_info : AppClientInfo?
capabilities : AppInitializeCapabilities?
} derive(Default)fn AppServerOptions::new(executable_path_override? : String, client_info? : AppClientInfo, capabilities? : AppInitializeCapabilities) -> AppServerOptionspub enum AppServerRequestDetails {
AppCommandExecutionApprovalRequest(AppCommandExecutionApprovalRequest)
AppFileChangeApprovalRequest(AppFileChangeApprovalRequest)
AppToolRequestUserInputRequest(AppToolRequestUserInputRequest)
AppDynamicToolCallRequest(AppDynamicToolCallRequest)
AppPermissionsRequestApprovalRequest(AppPermissionsRequestApprovalRequest)
AppChatgptAuthTokensRefreshRequest(AppChatgptAuthTokensRefreshRequest)
AppAttestationGenerateRequest(AppAttestationGenerateRequest)
AppMcpServerElicitationRequest(AppMcpServerElicitationRequest)
AppRawServerRequest(rpc_method~ : String, params~ : Json?)
} derive(Debug)pub(all) enum AppServerResponse {
AppCommandExecutionApprovalResponse(decision~ : AppCommandExecutionApprovalDecision)
AppFileChangeApprovalResponse(decision~ : AppFileChangeApprovalDecision)
AppToolRequestUserInputResponse(answers~ : Map[String, AppToolRequestUserInputAnswer])
AppDynamicToolCallResponse(content_items~ : ArrayView[AppDynamicToolCallOutputContentItem], success~ : Bool)
AppPermissionsRequestApprovalResponse(permissions~ : AppGrantedPermissionProfile, scope~ : AppPermissionGrantScope, strict_auto_review~ : Bool?)
AppChatgptAuthTokensRefreshResponse(access_token~ : String, chatgpt_account_id~ : String, chatgpt_plan_type~ : String?)
AppAttestationGenerateResponse(token~ : String)
AppMcpServerElicitationResponse(action~ : AppMcpServerElicitationAction, content~ : Json?, meta~ : Json?)
AppRawServerResponse(Json)
AppRawServerError(code~ : Int64, message~ : String, data~ : Json?)
} derive(Debug)impl ToJson for AppServerResponseimpl ToJson for AppSessionMigrationimpl FromJson for AppSessionMigrationfn AppSessionMigration::from_json(value : Json, path : JsonPath) -> AppSessionMigration raise JsonDecodeErrorpub enum AppSessionSource {
AppSessionCli
AppSessionVsCode
AppSessionExec
AppSessionAppServer
AppSessionCustom(String)
AppSessionSubAgent(AppSubAgentSource)
AppSessionUnknown
} derive(Debug)impl FromJson for AppSessionSourcefn AppSessionSource::from_json(value : Json, path : JsonPath) -> AppSessionSource raise JsonDecodeErrorimpl FromJson for AppSkillDependenciesfn AppSkillDependencies::from_json(value : Json, path : JsonPath) -> AppSkillDependencies raise JsonDecodeErrorimpl FromJson for AppSkillErrorInfofn AppSkillErrorInfo::from_json(value : Json, path : JsonPath) -> AppSkillErrorInfo raise JsonDecodeErrorpub struct AppSkillInterface {
display_name : String?
short_description : String?
icon_small : String?
icon_large : String?
brand_color : String?
default_prompt : String?
} derive(Debug)impl FromJson for AppSkillInterfacefn AppSkillInterface::from_json(value : Json, path : JsonPath) -> AppSkillInterface raise JsonDecodeErrorpub struct AppSkillMetadata {
name : String
description : String
short_description : String?
interface : AppSkillInterface?
dependencies : AppSkillDependencies?
path : String
scope : AppSkillScope
enabled : Bool
} derive(Debug)impl FromJson for AppSkillMetadatafn AppSkillMetadata::from_json(value : Json, path : JsonPath) -> AppSkillMetadata raise JsonDecodeErrorpub enum AppSkillScope {
AppSkillScopeUser
AppSkillScopeRepo
AppSkillScopeSystem
AppSkillScopeAdmin
} derive(Debug)pub struct AppSkillSummary {
name : String
description : String
short_description : String?
interface : AppSkillInterface?
path : String?
enabled : Bool
} derive(Debug)impl FromJson for AppSkillSummaryfn AppSkillSummary::from_json(value : Json, path : JsonPath) -> AppSkillSummary raise JsonDecodeErrorpub struct AppSkillToolDependency {
dep_type : String
value : String
description : String?
transport : String?
command : String?
url : String?
} derive(Debug)impl FromJson for AppSkillToolDependencyfn AppSkillToolDependency::from_json(value : Json, path : JsonPath) -> AppSkillToolDependency raise JsonDecodeErrorpub(all) struct AppSkillsConfigWriteParams {
path : String?
name : String?
enabled : Bool
} derive(Debug)impl ToJson for AppSkillsConfigWriteParamsimpl FromJson for AppSkillsConfigWriteResponsefn AppSkillsConfigWriteResponse::from_json(value : Json, path : JsonPath) -> AppSkillsConfigWriteResponse raise JsonDecodeErrorpub struct AppSkillsListEntry {
cwd : String
skills : ArrayView[AppSkillMetadata]
errors : ArrayView[AppSkillErrorInfo]
} derive(Debug)impl FromJson for AppSkillsListEntryfn AppSkillsListEntry::from_json(value : Json, path : JsonPath) -> AppSkillsListEntry raise JsonDecodeErrorimpl FromJson for AppSkillsListResponsefn AppSkillsListResponse::from_json(value : Json, path : JsonPath) -> AppSkillsListResponse raise JsonDecodeErrorpub enum AppSubAgentSource {
AppSubAgentReview
AppSubAgentCompact
AppSubAgentThreadSpawn(parent_thread_id~ : String, depth~ : Int, agent_path~ : String?, agent_nickname~ : String?, agent_role~ : String?)
AppSubAgentMemoryConsolidation
AppSubAgentOther(String)
} derive(Debug)impl FromJson for AppSubAgentSourcefn AppSubAgentSource::from_json(value : Json, path : JsonPath) -> AppSubAgentSource raise JsonDecodeErrorpub struct AppSummary {
id : String
name : String
description : String?
install_url : String?
needs_auth : Bool
} derive(Debug)impl FromJson for AppTextPositionfn AppTextPosition::from_json(value : Json, path : JsonPath) -> AppTextPosition raise JsonDecodeErrorpub struct AppThread {
id : String
session_id : String
forked_from_id : String?
parent_thread_id : String?
preview : String
ephemeral : Bool
section : AppThreadSection?
section_entered_at : Int64?
project_id : String?
model_provider : String
created_at : Int64
updated_at : Int64
recency_at : Int64?
status : AppThreadStatus
path : String?
cwd : String
cli_version : String
source : AppSessionSource
thread_source : String?
agent_nickname : String?
agent_role : String?
git_info : AppConversationGitInfo?
name : String?
turns : ArrayView[AppTurn]
// private fields
} derive(Debug)pub enum AppThreadActiveFlag {
AppThreadWaitingOnApproval
AppThreadWaitingOnUserInput
} derive(Debug)impl FromJson for AppThreadActiveFlagfn AppThreadActiveFlag::from_json(value : Json, path : JsonPath) -> AppThreadActiveFlag raise JsonDecodeErrorfn AppThreadApproveGuardianDeniedActionParams::to_json(params : AppThreadApproveGuardianDeniedActionParams) -> Jsonpub struct AppThreadCollabAgentState {
status : AppThreadCollabAgentStatus
message : String?
} derive(Debug)impl FromJson for AppThreadCollabAgentStatefn AppThreadCollabAgentState::from_json(value : Json, path : JsonPath) -> AppThreadCollabAgentState raise JsonDecodeErrorpub enum AppThreadCollabAgentStatus {
AppThreadCollabAgentPendingInit
AppThreadCollabAgentRunning
AppThreadCollabAgentInterrupted
AppThreadCollabAgentCompleted
AppThreadCollabAgentErrored
AppThreadCollabAgentShutdown
AppThreadCollabAgentNotFound
} derive(Debug)impl FromJson for AppThreadCollabAgentStatusfn AppThreadCollabAgentStatus::from_json(value : Json, path : JsonPath) -> AppThreadCollabAgentStatus raise JsonDecodeErrorpub enum AppThreadCollabAgentTool {
AppThreadCollabSpawnAgent
AppThreadCollabSendInput
AppThreadCollabResumeAgent
AppThreadCollabWait
AppThreadCollabCloseAgent
} derive(Debug)impl FromJson for AppThreadCollabAgentToolfn AppThreadCollabAgentTool::from_json(value : Json, path : JsonPath) -> AppThreadCollabAgentTool raise JsonDecodeErrorpub enum AppThreadCollabAgentToolCallStatus {
AppThreadCollabInProgress
AppThreadCollabCompleted
AppThreadCollabFailed
} derive(Debug)fn from_json(value : Json, path : JsonPath) -> AppThreadCollabAgentToolCallStatus raise JsonDecodeErrorfn AppThreadCollabAgentToolCallStatus::from_json(value : Json, path : JsonPath) -> AppThreadCollabAgentToolCallStatus raise JsonDecodeErrorpub enum AppThreadCommandExecutionSource {
AppThreadCommandSourceAgent
AppThreadCommandSourceUserShell
AppThreadCommandSourceUnifiedExecStartup
AppThreadCommandSourceUnifiedExecInteraction
} derive(Debug)impl FromJson for AppThreadCommandExecutionSourcefn from_json(value : Json, path : JsonPath) -> AppThreadCommandExecutionSource raise JsonDecodeErrorfn AppThreadCommandExecutionSource::from_json(value : Json, path : JsonPath) -> AppThreadCommandExecutionSource raise JsonDecodeErrorpub enum AppThreadCommandExecutionStatus {
AppThreadCommandInProgress
AppThreadCommandCompleted
AppThreadCommandFailed
AppThreadCommandDeclined
} derive(Debug)impl FromJson for AppThreadCommandExecutionStatusfn from_json(value : Json, path : JsonPath) -> AppThreadCommandExecutionStatus raise JsonDecodeErrorfn AppThreadCommandExecutionStatus::from_json(value : Json, path : JsonPath) -> AppThreadCommandExecutionStatus raise JsonDecodeErrorpub enum AppThreadDynamicToolCallStatus {
AppThreadDynamicInProgress
AppThreadDynamicCompleted
AppThreadDynamicFailed
} derive(Debug)impl FromJson for AppThreadDynamicToolCallStatusfn AppThreadDynamicToolCallStatus::from_json(value : Json, path : JsonPath) -> AppThreadDynamicToolCallStatus raise JsonDecodeErrorimpl ToJson for AppThreadElicitationCounterParamsfn from_json(value : Json, path : JsonPath) -> AppThreadElicitationCounterResponse raise JsonDecodeErrorfn AppThreadElicitationCounterResponse::from_json(value : Json, path : JsonPath) -> AppThreadElicitationCounterResponse raise JsonDecodeErrorpub struct AppThreadFileUpdateChange {
path : String
kind : AppThreadPatchChangeKind
diff : String
} derive(Debug)impl FromJson for AppThreadFileUpdateChangefn AppThreadFileUpdateChange::from_json(value : Json, path : JsonPath) -> AppThreadFileUpdateChange raise JsonDecodeErrorpub(all) struct AppThreadForkParams {
thread_id : String
last_turn_id : String?
model : String?
model_provider : String?
service_tier : AppNullableString?
cwd : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
sandbox : SandboxMode?
config : Map[String, Json]?
base_instructions : String?
developer_instructions : String?
ephemeral : Bool?
thread_source : String?
} derive(Debug)pub struct AppThreadForkResponse {
thread : AppThread
model : String
model_provider : String
service_tier : String?
cwd : String
instruction_sources : ArrayView[String]
approval_policy : AppApprovalPolicy
approvals_reviewer : AppApprovalsReviewer
sandbox : AppSandboxPolicy
reasoning_effort : AppReasoningEffort?
} derive(Debug)impl FromJson for AppThreadForkResponsefn AppThreadForkResponse::from_json(value : Json, path : JsonPath) -> AppThreadForkResponse raise JsonDecodeErrorpub(all) struct AppThreadGoal {
thread_id : String
objective : String
status : AppThreadGoalStatus
token_budget : Int64?
tokens_used : Int64
time_used_seconds : Int64
created_at : Int64
updated_at : Int64
} derive(Debug)impl FromJson for AppThreadGoalClearResponsefn AppThreadGoalClearResponse::from_json(value : Json, path : JsonPath) -> AppThreadGoalClearResponse raise JsonDecodeErrorimpl FromJson for AppThreadGoalGetResponsefn AppThreadGoalGetResponse::from_json(value : Json, path : JsonPath) -> AppThreadGoalGetResponse raise JsonDecodeErrorpub(all) struct AppThreadGoalSetParams {
thread_id : String
objective : String?
status : AppThreadGoalStatus?
token_budget : AppNullableInt64?
} derive(Debug)impl ToJson for AppThreadGoalSetParamsimpl FromJson for AppThreadGoalSetResponsefn AppThreadGoalSetResponse::from_json(value : Json, path : JsonPath) -> AppThreadGoalSetResponse raise JsonDecodeErrorpub(all) enum AppThreadGoalStatus {
AppThreadGoalActive
AppThreadGoalPaused
AppThreadGoalBudgetLimited
AppThreadGoalComplete
} derive(Debug)impl ToJson for AppThreadGoalStatusimpl FromJson for AppThreadGoalStatusfn AppThreadGoalStatus::from_json(value : Json, path : JsonPath) -> AppThreadGoalStatus raise JsonDecodeErrorimpl ToJson for AppThreadInjectItemsParamspub enum AppThreadItem {
AppThreadUserMessageItem(id~ : String, content~ : ArrayView[AppThreadUserInput])
AppThreadHookPromptItem(id~ : String, fragments~ : ArrayView[AppHookPromptFragment])
AppThreadAgentMessageItem(id~ : String, text~ : String, phase~ : AppMessagePhase?, memory_citation~ : AppMemoryCitation?)
AppThreadPlanItem(id~ : String, text~ : String)
AppThreadReasoningItem(id~ : String, summary~ : ArrayView[String], content~ : ArrayView[String])
AppThreadCommandExecutionItem(id~ : String, command~ : String, cwd~ : String, process_id~ : String?, source~ : AppThreadCommandExecutionSource, status~ : AppThreadCommandExecutionStatus, command_actions~ : ArrayView[AppCommandAction], aggregated_output~ : String?, exit_code~ : Int?, duration_ms~ : Int64?)
AppThreadFileChangeItem(id~ : String, changes~ : ArrayView[AppThreadFileUpdateChange], status~ : AppThreadPatchApplyStatus)
AppThreadMcpToolCallItem(id~ : String, server~ : String, tool~ : String, status~ : AppThreadMcpToolCallStatus, arguments~ : Json, mcp_app_resource_uri~ : String?, result~ : AppThreadMcpToolCallResult?, error~ : AppThreadMcpToolCallError?, duration_ms~ : Int64?)
AppThreadDynamicToolCallItem(id~ : String, tool_namespace~ : String?, tool~ : String, arguments~ : Json, status~ : AppThreadDynamicToolCallStatus, content_items~ : ArrayView[AppDynamicToolCallOutputContentItem]?, success~ : Bool?, duration_ms~ : Int64?)
AppThreadCollabAgentToolCallItem(id~ : String, tool~ : AppThreadCollabAgentTool, status~ : AppThreadCollabAgentToolCallStatus, sender_thread_id~ : String, receiver_thread_ids~ : ArrayView[String], prompt~ : String?, model~ : String?, reasoning_effort~ : AppReasoningEffort?, agents_states~ : Map[String, AppThreadCollabAgentState])
AppThreadWebSearchItem(id~ : String, query~ : String, action~ : AppWebSearchAction?)
AppThreadImageViewItem(id~ : String, path~ : String)
AppThreadImageGenerationItem(id~ : String, status~ : String, revised_prompt~ : String?, result~ : String, saved_path~ : String?)
AppThreadEnteredReviewModeItem(id~ : String, review~ : String)
AppThreadExitedReviewModeItem(id~ : String, review~ : String)
AppThreadContextCompactionItem(id~ : String)
} derive(Debug)pub struct AppThreadItemEvent {
thread_id : String
turn_id : String
app_item : AppThreadItem
item : ThreadItem?
raw_item : Json
timestamp_ms : Int64
} derive(Debug)impl FromJson for AppThreadItemEventfn AppThreadItemEvent::from_json(value : Json, path : JsonPath) -> AppThreadItemEvent raise JsonDecodeErrorimpl ToJson for AppThreadListCwdpub struct AppThreadListParams {
cursor : String?
limit : UInt?
sort_key : AppThreadSortKey?
sort_direction : AppSortDirection?
model_providers : Array[String]?
source_kinds : Array[AppThreadSourceKind]?
archived : Bool?
cwd : AppThreadListCwd?
use_state_db_only : Bool?
search_term : String?
} derive(Debug)impl ToJson for AppThreadListParamsfn AppThreadListParams::new(cursor? : String, limit? : UInt, sort_key? : AppThreadSortKey, sort_direction? : AppSortDirection, model_providers? : Array[String], source_kinds? : Array[AppThreadSourceKind], archived? : Bool, cwd? : AppThreadListCwd, use_state_db_only? : Bool, search_term? : String) -> AppThreadListParamsimpl FromJson for AppThreadListResponsefn AppThreadListResponse::from_json(value : Json, path : JsonPath) -> AppThreadListResponse raise JsonDecodeErrorimpl ToJson for AppThreadLoadedListParamsimpl FromJson for AppThreadLoadedListResponsefn AppThreadLoadedListResponse::from_json(value : Json, path : JsonPath) -> AppThreadLoadedListResponse raise JsonDecodeErrorimpl FromJson for AppThreadMcpToolCallErrorfn AppThreadMcpToolCallError::from_json(value : Json, path : JsonPath) -> AppThreadMcpToolCallError raise JsonDecodeErrorimpl FromJson for AppThreadMcpToolCallResultfn AppThreadMcpToolCallResult::from_json(value : Json, path : JsonPath) -> AppThreadMcpToolCallResult raise JsonDecodeErrorpub enum AppThreadMcpToolCallStatus {
AppThreadMcpInProgress
AppThreadMcpCompleted
AppThreadMcpFailed
} derive(Debug)impl FromJson for AppThreadMcpToolCallStatusfn AppThreadMcpToolCallStatus::from_json(value : Json, path : JsonPath) -> AppThreadMcpToolCallStatus raise JsonDecodeErrorpub(all) struct AppThreadMemoryModeSetParams {
thread_id : String
mode : AppThreadMemoryMode
} derive(Debug)impl ToJson for AppThreadMemoryModeSetParamspub(all) struct AppThreadMetadataGitInfoUpdateParams {
sha : AppNullableString?
branch : AppNullableString?
origin_url : AppNullableString?
} derive(Debug)fn AppThreadMetadataGitInfoUpdateParams::to_json(params : AppThreadMetadataGitInfoUpdateParams) -> Jsonpub(all) struct AppThreadMetadataUpdateParams {
thread_id : String
git_info : AppThreadMetadataGitInfoUpdateParams?
} derive(Debug)impl ToJson for AppThreadMetadataUpdateParamsimpl FromJson for AppThreadMetadataUpdateResponsefn from_json(value : Json, path : JsonPath) -> AppThreadMetadataUpdateResponse raise JsonDecodeErrorfn AppThreadMetadataUpdateResponse::from_json(value : Json, path : JsonPath) -> AppThreadMetadataUpdateResponse raise JsonDecodeErrorpub enum AppThreadPatchApplyStatus {
AppThreadPatchInProgress
AppThreadPatchCompleted
AppThreadPatchFailed
AppThreadPatchDeclined
} derive(Debug)impl FromJson for AppThreadPatchApplyStatusfn AppThreadPatchApplyStatus::from_json(value : Json, path : JsonPath) -> AppThreadPatchApplyStatus raise JsonDecodeErrorpub enum AppThreadPatchChangeKind {
AppThreadPatchAdd
AppThreadPatchDelete
AppThreadPatchUpdate(move_path~ : String?)
} derive(Debug)impl FromJson for AppThreadPatchChangeKindfn AppThreadPatchChangeKind::from_json(value : Json, path : JsonPath) -> AppThreadPatchChangeKind raise JsonDecodeErrorimpl ToJson for AppThreadReadParamsimpl FromJson for AppThreadReadResponsefn AppThreadReadResponse::from_json(value : Json, path : JsonPath) -> AppThreadReadResponse raise JsonDecodeErrorpub(all) struct AppThreadRealtimeAppendAudioParams {
thread_id : String
audio : AppThreadRealtimeAudioChunk
} derive(Debug)impl ToJson for AppThreadRealtimeAppendAudioParamsimpl ToJson for AppThreadRealtimeAppendTextParamspub(all) struct AppThreadRealtimeAudioChunk {
data : String
sample_rate : UInt
num_channels : UInt
samples_per_channel : UInt?
item_id : String?
} derive(Debug)impl ToJson for AppThreadRealtimeAudioChunkimpl FromJson for AppThreadRealtimeAudioChunkfn AppThreadRealtimeAudioChunk::from_json(value : Json, path : JsonPath) -> AppThreadRealtimeAudioChunk raise JsonDecodeErrorfn from_json(value : Json, path : JsonPath) -> AppThreadRealtimeListVoicesResponse raise JsonDecodeErrorfn AppThreadRealtimeListVoicesResponse::from_json(value : Json, path : JsonPath) -> AppThreadRealtimeListVoicesResponse raise JsonDecodeErrorpub(all) struct AppThreadRealtimeStartParams {
thread_id : String
output_modality : AppRealtimeOutputModality
prompt : AppNullableString?
realtime_session_id : String?
transport : AppThreadRealtimeStartTransport?
voice : AppRealtimeVoice?
} derive(Debug)impl ToJson for AppThreadRealtimeStartParamspub(all) enum AppThreadRealtimeStartTransport {
AppThreadRealtimeWebsocket
AppThreadRealtimeWebrtc(sdp~ : String)
} derive(Debug)impl ToJson for AppThreadRealtimeStartTransportpub struct AppThreadResumeParams {
thread_id : String
model : String?
model_provider : String?
service_tier : AppNullableString?
cwd : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
sandbox : SandboxMode?
config : Map[String, Json]?
base_instructions : String?
developer_instructions : String?
personality : AppPersonality?
} derive(Debug)impl ToJson for AppThreadResumeParamsfn AppThreadResumeParams::new(thread_id : String, model? : String, model_provider? : String, service_tier? : AppNullableString, cwd? : String, approval_policy? : AppApprovalPolicy, approvals_reviewer? : AppApprovalsReviewer, sandbox? : SandboxMode, config? : Map[String, Json], base_instructions? : String, developer_instructions? : String, personality? : AppPersonality) -> AppThreadResumeParamspub struct AppThreadResumeResponse {
thread : AppThread
model : String
model_provider : String
service_tier : String?
cwd : String
instruction_sources : ArrayView[String]
approval_policy : AppApprovalPolicy
approvals_reviewer : AppApprovalsReviewer
sandbox : AppSandboxPolicy
reasoning_effort : AppReasoningEffort?
} derive(Debug)impl FromJson for AppThreadResumeResponsefn AppThreadResumeResponse::from_json(value : Json, path : JsonPath) -> AppThreadResumeResponse raise JsonDecodeErrorimpl ToJson for AppThreadRollbackParamsimpl FromJson for AppThreadRollbackResponsefn AppThreadRollbackResponse::from_json(value : Json, path : JsonPath) -> AppThreadRollbackResponse raise JsonDecodeErrorpub(all) struct AppThreadSection {
id : String
name : String
appearance : AppThreadSectionAppearance?
} derive(Debug)impl FromJson for AppThreadSectionfn AppThreadSection::from_json(value : Json, path : JsonPath) -> AppThreadSection raise JsonDecodeErrorimpl ToJson for AppThreadSectionAppearanceimpl FromJson for AppThreadSectionAppearancefn AppThreadSectionAppearance::from_json(value : Json, path : JsonPath) -> AppThreadSectionAppearance raise JsonDecodeErrorpub(all) enum AppThreadSectionAppearanceUpdate {
AppClearThreadSectionAppearance
AppSetThreadSectionAppearance(AppThreadSectionAppearance)
} derive(Debug)impl ToJson for AppThreadSectionAppearanceUpdatepub(all) struct AppThreadSectionCreateParams {
name : String
appearance : AppThreadSectionAppearanceUpdate?
} derive(Debug)impl ToJson for AppThreadSectionCreateParamsfn AppThreadSectionCreateParams::new(name : String, appearance? : AppThreadSectionAppearanceUpdate) -> AppThreadSectionCreateParamsimpl ToJson for AppThreadSectionDeleteParamsimpl ToJson for AppThreadSectionListParamspub struct AppThreadSectionListResponse {
data : ArrayView[AppThreadSection]
next_cursor : String?
} derive(Debug)impl FromJson for AppThreadSectionListResponsefn AppThreadSectionListResponse::from_json(value : Json, path : JsonPath) -> AppThreadSectionListResponse raise JsonDecodeErrorpub(all) struct AppThreadSectionMoveParams {
thread_id : String
section_id : AppNullableString
before_thread_id : AppNullableString?
} derive(Debug)impl ToJson for AppThreadSectionMoveParamsimpl FromJson for AppThreadSectionResponsefn AppThreadSectionResponse::from_json(value : Json, path : JsonPath) -> AppThreadSectionResponse raise JsonDecodeErrorpub(all) struct AppThreadSectionUpdateParams {
section_id : String
name : String
appearance : AppThreadSectionAppearanceUpdate?
} derive(Debug)impl ToJson for AppThreadSectionUpdateParamsimpl ToJson for AppThreadSetNameParamsimpl ToJson for AppThreadShellCommandParamspub(all) enum AppThreadSourceKind {
SourceCli
SourceVscode
SourceExec
SourceAppServer
SourceSubAgent
SourceSubAgentReview
SourceSubAgentCompact
SourceSubAgentThreadSpawn
SourceSubAgentOther
SourceUnknown
} derive(Debug)pub struct AppThreadStartParams {
model : String?
model_provider : String?
service_tier : AppNullableString?
cwd : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
sandbox : SandboxMode?
config : Map[String, Json]?
service_name : String?
base_instructions : String?
developer_instructions : String?
personality : AppPersonality?
ephemeral : Bool?
session_start_source : AppThreadStartSource?
thread_source : String?
} derive(Debug)impl ToJson for AppThreadStartParamsfn AppThreadStartParams::new(model? : String, model_provider? : String, service_tier? : AppNullableString, cwd? : String, approval_policy? : AppApprovalPolicy, approvals_reviewer? : AppApprovalsReviewer, sandbox? : SandboxMode, config? : Map[String, Json], service_name? : String, base_instructions? : String, developer_instructions? : String, personality? : AppPersonality, ephemeral? : Bool, session_start_source? : AppThreadStartSource, thread_source? : String) -> AppThreadStartParamspub struct AppThreadStartResponse {
thread : AppThread
model : String
model_provider : String
service_tier : String?
cwd : String
instruction_sources : ArrayView[String]
approval_policy : AppApprovalPolicy
approvals_reviewer : AppApprovalsReviewer
sandbox : AppSandboxPolicy
reasoning_effort : AppReasoningEffort?
} derive(Debug)impl FromJson for AppThreadStartResponsefn AppThreadStartResponse::from_json(value : Json, path : JsonPath) -> AppThreadStartResponse raise JsonDecodeErrorpub enum AppThreadStatus {
ThreadNotLoaded
ThreadIdle
ThreadSystemError
ThreadActive(active_flags~ : ArrayView[AppThreadActiveFlag])
} derive(Debug)impl FromJson for AppThreadStatusfn AppThreadStatus::from_json(value : Json, path : JsonPath) -> AppThreadStatus raise JsonDecodeErrorpub struct AppThreadTokenUsage {
total : AppTokenUsageBreakdown
last : AppTokenUsageBreakdown
model_context_window : Int64?
} derive(Debug)impl FromJson for AppThreadTokenUsagefn AppThreadTokenUsage::from_json(value : Json, path : JsonPath) -> AppThreadTokenUsage raise JsonDecodeErrorpub(all) struct AppThreadTurnsListParams {
thread_id : String
cursor : String?
limit : UInt?
sort_direction : AppSortDirection?
} derive(Debug)impl ToJson for AppThreadTurnsListParamsimpl FromJson for AppThreadTurnsListResponsefn AppThreadTurnsListResponse::from_json(value : Json, path : JsonPath) -> AppThreadTurnsListResponse raise JsonDecodeErrorimpl FromJson for AppThreadUnsubscribeResponsefn AppThreadUnsubscribeResponse::from_json(value : Json, path : JsonPath) -> AppThreadUnsubscribeResponse raise JsonDecodeErrorpub(all) enum AppThreadUnsubscribeStatus {
AppThreadNotLoaded
AppThreadNotSubscribed
AppThreadUnsubscribed
} derive(Debug)impl FromJson for AppThreadUnsubscribeStatusfn AppThreadUnsubscribeStatus::from_json(value : Json, path : JsonPath) -> AppThreadUnsubscribeStatus raise JsonDecodeErrorpub enum AppThreadUserInput {
AppThreadInputText(text~ : String, text_elements~ : ArrayView[AppTextElement])
AppThreadInputImage(url~ : String, detail~ : AppImageDetail?)
AppThreadInputLocalImage(path~ : String, detail~ : AppImageDetail?)
AppThreadInputAudio(url~ : String)
AppThreadInputLocalAudio(path~ : String)
AppThreadInputSkill(name~ : String, path~ : String)
AppThreadInputMention(name~ : String, path~ : String)
} derive(Debug)impl FromJson for AppThreadUserInputfn AppThreadUserInput::from_json(value : Json, path : JsonPath) -> AppThreadUserInput raise JsonDecodeErrorpub struct AppTokenUsageBreakdown {
total_tokens : Int64
input_tokens : Int64
cached_input_tokens : Int64
output_tokens : Int64
reasoning_output_tokens : Int64
} derive(Debug)impl FromJson for AppTokenUsageBreakdownfn AppTokenUsageBreakdown::from_json(value : Json, path : JsonPath) -> AppTokenUsageBreakdown raise JsonDecodeErrorpub enum AppToolApproval {
AppToolApprovalAuto
AppToolApprovalPrompt
AppToolApprovalApprove
} derive(Debug)impl FromJson for AppToolApprovalfn AppToolApproval::from_json(value : Json, path : JsonPath) -> AppToolApproval raise JsonDecodeErrorfn AppToolRequestUserInputOption::from_json(Json, JsonPath) -> AppToolRequestUserInputOption raise JsonDecodeErrorpub(all) struct AppToolRequestUserInputQuestion {
id : String
header : String
question : String
is_other : Bool
is_secret : Bool
options : ArrayView[AppToolRequestUserInputOption]?
} derive(Debug)impl FromJson for AppToolRequestUserInputQuestionfn from_json(value : Json, path : JsonPath) -> AppToolRequestUserInputQuestion raise JsonDecodeErrorfn AppToolRequestUserInputQuestion::from_json(value : Json, path : JsonPath) -> AppToolRequestUserInputQuestion raise JsonDecodeErrorpub(all) struct AppToolRequestUserInputRequest {
thread_id : String
turn_id : String
item_id : String
questions : ArrayView[AppToolRequestUserInputQuestion]
is_blocking : Bool
auto_resolution_ms : Int64?
// private fields
} derive(Debug)impl FromJson for AppToolRequestUserInputRequestfn AppToolRequestUserInputRequest::from_json(value : Json, path : JsonPath) -> AppToolRequestUserInputRequest raise JsonDecodeErrorpub struct AppTurn {
id : String
items : ArrayView[AppThreadItem]
status : AppTurnStatus
error : AppTurnError?
started_at : Int64?
completed_at : Int64?
duration_ms : Int64?
// private fields
} derive(Debug)pub struct AppTurnError {
message : String
codex_error_info : AppCodexErrorInfo?
additional_details : String?
// private fields
} derive(Debug)impl ToJson for AppTurnInterruptParamsimpl FromJson for AppTurnPlanStepfn AppTurnPlanStep::from_json(value : Json, path : JsonPath) -> AppTurnPlanStep raise JsonDecodeErrorpub(all) enum AppTurnPlanStepStatus {
AppTurnPlanPending
AppTurnPlanInProgress
AppTurnPlanCompleted
} derive(Debug)impl FromJson for AppTurnPlanStepStatusfn AppTurnPlanStepStatus::from_json(value : Json, path : JsonPath) -> AppTurnPlanStepStatus raise JsonDecodeErrorpub struct AppTurnStartOptions {
client_user_message_id : String?
cwd : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
sandbox_policy : AppSandboxPolicy?
model : String?
service_tier : AppNullableString?
effort : AppReasoningEffort?
summary : AppReasoningSummary?
personality : AppPersonality?
output_schema : Json?
} derive(Default, Debug)fn AppTurnStartOptions::new(client_user_message_id? : String, cwd? : String, approval_policy? : AppApprovalPolicy, approvals_reviewer? : AppApprovalsReviewer, sandbox_policy? : AppSandboxPolicy, model? : String, service_tier? : AppNullableString, effort? : AppReasoningEffort, summary? : AppReasoningSummary, personality? : AppPersonality, output_schema? : Json) -> AppTurnStartOptionspub struct AppTurnStartParams {
thread_id : String
client_user_message_id : String?
input : Array[AppUserInput]
cwd : String?
approval_policy : AppApprovalPolicy?
approvals_reviewer : AppApprovalsReviewer?
sandbox_policy : AppSandboxPolicy?
model : String?
service_tier : AppNullableString?
effort : AppReasoningEffort?
summary : AppReasoningSummary?
personality : AppPersonality?
output_schema : Json?
} derive(Debug)impl ToJson for AppTurnStartParamsfn AppTurnStartParams::new(thread_id : String, input : Array[AppUserInput], client_user_message_id? : String, cwd? : String, approval_policy? : AppApprovalPolicy, approvals_reviewer? : AppApprovalsReviewer, sandbox_policy? : AppSandboxPolicy, model? : String, service_tier? : AppNullableString, effort? : AppReasoningEffort, summary? : AppReasoningSummary, personality? : AppPersonality, output_schema? : Json) -> AppTurnStartParamsimpl FromJson for AppTurnStartResponsefn AppTurnStartResponse::from_json(value : Json, path : JsonPath) -> AppTurnStartResponse raise JsonDecodeErrorpub struct AppTurnSteerParams {
thread_id : String
client_user_message_id : String?
input : Array[AppUserInput]
expected_turn_id : String
} derive(Debug)impl ToJson for AppTurnSteerParamsfn AppTurnSteerParams::new(thread_id : String, input : Array[AppUserInput], expected_turn_id : String, client_user_message_id? : String) -> AppTurnSteerParamsimpl FromJson for AppTurnSteerResponsefn AppTurnSteerResponse::from_json(value : Json, path : JsonPath) -> AppTurnSteerResponse raise JsonDecodeErrorpub struct AppTurnStream {
thread_id : String
turn_id : String
// private fields
}pub(all) enum AppUserInput {
AppInputText(text~ : String)
AppInputTextWithElements(text~ : String, text_elements~ : Array[AppTextElement])
AppInputImage(url~ : String)
AppInputImageWithDetail(url~ : String, detail~ : AppImageDetail)
AppInputLocalImage(path~ : String)
AppInputLocalImageWithDetail(path~ : String, detail~ : AppImageDetail)
AppInputAudio(url~ : String)
AppInputLocalAudio(path~ : String)
AppInputSkill(name~ : String, path~ : String)
AppInputMention(name~ : String, path~ : String)
} derive(Debug)impl ToJson for AppUserInputimpl FromJson for AppWebSearchActionfn AppWebSearchAction::from_json(value : Json, path : JsonPath) -> AppWebSearchAction raise JsonDecodeErrorpub enum AppWebSearchContextSize {
AppWebSearchContextLow
AppWebSearchContextMedium
AppWebSearchContextHigh
} derive(Debug)impl FromJson for AppWebSearchContextSizefn AppWebSearchContextSize::from_json(value : Json, path : JsonPath) -> AppWebSearchContextSize raise JsonDecodeErrorpub struct AppWebSearchLocation {
country : String?
region : String?
city : String?
timezone : String?
} derive(Debug)impl FromJson for AppWebSearchLocationfn AppWebSearchLocation::from_json(value : Json, path : JsonPath) -> AppWebSearchLocation raise JsonDecodeErrorimpl FromJson for AppWebSearchModefn AppWebSearchMode::from_json(value : Json, path : JsonPath) -> AppWebSearchMode raise JsonDecodeErrorpub struct AppWebSearchToolConfig {
context_size : AppWebSearchContextSize?
allowed_domains : ArrayView[String]?
location : AppWebSearchLocation?
} derive(Debug)impl FromJson for AppWebSearchToolConfigfn AppWebSearchToolConfig::from_json(value : Json, path : JsonPath) -> AppWebSearchToolConfig raise JsonDecodeErrorpub(all) enum AppWindowsSandboxSetupMode {
AppWindowsSandboxElevated
AppWindowsSandboxUnelevated
} derive(Debug)impl ToJson for AppWindowsSandboxSetupModeimpl FromJson for AppWindowsSandboxSetupModefn AppWindowsSandboxSetupMode::from_json(value : Json, path : JsonPath) -> AppWindowsSandboxSetupMode raise JsonDecodeErrorpub(all) struct AppWindowsSandboxSetupStartParams {
mode : AppWindowsSandboxSetupMode
cwd : String?
} derive(Debug)impl ToJson for AppWindowsSandboxSetupStartParamsfn from_json(value : Json, path : JsonPath) -> AppWindowsSandboxSetupStartResponse raise JsonDecodeErrorfn AppWindowsSandboxSetupStartResponse::from_json(value : Json, path : JsonPath) -> AppWindowsSandboxSetupStartResponse raise JsonDecodeErrorpub(all) enum ApprovalMode {
Never
OnRequest
OnFailure
Untrusted
}impl Show for ApprovalModetype Codexasync fn[R] Codex::with_app_server(self : Codex, options? : AppServerOptions, request_handler? : async (AppServerRequest) -> AppServerResponse, body : async (CodexAppConnection) -> R) -> Rasync fn[R] Codex::with_app_server_session(self : Codex, options? : AppServerOptions, request_handler? : async (AppServerRequest) -> AppServerResponse, body : async (CodexAppSession) -> R) -> Rtype CodexAppConnectionasync fn CodexAppConnection::account_login_cancel(self : CodexAppConnection, params : AppCancelLoginAccountParams) -> AppAccountLoginCancelResponseasync fn CodexAppConnection::account_login_start(self : CodexAppConnection, params : AppLoginAccountParams) -> AppAccountLoginStartResponseasync fn CodexAppConnection::account_rate_limits_read(self : CodexAppConnection) -> AppAccountRateLimitsReadResponseasync fn CodexAppConnection::account_read(self : CodexAppConnection, params : AppAccountReadParams) -> AppAccountReadResponseasync fn CodexAppConnection::account_send_add_credits_nudge_email(self : CodexAppConnection, params : AppSendAddCreditsNudgeEmailParams) -> AppAccountSendAddCreditsNudgeEmailResponseasync fn CodexAppConnection::app_list(self : CodexAppConnection, params? : AppListParams) -> AppListResponseasync fn CodexAppConnection::collaboration_mode_list(self : CodexAppConnection) -> AppCollaborationModeListResponseasync fn CodexAppConnection::command_exec(self : CodexAppConnection, params : AppCommandExecParams) -> AppCommandExecResponseasync fn CodexAppConnection::command_exec_resize(self : CodexAppConnection, params : AppCommandExecResizeParams) -> Unitasync fn CodexAppConnection::command_exec_terminate(self : CodexAppConnection, params : AppCommandExecProcessParams) -> Unitasync fn CodexAppConnection::command_exec_write(self : CodexAppConnection, params : AppCommandExecWriteParams) -> Unitasync fn CodexAppConnection::config_batch_write(self : CodexAppConnection, params : AppConfigBatchWriteParams) -> AppConfigBatchWriteResponseasync fn CodexAppConnection::config_read(self : CodexAppConnection, params : AppConfigReadParams) -> AppConfigReadResponseasync fn CodexAppConnection::config_requirements_read(self : CodexAppConnection) -> AppConfigRequirementsReadResponseasync fn CodexAppConnection::config_value_write(self : CodexAppConnection, params : AppConfigValueWriteParams) -> AppConfigValueWriteResponseasync fn CodexAppConnection::experimental_feature_enablement_set(self : CodexAppConnection, params : AppExperimentalFeatureEnablementSetParams) -> AppExperimentalFeatureEnablementSetResponseasync fn CodexAppConnection::experimental_feature_list(self : CodexAppConnection, params : AppCursorLimitParams) -> AppExperimentalFeatureListResponseasync fn CodexAppConnection::external_agent_config_detect(self : CodexAppConnection, params : AppExternalAgentConfigDetectParams) -> AppExternalAgentConfigDetectResponseasync fn CodexAppConnection::external_agent_config_import(self : CodexAppConnection, params : AppExternalAgentConfigImportParams) -> Unitasync fn CodexAppConnection::feedback_upload(self : CodexAppConnection, params : AppFeedbackUploadParams) -> AppFeedbackUploadResponseasync fn CodexAppConnection::fs_create_directory(self : CodexAppConnection, params : AppFsCreateDirectoryParams) -> Unitasync fn CodexAppConnection::fs_get_metadata(self : CodexAppConnection, params : AppFsPathParams) -> AppFsGetMetadataResponseasync fn CodexAppConnection::fs_read_directory(self : CodexAppConnection, params : AppFsPathParams) -> AppFsReadDirectoryResponseasync fn CodexAppConnection::fs_read_file(self : CodexAppConnection, params : AppFsPathParams) -> AppFsReadFileResponseasync fn CodexAppConnection::fs_remove(self : CodexAppConnection, params : AppFsRemoveParams) -> Unitasync fn CodexAppConnection::fs_unwatch(self : CodexAppConnection, params : AppFsUnwatchParams) -> Unitasync fn CodexAppConnection::fs_watch(self : CodexAppConnection, params : AppFsWatchParams) -> AppFsWatchResponseasync fn CodexAppConnection::fs_write_file(self : CodexAppConnection, params : AppFsWriteFileParams) -> Unitasync fn CodexAppConnection::fuzzy_file_search(self : CodexAppConnection, params : AppFuzzyFileSearchParams) -> AppFuzzyFileSearchResponseasync fn CodexAppConnection::fuzzy_file_search_session_start(self : CodexAppConnection, params : AppFuzzyFileSearchSessionStartParams) -> Unitasync fn CodexAppConnection::fuzzy_file_search_session_stop(self : CodexAppConnection, params : AppFuzzyFileSearchSessionStopParams) -> Unitasync fn CodexAppConnection::fuzzy_file_search_session_update(self : CodexAppConnection, params : AppFuzzyFileSearchSessionUpdateParams) -> Unitasync fn CodexAppConnection::hooks_list(self : CodexAppConnection, params : AppHooksListParams) -> AppHooksListResponseasync fn CodexAppConnection::marketplace_add(self : CodexAppConnection, params : AppMarketplaceAddParams) -> AppMarketplaceAddResponseasync fn CodexAppConnection::marketplace_remove(self : CodexAppConnection, params : AppMarketplaceRemoveParams) -> AppMarketplaceRemoveResponseasync fn CodexAppConnection::marketplace_upgrade(self : CodexAppConnection, params : AppMarketplaceUpgradeParams) -> AppMarketplaceUpgradeResponseasync fn CodexAppConnection::mcp_server_oauth_login(self : CodexAppConnection, params : AppMcpServerOauthLoginParams) -> AppMcpServerOauthLoginResponseasync fn CodexAppConnection::mcp_server_resource_read(self : CodexAppConnection, params : AppMcpResourceReadParams) -> AppMcpServerResourceReadResponseasync fn CodexAppConnection::mcp_server_status_list(self : CodexAppConnection, params : AppMcpServerStatusListParams) -> AppMcpServerStatusListResponseasync fn CodexAppConnection::mcp_server_tool_call(self : CodexAppConnection, params : AppMcpServerToolCallParams) -> AppMcpServerToolCallResponseasync fn CodexAppConnection::mock_experimental_method(self : CodexAppConnection, params : AppMockExperimentalMethodParams) -> AppMockExperimentalMethodResponseasync fn CodexAppConnection::model_list(self : CodexAppConnection, params? : AppModelListParams) -> AppModelListResponseasync fn CodexAppConnection::model_provider_capabilities_read(self : CodexAppConnection) -> AppModelProviderCapabilitiesReadResponseasync fn CodexAppConnection::notify(self : CodexAppConnection, rpc_method : String, params? : Json) -> Unitasync fn CodexAppConnection::plugin_install(self : CodexAppConnection, params : AppPluginInstallParams) -> AppPluginInstallResponseasync fn CodexAppConnection::plugin_list(self : CodexAppConnection, params : AppPluginListParams) -> AppPluginListResponseasync fn CodexAppConnection::plugin_read(self : CodexAppConnection, params : AppPluginReadParams) -> AppPluginReadResponseasync fn CodexAppConnection::plugin_uninstall(self : CodexAppConnection, params : AppPluginUninstallParams) -> Unitasync fn CodexAppConnection::request(self : CodexAppConnection, rpc_method : String, params? : Json) -> Jsonasync fn CodexAppConnection::review_start(self : CodexAppConnection, params : AppReviewStartParams) -> AppReviewStartResponseasync fn CodexAppConnection::skills_config_write(self : CodexAppConnection, params : AppSkillsConfigWriteParams) -> AppSkillsConfigWriteResponseasync fn CodexAppConnection::skills_list(self : CodexAppConnection, params? : AppSkillsListParams) -> AppSkillsListResponseasync fn CodexAppConnection::thread_approve_guardian_denied_action(self : CodexAppConnection, params : AppThreadApproveGuardianDeniedActionParams) -> Unitasync fn CodexAppConnection::thread_archive(self : CodexAppConnection, params : AppThreadIdParams) -> Unitasync fn CodexAppConnection::thread_background_terminals_clean(self : CodexAppConnection, params : AppThreadIdParams) -> Unitasync fn CodexAppConnection::thread_compact_start(self : CodexAppConnection, params : AppThreadIdParams) -> Unitasync fn CodexAppConnection::thread_decrement_elicitation(self : CodexAppConnection, params : AppThreadElicitationCounterParams) -> AppThreadElicitationCounterResponseasync fn CodexAppConnection::thread_delete(self : CodexAppConnection, params : AppThreadIdParams) -> Unitasync fn CodexAppConnection::thread_fork(self : CodexAppConnection, params : AppThreadForkParams) -> AppThreadForkResponseasync fn CodexAppConnection::thread_goal_clear(self : CodexAppConnection, params : AppThreadIdParams) -> AppThreadGoalClearResponseasync fn CodexAppConnection::thread_goal_get(self : CodexAppConnection, params : AppThreadIdParams) -> AppThreadGoalGetResponseasync fn CodexAppConnection::thread_goal_set(self : CodexAppConnection, params : AppThreadGoalSetParams) -> AppThreadGoalSetResponseasync fn CodexAppConnection::thread_increment_elicitation(self : CodexAppConnection, params : AppThreadElicitationCounterParams) -> AppThreadElicitationCounterResponseasync fn CodexAppConnection::thread_inject_items(self : CodexAppConnection, params : AppThreadInjectItemsParams) -> Unitasync fn CodexAppConnection::thread_list(self : CodexAppConnection, params? : AppThreadListParams) -> AppThreadListResponseasync fn CodexAppConnection::thread_loaded_list(self : CodexAppConnection, params? : AppThreadLoadedListParams) -> AppThreadLoadedListResponseasync fn CodexAppConnection::thread_memory_mode_set(self : CodexAppConnection, params : AppThreadMemoryModeSetParams) -> Unitasync fn CodexAppConnection::thread_metadata_update(self : CodexAppConnection, params : AppThreadMetadataUpdateParams) -> AppThreadMetadataUpdateResponseasync fn CodexAppConnection::thread_read(self : CodexAppConnection, params : AppThreadReadParams) -> AppThreadReadResponseasync fn CodexAppConnection::thread_realtime_append_audio(self : CodexAppConnection, params : AppThreadRealtimeAppendAudioParams) -> Unitasync fn CodexAppConnection::thread_realtime_append_text(self : CodexAppConnection, params : AppThreadRealtimeAppendTextParams) -> Unitasync fn CodexAppConnection::thread_realtime_list_voices(self : CodexAppConnection) -> AppThreadRealtimeListVoicesResponseasync fn CodexAppConnection::thread_realtime_start(self : CodexAppConnection, params : AppThreadRealtimeStartParams) -> Unitasync fn CodexAppConnection::thread_realtime_stop(self : CodexAppConnection, params : AppThreadIdParams) -> Unitasync fn CodexAppConnection::thread_resume(self : CodexAppConnection, params : AppThreadResumeParams) -> AppThreadResumeResponseasync fn CodexAppConnection::thread_rollback(self : CodexAppConnection, params : AppThreadRollbackParams) -> AppThreadRollbackResponseasync fn CodexAppConnection::thread_section_create(self : CodexAppConnection, params : AppThreadSectionCreateParams) -> AppThreadSectionResponseasync fn CodexAppConnection::thread_section_delete(self : CodexAppConnection, params : AppThreadSectionDeleteParams) -> Unitasync fn CodexAppConnection::thread_section_list(self : CodexAppConnection, params? : AppThreadSectionListParams) -> AppThreadSectionListResponseasync fn CodexAppConnection::thread_section_move(self : CodexAppConnection, params : AppThreadSectionMoveParams) -> Unitasync fn CodexAppConnection::thread_section_update(self : CodexAppConnection, params : AppThreadSectionUpdateParams) -> AppThreadSectionResponseasync fn CodexAppConnection::thread_set_name(self : CodexAppConnection, params : AppThreadSetNameParams) -> Unitasync fn CodexAppConnection::thread_shell_command(self : CodexAppConnection, params : AppThreadShellCommandParams) -> Unitasync fn CodexAppConnection::thread_start(self : CodexAppConnection, params? : AppThreadStartParams) -> AppThreadStartResponseasync fn CodexAppConnection::thread_turns_list(self : CodexAppConnection, params : AppThreadTurnsListParams) -> AppThreadTurnsListResponseasync fn CodexAppConnection::thread_unarchive(self : CodexAppConnection, params : AppThreadIdParams) -> AppThreadReadResponseasync fn CodexAppConnection::thread_unsubscribe(self : CodexAppConnection, params : AppThreadIdParams) -> AppThreadUnsubscribeResponseasync fn CodexAppConnection::turn_interrupt(self : CodexAppConnection, params : AppTurnInterruptParams) -> Unitasync fn CodexAppConnection::turn_start(self : CodexAppConnection, params : AppTurnStartParams) -> AppTurnStartResponseasync fn CodexAppConnection::turn_steer(self : CodexAppConnection, params : AppTurnSteerParams) -> AppTurnSteerResponseasync fn CodexAppConnection::windows_sandbox_setup_start(self : CodexAppConnection, params : AppWindowsSandboxSetupStartParams) -> AppWindowsSandboxSetupStartResponsepub struct CodexAppSession {
// private fields
}async fn CodexAppSession::account_login_cancel(self : CodexAppSession, params : AppCancelLoginAccountParams) -> AppAccountLoginCancelResponseasync fn CodexAppSession::account_login_start(self : CodexAppSession, params : AppLoginAccountParams) -> AppAccountLoginStartResponseasync fn CodexAppSession::account_rate_limits_read(self : CodexAppSession) -> AppAccountRateLimitsReadResponseasync fn CodexAppSession::account_read(self : CodexAppSession, params : AppAccountReadParams) -> AppAccountReadResponseasync fn CodexAppSession::account_send_add_credits_nudge_email(self : CodexAppSession, params : AppSendAddCreditsNudgeEmailParams) -> AppAccountSendAddCreditsNudgeEmailResponseasync fn CodexAppSession::app_list(self : CodexAppSession, params? : AppListParams) -> AppListResponseasync fn CodexAppSession::collaboration_mode_list(self : CodexAppSession) -> AppCollaborationModeListResponseasync fn CodexAppSession::command_exec(self : CodexAppSession, params : AppCommandExecParams) -> AppCommandExecResponseasync fn CodexAppSession::command_exec_resize(self : CodexAppSession, params : AppCommandExecResizeParams) -> Unitasync fn CodexAppSession::command_exec_terminate(self : CodexAppSession, params : AppCommandExecProcessParams) -> Unitasync fn CodexAppSession::command_exec_write(self : CodexAppSession, params : AppCommandExecWriteParams) -> Unitasync fn CodexAppSession::config_batch_write(self : CodexAppSession, params : AppConfigBatchWriteParams) -> AppConfigBatchWriteResponseasync fn CodexAppSession::config_read(self : CodexAppSession, params : AppConfigReadParams) -> AppConfigReadResponseasync fn CodexAppSession::config_requirements_read(self : CodexAppSession) -> AppConfigRequirementsReadResponseasync fn CodexAppSession::config_value_write(self : CodexAppSession, params : AppConfigValueWriteParams) -> AppConfigValueWriteResponseasync fn CodexAppSession::experimental_feature_enablement_set(self : CodexAppSession, params : AppExperimentalFeatureEnablementSetParams) -> AppExperimentalFeatureEnablementSetResponseasync fn CodexAppSession::experimental_feature_list(self : CodexAppSession, params : AppCursorLimitParams) -> AppExperimentalFeatureListResponseasync fn CodexAppSession::external_agent_config_detect(self : CodexAppSession, params : AppExternalAgentConfigDetectParams) -> AppExternalAgentConfigDetectResponseasync fn CodexAppSession::external_agent_config_import(self : CodexAppSession, params : AppExternalAgentConfigImportParams) -> Unitasync fn CodexAppSession::feedback_upload(self : CodexAppSession, params : AppFeedbackUploadParams) -> AppFeedbackUploadResponseasync fn CodexAppSession::fs_create_directory(self : CodexAppSession, params : AppFsCreateDirectoryParams) -> Unitasync fn CodexAppSession::fs_get_metadata(self : CodexAppSession, params : AppFsPathParams) -> AppFsGetMetadataResponseasync fn CodexAppSession::fs_read_directory(self : CodexAppSession, params : AppFsPathParams) -> AppFsReadDirectoryResponseasync fn CodexAppSession::fs_read_file(self : CodexAppSession, params : AppFsPathParams) -> AppFsReadFileResponseasync fn CodexAppSession::fs_watch(self : CodexAppSession, params : AppFsWatchParams) -> AppFsWatchResponseasync fn CodexAppSession::fs_write_file(self : CodexAppSession, params : AppFsWriteFileParams) -> Unitasync fn CodexAppSession::fuzzy_file_search(self : CodexAppSession, params : AppFuzzyFileSearchParams) -> AppFuzzyFileSearchResponseasync fn CodexAppSession::fuzzy_file_search_session_start(self : CodexAppSession, params : AppFuzzyFileSearchSessionStartParams) -> Unitasync fn CodexAppSession::fuzzy_file_search_session_stop(self : CodexAppSession, params : AppFuzzyFileSearchSessionStopParams) -> Unitasync fn CodexAppSession::fuzzy_file_search_session_update(self : CodexAppSession, params : AppFuzzyFileSearchSessionUpdateParams) -> Unitasync fn CodexAppSession::hooks_list(self : CodexAppSession, params : AppHooksListParams) -> AppHooksListResponseasync fn CodexAppSession::marketplace_add(self : CodexAppSession, params : AppMarketplaceAddParams) -> AppMarketplaceAddResponseasync fn CodexAppSession::marketplace_remove(self : CodexAppSession, params : AppMarketplaceRemoveParams) -> AppMarketplaceRemoveResponseasync fn CodexAppSession::marketplace_upgrade(self : CodexAppSession, params : AppMarketplaceUpgradeParams) -> AppMarketplaceUpgradeResponseasync fn CodexAppSession::mcp_server_oauth_login(self : CodexAppSession, params : AppMcpServerOauthLoginParams) -> AppMcpServerOauthLoginResponseasync fn CodexAppSession::mcp_server_resource_read(self : CodexAppSession, params : AppMcpResourceReadParams) -> AppMcpServerResourceReadResponseasync fn CodexAppSession::mcp_server_status_list(self : CodexAppSession, params : AppMcpServerStatusListParams) -> AppMcpServerStatusListResponseasync fn CodexAppSession::mcp_server_tool_call(self : CodexAppSession, params : AppMcpServerToolCallParams) -> AppMcpServerToolCallResponseasync fn CodexAppSession::mock_experimental_method(self : CodexAppSession, params : AppMockExperimentalMethodParams) -> AppMockExperimentalMethodResponseasync fn CodexAppSession::model_list(self : CodexAppSession, params? : AppModelListParams) -> AppModelListResponseasync fn CodexAppSession::model_provider_capabilities_read(self : CodexAppSession) -> AppModelProviderCapabilitiesReadResponseasync fn CodexAppSession::notify(self : CodexAppSession, rpc_method : String, params? : Json) -> Unitasync fn CodexAppSession::plugin_install(self : CodexAppSession, params : AppPluginInstallParams) -> AppPluginInstallResponseasync fn CodexAppSession::plugin_list(self : CodexAppSession, params : AppPluginListParams) -> AppPluginListResponseasync fn CodexAppSession::plugin_read(self : CodexAppSession, params : AppPluginReadParams) -> AppPluginReadResponseasync fn CodexAppSession::plugin_uninstall(self : CodexAppSession, params : AppPluginUninstallParams) -> Unitasync fn CodexAppSession::request(self : CodexAppSession, rpc_method : String, params? : Json) -> Jsonasync fn CodexAppSession::resume_thread(self : CodexAppSession, params : AppThreadResumeParams, request_handler? : async (AppServerRequest) -> AppServerResponse) -> CodexAppThreadasync fn CodexAppSession::review_start(self : CodexAppSession, params : AppReviewStartParams) -> AppReviewStartResponseasync fn CodexAppSession::skills_config_write(self : CodexAppSession, params : AppSkillsConfigWriteParams) -> AppSkillsConfigWriteResponseasync fn CodexAppSession::skills_list(self : CodexAppSession, params? : AppSkillsListParams) -> AppSkillsListResponseasync fn CodexAppSession::start_thread(self : CodexAppSession, params? : AppThreadStartParams, request_handler? : async (AppServerRequest) -> AppServerResponse) -> CodexAppThreadasync fn CodexAppSession::thread_approve_guardian_denied_action(self : CodexAppSession, params : AppThreadApproveGuardianDeniedActionParams) -> Unitasync fn CodexAppSession::thread_archive(self : CodexAppSession, params : AppThreadIdParams) -> Unitasync fn CodexAppSession::thread_background_terminals_clean(self : CodexAppSession, params : AppThreadIdParams) -> Unitasync fn CodexAppSession::thread_compact_start(self : CodexAppSession, params : AppThreadIdParams) -> Unitasync fn CodexAppSession::thread_decrement_elicitation(self : CodexAppSession, params : AppThreadElicitationCounterParams) -> AppThreadElicitationCounterResponseasync fn CodexAppSession::thread_fork(self : CodexAppSession, params : AppThreadForkParams) -> AppThreadForkResponseasync fn CodexAppSession::thread_goal_clear(self : CodexAppSession, params : AppThreadIdParams) -> AppThreadGoalClearResponseasync fn CodexAppSession::thread_goal_get(self : CodexAppSession, params : AppThreadIdParams) -> AppThreadGoalGetResponseasync fn CodexAppSession::thread_goal_set(self : CodexAppSession, params : AppThreadGoalSetParams) -> AppThreadGoalSetResponseasync fn CodexAppSession::thread_increment_elicitation(self : CodexAppSession, params : AppThreadElicitationCounterParams) -> AppThreadElicitationCounterResponseasync fn CodexAppSession::thread_inject_items(self : CodexAppSession, params : AppThreadInjectItemsParams) -> Unitasync fn CodexAppSession::thread_list(self : CodexAppSession, params? : AppThreadListParams) -> AppThreadListResponseasync fn CodexAppSession::thread_loaded_list(self : CodexAppSession, params? : AppThreadLoadedListParams) -> AppThreadLoadedListResponseasync fn CodexAppSession::thread_memory_mode_set(self : CodexAppSession, params : AppThreadMemoryModeSetParams) -> Unitasync fn CodexAppSession::thread_metadata_update(self : CodexAppSession, params : AppThreadMetadataUpdateParams) -> AppThreadMetadataUpdateResponseasync fn CodexAppSession::thread_read(self : CodexAppSession, params : AppThreadReadParams) -> AppThreadReadResponseasync fn CodexAppSession::thread_realtime_append_audio(self : CodexAppSession, params : AppThreadRealtimeAppendAudioParams) -> Unitasync fn CodexAppSession::thread_realtime_append_text(self : CodexAppSession, params : AppThreadRealtimeAppendTextParams) -> Unitasync fn CodexAppSession::thread_realtime_list_voices(self : CodexAppSession) -> AppThreadRealtimeListVoicesResponseasync fn CodexAppSession::thread_realtime_start(self : CodexAppSession, params : AppThreadRealtimeStartParams) -> Unitasync fn CodexAppSession::thread_realtime_stop(self : CodexAppSession, params : AppThreadIdParams) -> Unitasync fn CodexAppSession::thread_resume(self : CodexAppSession, params : AppThreadResumeParams) -> AppThreadResumeResponseasync fn CodexAppSession::thread_rollback(self : CodexAppSession, params : AppThreadRollbackParams) -> AppThreadRollbackResponseasync fn CodexAppSession::thread_section_create(self : CodexAppSession, params : AppThreadSectionCreateParams) -> AppThreadSectionResponseasync fn CodexAppSession::thread_section_delete(self : CodexAppSession, params : AppThreadSectionDeleteParams) -> Unitasync fn CodexAppSession::thread_section_list(self : CodexAppSession, params? : AppThreadSectionListParams) -> AppThreadSectionListResponseasync fn CodexAppSession::thread_section_move(self : CodexAppSession, params : AppThreadSectionMoveParams) -> Unitasync fn CodexAppSession::thread_section_update(self : CodexAppSession, params : AppThreadSectionUpdateParams) -> AppThreadSectionResponseasync fn CodexAppSession::thread_set_name(self : CodexAppSession, params : AppThreadSetNameParams) -> Unitasync fn CodexAppSession::thread_shell_command(self : CodexAppSession, params : AppThreadShellCommandParams) -> Unitasync fn CodexAppSession::thread_start(self : CodexAppSession, params? : AppThreadStartParams) -> AppThreadStartResponseasync fn CodexAppSession::thread_turns_list(self : CodexAppSession, params : AppThreadTurnsListParams) -> AppThreadTurnsListResponseasync fn CodexAppSession::thread_unarchive(self : CodexAppSession, params : AppThreadIdParams) -> AppThreadReadResponseasync fn CodexAppSession::thread_unsubscribe(self : CodexAppSession, params : AppThreadIdParams) -> AppThreadUnsubscribeResponseasync fn CodexAppSession::turn_interrupt(self : CodexAppSession, params : AppTurnInterruptParams) -> Unitasync fn CodexAppSession::turn_start(self : CodexAppSession, params : AppTurnStartParams) -> AppTurnStartResponseasync fn CodexAppSession::turn_steer(self : CodexAppSession, params : AppTurnSteerParams) -> AppTurnSteerResponseasync fn CodexAppSession::windows_sandbox_setup_start(self : CodexAppSession, params : AppWindowsSandboxSetupStartParams) -> AppWindowsSandboxSetupStartResponsepub struct CodexAppThread {
thread : AppThread
model : String
model_provider : String
service_tier : String?
cwd : String
instruction_sources : ArrayView[String]
approval_policy : AppApprovalPolicy
approvals_reviewer : AppApprovalsReviewer
sandbox : AppSandboxPolicy
reasoning_effort : AppReasoningEffort?
// private fields
}async fn CodexAppThread::read(self : CodexAppThread, include_turns? : Bool) -> AppThreadReadResponseasync fn CodexAppThread::run_streamed(self : CodexAppThread, input : Array[AppUserInput], options? : AppTurnStartOptions, request_handler? : async (AppServerRequest) -> AppServerResponse) -> AppTurnStreamfn CodexAppThread::set_request_handler(self : CodexAppThread, request_handler? : async (AppServerRequest) -> AppServerResponse) -> Unitasync fn CodexAppThread::start_turn(self : CodexAppThread, input : Array[AppUserInput], options? : AppTurnStartOptions) -> AppTurnStartResponsefn CodexOptions::new(codex_path_override? : String, base_url? : String, api_key? : String, config? : Map[String, Json], config_overrides? : Array[String], env? : Map[String, String]) -> CodexOptionsimpl ToJson for CollabAgentStateimpl FromJson for CollabAgentStatefn CollabAgentState::from_json(value : Json, path : JsonPath) -> CollabAgentState raise JsonDecodeErrorpub enum CollabAgentStatus {
PendingInit
Running
Interrupted
Completed
Errored
Shutdown
NotFound
} derive(Debug)impl Show for CollabAgentStatusimpl ToJson for CollabAgentStatusimpl FromJson for CollabAgentStatusfn CollabAgentStatus::from_json(value : Json, path : JsonPath) -> CollabAgentStatus raise JsonDecodeErrorimpl Show for CollabToolimpl ToJson for CollabToolimpl FromJson for CollabToolimpl Show for CollabToolCallStatusimpl ToJson for CollabToolCallStatusimpl FromJson for CollabToolCallStatusfn CollabToolCallStatus::from_json(value : Json, path : JsonPath) -> CollabToolCallStatus raise JsonDecodeErrorimpl Show for CommandExecutionStatusimpl ToJson for CommandExecutionStatusimpl FromJson for CommandExecutionStatusfn CommandExecutionStatus::from_json(value : Json, path : JsonPath) -> CommandExecutionStatus raise JsonDecodeErrorpub enum Event {
ThreadStarted(thread_id~ : String)
TurnStarted
TurnCompleted(Usage)
TurnFailed(ThreadError)
ItemStarted(ThreadItem)
ItemUpdated(ThreadItem)
ItemCompleted(ThreadItem)
ThreadErrorEvent(String)
}impl Show for FileUpdateChangeimpl ToJson for McpToolCallResultimpl FromJson for McpToolCallResultfn McpToolCallResult::from_json(value : Json, path : JsonPath) -> McpToolCallResult raise JsonDecodeErrorimpl Show for McpToolCallStatusimpl ToJson for McpToolCallStatusimpl FromJson for McpToolCallStatusfn McpToolCallStatus::from_json(value : Json, path : JsonPath) -> McpToolCallStatus raise JsonDecodeErrorpub(all) enum ModelReasoningEffort {
Minimal
Low
Medium
High
Xhigh
Max
Ultra
}impl Show for PatchApplyStatusimpl ToJson for PatchApplyStatusimpl FromJson for PatchApplyStatusfn PatchApplyStatus::from_json(value : Json, path : JsonPath) -> PatchApplyStatus raise JsonDecodeErrorimpl Show for PatchChangeKindimpl ToJson for PatchChangeKindimpl FromJson for PatchChangeKindfn PatchChangeKind::from_json(value : Json, path : JsonPath) -> PatchChangeKind raise JsonDecodeErrorimpl Show for SandboxModeimpl ToJson for SandboxModeimpl FromJson for SandboxModetype Threadasync fn[G] Thread::run_streamed(self : Thread, prompt : String, extra_input? : Array[UserInput], turn_options? : TurnOptions, taskgroup : TaskGroup[G]) -> StreamedTurnpub enum ThreadItem {
AgentMessageItem(id~ : String, text~ : String)
ReasoningItem(id~ : String, text~ : String)
CommandExecutionItem(id~ : String, command~ : String, aggregated_output~ : String, exit_code~ : Int?, status~ : CommandExecutionStatus)
FileChangeItem(id~ : String, changes~ : Array[FileUpdateChange], status~ : PatchApplyStatus)
McpToolCallItem(id~ : String, server~ : String, tool~ : String, status~ : McpToolCallStatus, arguments~ : Json?, result~ : Result[McpToolCallResult, String]?)
CollabToolCallItem(id~ : String, tool~ : CollabTool, sender_thread_id~ : String, receiver_thread_ids~ : Array[String], prompt~ : String?, agents_states~ : Map[String, CollabAgentState], status~ : CollabToolCallStatus)
WebSearchItem(id~ : String, query~ : String)
TodoListItem(id~ : String, items~ : Array[TodoItem])
ErrorItem(id~ : String, message~ : String)
} derive(Debug)fn ThreadOptions::new(model? : String, thread_source? : String, sandbox_mode? : SandboxMode, working_directory? : String, skip_git_repo_check? : Bool, model_reasoning_effort? : ModelReasoningEffort, network_access_enabled? : Bool, web_search_enabled? : Bool, web_search_mode? : WebSearchMode, approval_policy? : ApprovalMode, additional_directories? : Array[String]) -> ThreadOptions#alias(RunResult)
pub struct Turn {
items : Array[ThreadItem]
final_response : String
usage : Usage?
}pub struct Usage {
input_tokens : Int
cached_input_tokens : Int
cache_write_input_tokens : Int
output_tokens : Int
reasoning_output_tokens : Int
} derive(Debug)pub(all) enum WebSearchMode {
Disabled
Cached
Live
}impl Show for WebSearchMode