Body
Payload to create a new conversation.
Contains an Agent configuration along with conversation-specific options.
Working directory for agent operations and tool execution
Optional conversation ID. If not provided, a random UUID will be generated.
Controls when the conversation will prompt the user before continuing. Defaults to never.
- AlwaysConfirm
- ConfirmRisky
- NeverConfirm
Initial message to pass to the LLM Payload to send a message to the agent.
This is a simplified version of openhands.sdk.Message.
If set, the max number of iterations the agent will run before stopping. This is useful to prevent infinite loops.
x >= 1If true, the conversation will use stuck detection to prevent infinite loops.
Secrets available in the conversation
Response
Successful Response
Information about a conversation running locally without a Runtime sandbox.
Unique conversation ID
The agent running in the conversation. This is persisted to allow resuming conversations and check agent configuration to handle e.g., tool changes, LLM changes, etc.
Mixin providing local workspace operations.
- LocalWorkspace
- RemoteWorkspace
Directory for persisting conversation state and events. If None, conversation will not be persisted.
Maximum number of iterations the agent can perform in a single run.
x > 0Whether to enable stuck detection for the agent.
Enum representing the current execution state of the agent.
idle, running, paused, waiting_for_confirmation, finished, error, stuck - AlwaysConfirm
- ConfirmRisky
- NeverConfirm
List of activated knowledge skills name
Conversation statistics for tracking LLM metrics
Manager for handling secrets and sensitive data
User-defined title for the conversation
A snapshot of metrics at a point in time.
Does not include lists of individual costs, latencies, or token usages.

