Search the documentation
30 pages for systemmessage.
Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.
Deployments
Claude Developer Platform · in the page
api/beta/deployments
…ng up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the sessi…
Archive Deployment
Claude Developer Platform · in the page
api/beta/deployments/archive
…3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's…
Create Deployment
Claude Developer Platform · in the page
api/beta/deployments/create
…ng up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the sessi…
List Deployments
Claude Developer Platform · in the page
api/beta/deployments/list
…3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's…
Pause Deployment
Claude Developer Platform · in the page
api/beta/deployments/pause
…3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's…
Get Deployment
Claude Developer Platform · in the page
api/beta/deployments/retrieve
…3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's…
Unpause Deployment
Claude Developer Platform · in the page
api/beta/deployments/unpause
…3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's…
Update Deployment
Claude Developer Platform · in the page
api/beta/deployments/update
…ng up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the sessi…
Events
Claude Developer Platform · in the page
api/beta/sessions/events
…itle. Present only when the update changed it. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
List Events
Claude Developer Platform · in the page
api/beta/sessions/events/list
…itle. Present only when the update changed it. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
Send Events
Claude Developer Platform · in the page
api/beta/sessions/events/send
…ether the tool execution resulted in an error. - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the sessi…
Stream Events
Claude Developer Platform · in the page
api/beta/sessions/events/stream
…iles the preview. - `type: "event_delta"` - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
Threads
Claude Developer Platform · in the page
api/beta/sessions/threads
…iles the preview. - `type: "event_delta"` - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
Events
Claude Developer Platform · in the page
api/beta/sessions/threads/events
…itle. Present only when the update changed it. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
List Session Thread Events
Claude Developer Platform · in the page
api/beta/sessions/threads/events/list
…itle. Present only when the update changed it. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
Stream Session Thread Events
Claude Developer Platform · in the page
api/beta/sessions/threads/events/stream
…iles the preview. - `type: "event_delta"` - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the sessi…
mid-conversation-effort-example
Claude Developer Platform · in the page
build-with-claude/mid-conversation-effort-example
…e refresher every TURNS_BETWEEN_REFRESHERS user turns. private dueSystemMessages(): Anthropic.MessageParam[] { const due: Array<{ role: "system"; content: string }> = []; if (this.exit…
events-and-streaming
Claude Developer Platform · in the page
managed-agents/events-and-streaming
…n.ID, new() { Events = [ new BetaManagedAgentsSystemMessageEventParams { Type = BetaManagedAgentsSystemMessageEventParamsType.SystemMessage,…
How the agent loop works
Claude Code CLI · in the page
agent-sdk/agent-loop
…rompt, tool definitions, and conversation history. The SDK yields a [`SystemMessage`](#message-types) with subtype `"init"` containing session metadata. 2. **Evaluate and respond.** Claude evaluates t…
Intercept and control agent behavior with hooks
Claude Code CLI · in the page
agent-sdk/hooks
…ries of fields: * **Top-level fields** are accepted on every event: `systemMessage` shows a message to the user, and `continue` (`continue_` in Python) determines whether the agent keeps running afte…
Connect to external tools with MCP
Claude Code CLI · in the page
agent-sdk/mcp
…ort asyncio from claude_agent_sdk import query, ClaudeAgentOptions, SystemMessage async def main(): options = ClaudeAgentOptions( mcp_servers={ # your servers…
Plugins in the SDK
Claude Code CLI · in the page
agent-sdk/plugins
…ort asyncio from claude_agent_sdk import query, ClaudeAgentOptions, SystemMessage async def main(): async for message in query( prompt="Hello", options=ClaudeAgentOptio…
Agent SDK reference - Python
Claude Code CLI · in the page
agent-sdk/python
…theme={null} Message = ( UserMessage | AssistantMessage | SystemMessage | ResultMessage | StreamEvent | RateLimitEvent | ConversationResetMessage ) ``` ### `UserMessage`…
Work with sessions
Claude Code CLI · in the page
agent-sdk/sessions
…cript the ID is also available earlier as a direct field on the init `SystemMessage`; in Python it's nested inside `SystemMessage.data`. <CodeGroup> ```python Python theme={null} import asyncio…
Extend agents with skills
Claude Code CLI · in the page
agent-sdk/skills
…ort asyncio from claude_agent_sdk import query, ClaudeAgentOptions, SystemMessage async def main(): async for message in query(prompt="Hello Claude", options=ClaudeAgentOptions(max_turns=1…
Stream responses in real-time
Claude Code CLI · in the page
agent-sdk/streaming-output
…receive all message types except `StreamEvent`. Common types include `SystemMessage` (session initialization), `AssistantMessage` (complete responses), `ResultMessage` (final result), and a compact bo…
Agent SDK reference - TypeScript
Claude Code CLI · in the page
agent-sdk/typescript
…When the CLI advertises the `interrupt_receipt_v1` capability in [`SDKSystemMessage.capabilities`](#sdksystemmessage), resolves with an [`SDKControlInterruptResponse`](#sdkcontrolinterruptresponse) li…
Run Claude Code programmatically
Claude Code CLI · in the page
headless
…Code v2.1.205 or later and is absent from earlier versions. See [`SDKSystemMessage`](/docs/en/agent-sdk/typescript#sdksystemmessage) for the capability list. #### Fail CI when a plugin or MCP server…
Hooks reference
Claude Code CLI · in the page
hooks
…dev/tty`. To surface a message to the user on any platform, return [`systemMessage`](#json-output) in JSON output. Some events discard it or deliver it elsewhere, and each [event's section](#hook-eve…
Automate actions with hooks
Claude Code CLI · in the page
hooks-guide
…you see nothing, unless the hook's JSON surfaces something, such as `systemMessage` or Stop hook feedback. * To confirm a hook ran, check for its effect, like a reformatted file, or turn on debug l…