Call a Claude Managed Agent hosted on the Claude Platform from a Sim workflow. Select a Claude Platform account, agent, and environment, then send the task message.
Optional inputs attach credential vaults, a memory store with read or write access and usage instructions, files, and metadata tags. The Run session (create, send, wait for reply) operation waits for the reply and returns final text and a session ID, with token usage when available, for downstream processing and cost tracking. Outputs from the other operations depend on the selected action. Session actions also create, inspect, interrupt, archive, update, or delete sessions; read events; and submit custom-tool results or confirmation responses. File attachments are supported for cloud environments.
Run or create a session with a Claude Platform account, agent, and environment. Optionally attach vaults, a memory store, files, and metadata. The Run session operation waits for the agent’s reply and returns final text and a session ID, with token usage when available. Outputs from other operations depend on the selected action.
Open a Claude Platform Managed Agent session and return the assistant response as text.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to run the agent with. agentstring Yes Managed-agent id inside the linked Claude workspace. environmentstring Yes Environment id inside the linked Claude workspace. environmentTypestring No Environment execution model hint ('cloud' | 'self_hosted'); the actual type is re-resolved server-side for routing. userMessagestring Yes The user message to send to the Managed Agent. vaultsarray No Zero or more vault ids for MCP tool auth. vaultsAckboolean No Acknowledgement that the author may use the attached vaults. memoryStoreIdstring No Optional Agent Memory Store id. memoryAccessstring No Memory store access mode: 'read_write' (default) or 'read_only'. memoryInstructionsstring No Per-attachment guidance for how the agent should use the memory store. filesarray No File attachments (cloud envs only), as [{fileId, mountPath?}]. sessionParametersobject No Key/value session metadata forwarded to the session.
Parameter Type Description contentstring Final assistant text from the Managed Agent session. sessionIdstring Anthropic session id (for logs / linking). inputTokensnumber Cumulative input tokens for the session. outputTokensnumber Cumulative output tokens for the session.
Create a Claude Platform Managed Agent session and return its id without waiting for a reply.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. agentstring Yes Managed-agent id inside the linked Claude workspace. environmentstring Yes Environment id inside the linked Claude workspace. environmentTypestring No Environment execution model hint ('cloud' | 'self_hosted'). userMessagestring No Optional first message; seeds initial_events and starts the agent immediately. vaultsarray No Zero or more vault ids for MCP tool auth. vaultsAckboolean No Acknowledgement that the author may use the attached vaults. memoryStoreIdstring No Optional Agent Memory Store id. memoryAccessstring No Memory store access mode: 'read_write' (default) or 'read_only'. memoryInstructionsstring No Per-attachment guidance for how the agent should use the memory store. filesarray No File attachments (cloud envs only), as [{fileId, mountPath?}]. sessionParametersobject No Key/value session metadata forwarded to the session.
Parameter Type Description sessionIdstring Anthropic session id (sesn_...). startedboolean True when a first message was seeded, so the agent is already running.
Send a user message to an existing Claude Platform Managed Agent session.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on. userMessagestring Yes The user message to send to the session.
Parameter Type Description sessionIdstring The session the message was sent to. sentboolean True when the event was accepted by the API.
Read a Managed Agent session: status, stop reason, token usage, metadata, and any tool calls awaiting approval.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on.
Parameter Type Description sessionIdstring The session that was read. statusstring Session status — 'idle', 'running', 'rescheduling', or 'terminated'. stopReasonstring Why the session last stopped, e.g. 'end_turn' or 'requires_action'. requiresActionboolean True when the session is waiting on a tool confirmation or custom tool result. If this is true while pendingTools is empty, the session is blocked but the API named no blocking events — surface it rather than treating the session as done. pendingToolsjson Blocking tool calls — [{id, eventType, kind, name, input}]. Route by kind: 'confirmation' ids go to Respond To Tool Confirmation, 'custom_tool_result' ids go to Respond To Custom Tool. metadatajson Session metadata. titlestring Session title. inputTokensnumber Cumulative input tokens. outputTokensnumber Cumulative output tokens.
Read a Managed Agent session's event history and the agent's reply text.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on. eventTypesarray No Optional event-type filter, e.g. ['agent.message']. Omit to return every event. limitnumber No Maximum events to return, keeping the most recent (default 500).
Parameter Type Description sessionIdstring The session that was read. eventsjson Session events, oldest first. countnumber Number of events returned. assistantTextstring Concatenated text of every persisted agent.message, in order. truncatedboolean True when the limit was hit and older events were dropped.
Update a Managed Agent session's title or metadata.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on. titlestring No New session title. sessionParametersobject No Replacement metadata map (replaces all stored metadata, not merged). Leaving it empty leaves the stored metadata unchanged — use clearMetadata to remove it. clearMetadataboolean No Removes all of the session's stored metadata. Overrides any map supplied above.
Parameter Type Description sessionIdstring The session that was updated. updatedboolean True when the update was accepted. metadatajson Metadata after the update. titlestring Title after the update.
Stop a running Managed Agent session; it stays usable afterwards.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on.
Parameter Type Description sessionIdstring The session that was interrupted. interruptedboolean True when the interrupt was accepted.
Allow or deny the tool calls a Managed Agent session is waiting on before it can continue.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on. toolUseIdsarray Yes Blocking tool-use EVENT ids, from Get Session pendingTools[].id where kind is 'confirmation' (not toolu_ ids). decisionstring Yes 'allow' to let the tools run, or 'deny' to reject them. denyMessagestring No Reason surfaced to the agent. Only sent when the decision is deny.
Parameter Type Description sessionIdstring The session that was answered. decisionstring The decision applied — 'allow' or 'deny'. confirmedToolUseIdsjson The tool-use event ids that were answered.
Return the result of a custom tool a Managed Agent session is waiting on so it can continue.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on. customToolUseIdstring Yes The custom tool-use EVENT id being answered, from Get Session pendingTools[].id where kind is 'custom_tool_result'. resultstring Yes The tool's output, returned to the agent as text. isErrorboolean No Mark the result as a failure so the agent can adjust its approach.
Parameter Type Description sessionIdstring The session that was answered. answeredToolUseIdstring The custom tool-use event id that was answered.
Archive a Managed Agent session, preserving its history. Not reversible.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on.
Parameter Type Description sessionIdstring The session that was archived. archivedboolean True when the archive was accepted.
Permanently delete a Managed Agent session, its events, and its sandbox. Not reversible.
Inputs and outputsParameter Type Required Description credentialstring Yes Claude Platform credential (Anthropic workspace API key) to act with. sessionIdstring Yes Anthropic session id (sesn_...) to act on.
Parameter Type Description sessionIdstring The session that was deleted. deletedboolean True when the delete was accepted.