Skip to content

sbx_agents

sbx_agents

PermissionAction module-attribute 

PermissionAction = Literal['allow', 'ask', 'deny']

__all__ module-attribute 

__all__ = [
    "Agent",
    "Artifact",
    "CommandResult",
    "CodexAuth",
    "HttpMCP",
    "MCPServer",
    "PermissionAction",
    "PermissionPolicy",
    "RunArtifacts",
    "RunConfig",
    "RunResult",
    "Runner",
    "Skill",
    "StdioMCP",
]

Agent

backend instance-attribute 

backend: SkipValidation[AgentBackend]

capabilities class-attribute instance-attribute 

capabilities: list[object] = Field(default_factory=list)

env class-attribute instance-attribute 

env: dict[str, str] = Field(default_factory=dict)

instructions class-attribute instance-attribute 

instructions: str | None = None

mcp_servers class-attribute instance-attribute 

mcp_servers: list[MCPServer] = Field(default_factory=list)

metadata class-attribute instance-attribute 

metadata: dict[str, str] = Field(default_factory=dict)

model_config class-attribute instance-attribute 

model_config = ConfigDict(arbitrary_types_allowed=True)

name instance-attribute 

name: str

permission class-attribute instance-attribute 

permission: PermissionPolicy | None = None

skills class-attribute instance-attribute 

skills: list[Skill] = Field(default_factory=list)

strict class-attribute instance-attribute 

strict: bool = True

Artifact

kind class-attribute instance-attribute 

kind: str = 'file'

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

path instance-attribute 

path: Path

CodexAuth

env_var class-attribute instance-attribute 

env_var: str | None = None

method instance-attribute 

method: Literal[
    "openai_oauth",
    "openai_api_key_env",
    "host_chatgpt",
    "none",
]

refresh class-attribute instance-attribute 

refresh: bool = False

service class-attribute instance-attribute 

service: str = 'openai'

host_chatgpt classmethod 

host_chatgpt() -> CodexAuth

none classmethod 

none() -> CodexAuth

openai_api_key_env classmethod 

openai_api_key_env(
    env_var: str = "OPENAI_API_KEY",
    *,
    service: str = "openai",
) -> CodexAuth

openai_oauth classmethod 

openai_oauth(*, refresh: bool = False) -> CodexAuth

CommandResult

command class-attribute instance-attribute 

command: list[str] = Field(default_factory=list)

duration_ms class-attribute instance-attribute 

duration_ms: int | None = None

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

returncode instance-attribute 

returncode: int

stderr class-attribute instance-attribute 

stderr: str = ''

stdout class-attribute instance-attribute 

stdout: str = ''

HttpMCP

bearer_token_env_var class-attribute instance-attribute 

bearer_token_env_var: str | None = None

env_http_headers class-attribute instance-attribute 

env_http_headers: dict[str, str] = Field(
    default_factory=dict
)

headers class-attribute instance-attribute 

headers: dict[str, str] = Field(default_factory=dict)

oauth class-attribute instance-attribute 

oauth: dict[str, Any] | bool | None = None

scopes class-attribute instance-attribute 

scopes: list[str] = Field(default_factory=list)

type class-attribute instance-attribute 

type: str = 'http'

url instance-attribute 

url: str

MCPServer

disabled_tools class-attribute instance-attribute 

disabled_tools: list[str] = Field(default_factory=list)

enabled class-attribute instance-attribute 

enabled: bool = True

enabled_tools class-attribute instance-attribute 

enabled_tools: list[str] = Field(default_factory=list)

name instance-attribute 

name: str

required class-attribute instance-attribute 

required: bool = False

startup_timeout_sec class-attribute instance-attribute 

startup_timeout_sec: int | None = None

tool_timeout_sec class-attribute instance-attribute 

tool_timeout_sec: int | None = None

type instance-attribute 

type: str

PermissionPolicy

default class-attribute instance-attribute 

default: PermissionAction | None = None

tools class-attribute instance-attribute 

tools: dict[str, PermissionRule] = Field(
    default_factory=dict
)

to_opencode 

to_opencode() -> (
    PermissionAction | dict[str, PermissionRule]
)

RunArtifacts

artifacts class-attribute instance-attribute 

artifacts: list[Artifact] = Field(default_factory=list)

diff class-attribute instance-attribute 

diff: str | None = None

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

RunConfig

attachments class-attribute instance-attribute 

