claude-agent-sdk-python API reference

87 public APIs from claude-agent-sdk-python (anthropics/claude-agent-sdk-python) — 64 classes, 4 functions, 19 methods. Signatures extracted by static analysis of the actual source.

Repository: anthropics/claude-agent-sdk-python

Kind	Count
Classes	64
Functions	4
Methods	19

API list

classsrc.claude_agent_sdk.SdkMcpTool

Definition for an SDK MCP tool.

classsrc.claude_agent_sdk._errors.CLIConnectionError

Raised when unable to connect to Claude Code.

classsrc.claude_agent_sdk._errors.CLIJSONDecodeError

Raised when unable to decode JSON from CLI output.

classsrc.claude_agent_sdk._errors.ClaudeSDKError

Base exception for all Claude SDK errors.

classsrc.claude_agent_sdk._errors.ProcessError

Raised when the CLI process fails.

methodsrc.claude_agent_sdk._internal._task_compat.TaskHandle.cancel() -> None

Request cancellation of the wrapped task.

methodsrc.claude_agent_sdk._internal._task_compat.TaskHandle.wait() -> None

Wait for the task to finish.

classsrc.claude_agent_sdk._internal.client.InternalClient

Internal client implementation.

methodsrc.claude_agent_sdk._internal.query.Query.close() -> None

Close the query and transport.

methodsrc.claude_agent_sdk._internal.query.Query.get_mcp_status() -> dict[str, Any]

Get current MCP server connection status.

methodsrc.claude_agent_sdk._internal.query.Query.interrupt() -> None

Send interrupt control request.

methodsrc.claude_agent_sdk._internal.query.Query.reconnect_mcp_server(server_name:str) -> None

Reconnect a disconnected or failed MCP server.

methodsrc.claude_agent_sdk._internal.query.Query.set_model(model:str | None) -> None

Change the AI model.

methodsrc.claude_agent_sdk._internal.query.Query.set_permission_mode(mode:PermissionMode) -> None

Change permission mode.

methodsrc.claude_agent_sdk._internal.query.Query.spawn_task(coro:Any) -> TaskHandle

Spawn a child task that will be cancelled on close().

methodsrc.claude_agent_sdk._internal.query.Query.start() -> None

Start reading messages from transport.

methodsrc.claude_agent_sdk._internal.query.Query.stop_task(task_id:str) -> None

Stop a running task.

methodsrc.claude_agent_sdk._internal.query.Query.stream_input(stream:AsyncIterable[dict[str, Any]]) -> None

Stream input messages to transport.

methodsrc.claude_agent_sdk._internal.query.Query.toggle_mcp_server(server_name:str, enabled:bool) -> None

Enable or disable an MCP server.

classsrc.claude_agent_sdk._internal.session_mutations.ForkSessionResult

Result of a fork operation.

func

src.claude_agent_sdk._internal.session_mutations.tag_session(session_id:str, tag:str | None, directory:str | None=None) -> None

Tag a session.

func

src.claude_agent_sdk._internal.sessions.get_session_info(session_id:str, directory:str | None=None) -> SDKSessionInfo | None

Reads metadata for a single session by ID.

classsrc.claude_agent_sdk._internal.transport.Transport

Abstract transport for Claude communication.

methodsrc.claude_agent_sdk._internal.transport.Transport.write(data:str) -> None

Write raw data to the transport.

funcsrc.claude_agent_sdk.call_tool(name:str, arguments:dict[str, Any]) -> Any

Execute a tool by name with given arguments.

funcsrc.claude_agent_sdk.list_tools() -> list[Tool]

Return the list of available tools.

classsrc.claude_agent_sdk.types.AgentDefinition

Agent definition configuration.

classsrc.claude_agent_sdk.types.AssistantMessage

Assistant message with content blocks.

classsrc.claude_agent_sdk.types.AsyncHookJSONOutput

Async hook output that defers hook execution.

classsrc.claude_agent_sdk.types.BaseHookInput

Base hook input fields present across many hook events.

classsrc.claude_agent_sdk.types.ClaudeAgentOptions

Query options for Claude SDK.

classsrc.claude_agent_sdk.types.HookContext

Context information for hook callbacks.

classsrc.claude_agent_sdk.types.HookMatcher

Hook matcher configuration.

classsrc.claude_agent_sdk.types.McpClaudeAIProxyServerConfig

Claude.ai proxy MCP server config.

classsrc.claude_agent_sdk.types.McpHttpServerConfig

MCP HTTP server configuration.

classsrc.claude_agent_sdk.types.McpSSEServerConfig

MCP SSE server configuration.

classsrc.claude_agent_sdk.types.McpSdkServerConfig

SDK MCP server configuration.

classsrc.claude_agent_sdk.types.McpServerStatus

Status information for an MCP server connection.

classsrc.claude_agent_sdk.types.McpStatusResponse

Response from `ClaudeSDKClient.get_mcp_status()`.

classsrc.claude_agent_sdk.types.McpStdioServerConfig

MCP stdio server configuration.

classsrc.claude_agent_sdk.types.McpToolAnnotations

