Beta Managed Agents Event Params

• BetaManagedAgentsEventParams = BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserInterruptEventParams or BetaManagedAgentsUserToolConfirmationEventParams or 4 more

  Union type for event parameters that can be sent to a session.

  • BetaManagedAgentsUserMessageEventParams object

    Parameters for sending a user message to the session.

    • type: "user.message"

    • content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock

      Array of content blocks for the user message.

      • BetaManagedAgentsTextBlock object

        Regular text content.

        • type: "text"

        • text: string

          The text content.

          minLength: 1

      • BetaManagedAgentsImageBlock object

        Image content specified directly as base64 data or as a reference via a URL.

        • type: "image"

        • source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource

          Union type for image source variants.

          • BetaManagedAgentsBase64ImageSource object

            Base64-encoded image data.

            • type: "base64"

            • data: string

              Base64-encoded image data.

              minLength: 1

            • media_type: string

              MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

              minLength: 1

          • BetaManagedAgentsURLImageSource object

            Image referenced by URL.

            • type: "url"

            • url: string

              URL of the image to fetch.

              minLength: 1

          • BetaManagedAgentsFileImageSource object

            Image referenced by file ID.

            • type: "file"

            • file_id: string

              ID of a previously uploaded file.

              minLength: 1

      • BetaManagedAgentsDocumentBlock object

        Document content, either specified directly as base64 data, as text, or as a reference via a URL.

        • type: "document"

        • source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource

          Union type for document source variants.

          • BetaManagedAgentsBase64DocumentSource object

            Base64-encoded document data.

            • type: "base64"

            • data: string

              Base64-encoded document data.

              minLength: 1

            • media_type: string

              MIME type of the document (e.g., "application/pdf").

              minLength: 1

          • BetaManagedAgentsPlainTextDocumentSource object

            Plain text document content.

            • type: "text"

            • data: string

              The plain text content.

              minLength: 1

            • media_type: "text/plain"

              MIME type of the text content. Must be "text/plain".

          • BetaManagedAgentsURLDocumentSource object

            Document referenced by URL.

            • type: "url"

            • url: string

              URL of the document to fetch.

              minLength: 1

          • BetaManagedAgentsFileDocumentSource object

            Document referenced by file ID.

            • type: "file"

            • file_id: string

              ID of a previously uploaded file.

              minLength: 1

        • context: optional string or null

          Additional context about the document for the model.

        • title: optional string or null

          The title of the document.

      • BetaManagedAgentsRedactedBlock object

        Placeholder for content withheld by Anthropic model policy.

        • type: "redacted"

  • BetaManagedAgentsUserInterruptEventParams object

    Parameters for sending an interrupt to pause the agent.

    • type: "user.interrupt"

    • session_thread_id: optional string or null

      If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread.

  • BetaManagedAgentsUserToolConfirmationEventParams object

    Parameters for confirming or denying a tool execution request.

    • type: "user.tool_confirmation"

    • result: "allow" or "deny"

      UserToolConfirmationResult enum

      • "allow"

      • "deny"

    • tool_use_id: string

      The id of the agent.tool_use or agent.mcp_tool_use event this result corresponds to, which can be found in the last session.status_idle event's stop_reason.event_ids field.

      minLength: 1, maxLength: 128

    • deny_message: optional string or null

      Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'.

      maxLength: 10000

  • BetaManagedAgentsUserCustomToolResultEventParams object

    Parameters for providing the result of a custom tool execution.

    • type: "user.custom_tool_result"

    • custom_tool_use_id: string

      The id of the agent.custom_tool_use event this result corresponds to, which can be found in the last session.status_idle event's stop_reason.event_ids field.

      minLength: 1, maxLength: 128

    • content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock

      The result content returned by the tool.

      • BetaManagedAgentsTextBlock object

        Regular text content.

      • BetaManagedAgentsImageBlock object

        Image content specified directly as base64 data or as a reference via a URL.

      • BetaManagedAgentsDocumentBlock object

        Document content, either specified directly as base64 data, as text, or as a reference via a URL.

      • BetaManagedAgentsSearchResultBlock object

        A block containing a web search result.

        • type: "search_result"

        • citations: BetaManagedAgentsSearchResultCitations

          Citation settings for a search result.

          • enabled: boolean

            Whether citations are enabled for this search result.

        • content: array of BetaManagedAgentsSearchResultContent

          Array of text content blocks from the search result.

          • type: "text"

          • text: string

            The text content.

            minLength: 1

        • source: string

          The URL source of the search result.

          minLength: 1

        • title: string

          The title of the search result.

          minLength: 1

    • is_error: optional boolean or null

      Whether the tool execution resulted in an error.

  • BetaManagedAgentsUserDefineOutcomeEventParams object

    Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

    • type: "user.define_outcome"

    • description: string

      What the agent should produce. This is the task specification.

    • rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams

      Rubric for grading the quality of an outcome.

      • BetaManagedAgentsFileRubricParams object

        Rubric referenced by a file uploaded via the Files API.

        • type: "file"

        • file_id: string

          ID of the rubric file.

      • BetaManagedAgentsTextRubricParams object

        Rubric content provided inline as text.

        • type: "text"

        • content: string

          Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.

          maxLength: 262144

    • max_iterations: optional number or null

      Eval→revision cycles before giving up. Default 3, max 20.

      format: int32

  • BetaManagedAgentsUserToolResultEventParams object

    Parameters for providing the result of an agent-toolset tool execution. Only valid on self_hosted environments, where sandbox-routed tools are executed by the client rather than the server.

    • type: "user.tool_result"

    • tool_use_id: string

      The id of the agent.tool_use event this result corresponds to, which can be found in the last session.status_idle event's stop_reason.event_ids field.

      minLength: 1, maxLength: 128

    • content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock

      The result content returned by the tool.

      • BetaManagedAgentsTextBlock object

        Regular text content.

      • BetaManagedAgentsImageBlock object

        Image content specified directly as base64 data or as a reference via a URL.

      • BetaManagedAgentsDocumentBlock object

        Document content, either specified directly as base64 data, as text, or as a reference via a URL.

      • BetaManagedAgentsSearchResultBlock object

        A block containing a web search result.

    • is_error: optional boolean or null

      Whether the tool execution resulted in an error.

  • BetaManagedAgentsSystemMessageEventParams object

    Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a role: "system" turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the user.message, user.tool_result, or user.custom_tool_result it accompanies. Only supported on models that accept mid-conversation system messages.

    • type: "system.message"

    • content: array of BetaManagedAgentsSystemContentBlock

      System content blocks to append. Text-only.

      • type: "text"

      • text: string

        The text content.

        minLength: 1