attachments: list[Path] = Field(default_factory=list)

continue_last class-attribute instance-attribute 

continue_last: bool = False

env class-attribute instance-attribute 

env: dict[str, str] = Field(default_factory=dict)

extra_args class-attribute instance-attribute 

extra_args: list[str] = Field(default_factory=list)

fork_session class-attribute instance-attribute 

fork_session: bool = False

forward_env class-attribute instance-attribute 

forward_env: list[str] = Field(default_factory=list)

json_events class-attribute instance-attribute 

json_events: bool = False

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

network class-attribute instance-attribute 

network: str | None = None

output_schema class-attribute instance-attribute 

output_schema: Path | dict[str, Any] | None = None

permission class-attribute instance-attribute 

permission: PermissionPolicy | None = None

remove_on_exit class-attribute instance-attribute 

remove_on_exit: bool = True

resume_session_id class-attribute instance-attribute 

resume_session_id: str | None = None

secret_env class-attribute instance-attribute 

secret_env: list[str] = Field(default_factory=list)

secrets class-attribute instance-attribute 

secrets: list[str] = Field(default_factory=list)

stream_events class-attribute instance-attribute 

stream_events: bool = False

stream_output class-attribute instance-attribute 

stream_output: bool = False

timeout_seconds class-attribute instance-attribute 

timeout_seconds: int | None = None

RunResult

agent_backend instance-attribute 

agent_backend: str

agent_name instance-attribute 

agent_name: str

artifacts class-attribute instance-attribute 

artifacts: list[Artifact] = Field(default_factory=list)

command instance-attribute 

command: list[str]

diff class-attribute instance-attribute 

diff: str | None = None

duration_ms class-attribute instance-attribute 

duration_ms: int | None = None

events class-attribute instance-attribute 

events: list[dict[str, Any]] = Field(default_factory=list)

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

output instance-attribute 

output: str

returncode instance-attribute 

returncode: int

sandbox_backend instance-attribute 

sandbox_backend: str

sandbox_name class-attribute instance-attribute 

sandbox_name: str | None = None

session_id class-attribute instance-attribute 

session_id: str | None = None

stderr instance-attribute 

stderr: str

stdout instance-attribute 

stdout: str

thread_id class-attribute instance-attribute 

thread_id: str | None = None

usage class-attribute instance-attribute 

usage: dict[str, Any] | None = None

from_parts classmethod 

from_parts(
    *,
    agent_name: str,
    agent_backend: str,
    sandbox_backend: str,
    sandbox_name: str | None,
    command_result: CommandResult,
    artifacts: RunArtifacts,
    events: list[dict[str, Any]] | None = None,
) -> RunResult

Runner 

Runner(
    agent: Agent,
    *,
    sandbox: SandboxBackend,
    run_config: RunConfig | None = None,
    default_prompt: str | None = None,
)

agent instance-attribute 

agent = agent

default_prompt instance-attribute 

default_prompt = default_prompt

run_config instance-attribute 

run_config = run_config

run_sync instance-attribute 

run_sync: Any

sandbox instance-attribute 

sandbox = sandbox

Skill

assets class-attribute instance-attribute 

assets: list[Path] = Field(default_factory=list)

compatibility class-attribute instance-attribute 

compatibility: str | None = None

description class-attribute instance-attribute 

description: str = ''

instructions instance-attribute 

instructions: str

license class-attribute instance-attribute 

license: str | None = None

metadata class-attribute instance-attribute 

metadata: dict[str, Any] = Field(default_factory=dict)

model_config class-attribute instance-attribute 

model_config = ConfigDict(arbitrary_types_allowed=True)

name instance-attribute 

name: str

path class-attribute instance-attribute 

path: Path | None = None

from_dir classmethod 

from_dir(path: str | Path) -> Skill

to_skill_md 

to_skill_md(*, frontmatter: bool = False) -> str

validate_opencode_name 

validate_opencode_name() -> None

StdioMCP

args class-attribute instance-attribute 

args: list[str] = Field(default_factory=list)

command instance-attribute 

command: str

cwd class-attribute instance-attribute 

cwd: Path | None = None

env class-attribute instance-attribute 

env: dict[str, str] = Field(default_factory=dict)

env_vars class-attribute instance-attribute 

env_vars: list[str | dict[str, Any]] = Field(
    default_factory=list
)

type class-attribute instance-attribute 

type: str = 'stdio'