Tool annotations as returned in MCP server status.

classsrc.claude_agent_sdk.types.McpToolInfo

Information about a tool provided by an MCP server.

classsrc.claude_agent_sdk.types.ModelUsage

Per-model token usage and cost breakdown.

classsrc.claude_agent_sdk.types.NotificationHookInput

Input data for Notification hook events.

classsrc.claude_agent_sdk.types.NotificationHookSpecificOutput

Hook-specific output for Notification events.

classsrc.claude_agent_sdk.types.PermissionRequestHookInput

Input data for PermissionRequest hook events.

classsrc.claude_agent_sdk.types.PermissionResultAllow

Allow permission result.

classsrc.claude_agent_sdk.types.PermissionResultDeny

Deny permission result.

classsrc.claude_agent_sdk.types.PermissionRuleValue

Permission rule value.

classsrc.claude_agent_sdk.types.PermissionUpdate

Permission update configuration.

classsrc.claude_agent_sdk.types.PostToolUseFailureHookInput

Input data for PostToolUseFailure hook events.

classsrc.claude_agent_sdk.types.PostToolUseHookInput

Input data for PostToolUse hook events.

classsrc.claude_agent_sdk.types.PostToolUseHookSpecificOutput

Hook-specific output for PostToolUse events.

classsrc.claude_agent_sdk.types.PreCompactHookInput

Input data for PreCompact hook events.

classsrc.claude_agent_sdk.types.PreToolUseHookInput

Input data for PreToolUse hook events.

classsrc.claude_agent_sdk.types.PreToolUseHookSpecificOutput

Hook-specific output for PreToolUse events.

classsrc.claude_agent_sdk.types.ResultMessage

Result message with cost and usage information.

classsrc.claude_agent_sdk.types.SDKControlMcpToggleRequest

Enables or disables an MCP server.

classsrc.claude_agent_sdk.types.SDKSessionInfo

Session metadata returned by ``list_sessions()``.

classsrc.claude_agent_sdk.types.SandboxIgnoreViolations

Violations to ignore in sandbox.

classsrc.claude_agent_sdk.types.SandboxNetworkConfig

Network configuration for sandbox.

classsrc.claude_agent_sdk.types.SandboxSettings

Sandbox settings configuration.

classsrc.claude_agent_sdk.types.SdkPluginConfig

SDK plugin configuration.

classsrc.claude_agent_sdk.types.ServerToolUseBlock

Server-side tool use block (e.g.

classsrc.claude_agent_sdk.types.SessionStartHookSpecificOutput

Hook-specific output for SessionStart events.

methodsrc.claude_agent_sdk.types.SessionStore.append(key:SessionKey, entries:list[SessionStoreEntry]) -> None

Mirror a batch of transcript entries.

methodsrc.claude_agent_sdk.types.SessionStore.delete(key:SessionKey) -> None

Delete a session.

methodsrc.claude_agent_sdk.types.SessionStore.list_sessions(project_key:str) -> list[SessionStoreListEntry]

List sessions for a ``project_key``.

methodsrc.claude_agent_sdk.types.SessionStore.list_subkeys(key:SessionListSubkeysKey) -> list[str]

List all subpath keys under a session (e.g.

methodsrc.claude_agent_sdk.types.SessionStore.load(key:SessionKey) -> list[SessionStoreEntry] | None

Load a full session for resume.

classsrc.claude_agent_sdk.types.SessionSummaryEntry

Incrementally-maintained session summary.

classsrc.claude_agent_sdk.types.StopHookInput

Input data for Stop hook events.

classsrc.claude_agent_sdk.types.SubagentStartHookInput

Input data for SubagentStart hook events.

classsrc.claude_agent_sdk.types.SubagentStartHookSpecificOutput

Hook-specific output for SubagentStart events.

classsrc.claude_agent_sdk.types.SubagentStopHookInput

Input data for SubagentStop hook events.

classsrc.claude_agent_sdk.types.SystemMessage

System message with metadata.

classsrc.claude_agent_sdk.types.SystemPromptFile

System prompt file configuration.

classsrc.claude_agent_sdk.types.SystemPromptPreset

System prompt preset configuration.

classsrc.claude_agent_sdk.types.TaskBudget

API-side task budget in tokens.

classsrc.claude_agent_sdk.types.TaskStartedMessage

System message emitted when a task starts.

classsrc.claude_agent_sdk.types.TextBlock

Text content block.

classsrc.claude_agent_sdk.types.ThinkingBlock

Thinking content block.

classsrc.claude_agent_sdk.types.ToolResultBlock

Tool result content block.

classsrc.claude_agent_sdk.types.ToolUseBlock

Tool use content block.

classsrc.claude_agent_sdk.types.ToolsPreset

Tools preset configuration.

classsrc.claude_agent_sdk.types.UserMessage

User message.

classsrc.claude_agent_sdk.types.UserPromptSubmitHookInput

Input data for UserPromptSubmit hook events.

About this data

These signatures were extracted from the public source of anthropics/claude-agent-sdk-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries