Retrieve Conversation Stream

conversations.messages.stream(, ) -> object

post/v1/conversations/{conversation_id}/stream

Resume the stream for the most recent active run in a conversation.

This endpoint allows you to reconnect to an active background stream for a conversation, enabling recovery from network interruptions.

Agent-direct mode: Pass conversation_id="default" with agent_id in request body to retrieve the stream for the agent's most recent active run.

Deprecated: Passing an agent ID as conversation_id still works but will be removed.

ParametersExpand Collapse

conversation_id: str

The conversation identifier. Can be a conversation ID ('conv-'), 'default' for agent-direct mode (with agent_id parameter), or an agent ID ('agent-') for backwards compatibility (deprecated).

minLength1

maxLength42

agent_id: Optional[str]

Agent ID for agent-direct mode with 'default' conversation. Use with conversation_id='default' in the URL path.

batch_size: Optional[int]

Number of entries to read per batch.

include_pings: Optional[bool]

Whether to include periodic keepalive ping messages in the stream to prevent connection timeouts.

poll_interval: Optional[float]

Seconds to wait between polls when no new data.

starting_after: Optional[int]

Sequence id to use as a cursor for pagination. Response will start streaming after this chunk sequence id

ReturnsExpand Collapse

object

Retrieve Conversation Stream

import os
from letta_client import Letta

client = Letta(
    api_key=os.environ.get("LETTA_API_KEY"),  # This is the default and can be omitted
)
response = client.conversations.messages.stream(
    conversation_id="default",
)
print(response)

{}

Returns Examples

{}