Skip to content
My Docs My Docs Letta Docs
Sign up
API Reference
Agents
Schedule

Retrieve Scheduled Agent Message

agents.schedule.retrieve(strscheduled_message_id, ScheduleRetrieveParams**kwargs) -> ScheduleRetrieveResponse
get/v1/agents/{agent_id}/schedule/{scheduled_message_id}

Retrieve a scheduled message by its ID for a specific agent.

ParametersExpand Collapse
agent_id: str
scheduled_message_id: str
ReturnsExpand Collapse
class ScheduleRetrieveResponse: …
id: str
agent_id: str
message: Message
messages: List[MessageMessage]
content: Union[List[MessageMessageContentUnionMember0], str]
Accepts one of the following:
List[MessageMessageContentUnionMember0]
Accepts one of the following:
class MessageMessageContentUnionMember0UnionMember0: …
text: str
signature: Optional[str]
type: Optional[Literal["text"]]
class MessageMessageContentUnionMember0UnionMember1: …
source: MessageMessageContentUnionMember0UnionMember1Source
data: str
media_type: str
detail: Optional[str]
type: Optional[Literal["base64"]]
type: Literal["image"]
str
role: Literal["user", "assistant", "system"]
Accepts one of the following:
"user"
"assistant"
"system"
name: Optional[str]
otid: Optional[str]
sender_id: Optional[str]
type: Optional[Literal["message"]]
callback_url: Optional[str]
include_return_message_types: Optional[List[Literal["system_message", "user_message", "assistant_message", 6 more]]]
Accepts one of the following:
"system_message"
"user_message"
"assistant_message"
"reasoning_message"
"hidden_reasoning_message"
"tool_call_message"
"tool_return_message"
"approval_request_message"
"approval_response_message"
max_steps: Optional[float]
next_scheduled_time: Optional[str]
schedule: Schedule
Accepts one of the following:
class ScheduleUnionMember0: …
scheduled_at: float
type: Optional[Literal["one-time"]]
class ScheduleUnionMember1: …
cron_expression: str
type: Literal["recurring"]
Retrieve Scheduled Agent Message
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
)
schedule = client.agents.schedule.retrieve(
    scheduled_message_id="scheduled_message_id",
    agent_id="agent_id",
)
print(schedule.id)
{
  "id": "id",
  "agent_id": "agent_id",
  "message": {
    "messages": [
      {
        "content": [
          {
            "text": "text",
            "signature": "signature",
            "type": "text"
          }
        ],
        "role": "user",
        "name": "name",
        "otid": "otid",
        "sender_id": "sender_id",
        "type": "message"
      }
    ],
    "callback_url": "https://example.com",
    "include_return_message_types": [
      "system_message"
    ],
    "max_steps": 0
  },
  "next_scheduled_time": "next_scheduled_time",
  "schedule": {
    "scheduled_at": 0,
    "type": "one-time"
  }
}
Returns Examples
{
  "id": "id",
  "agent_id": "agent_id",
  "message": {
    "messages": [
      {
        "content": [
          {
            "text": "text",
            "signature": "signature",
            "type": "text"
          }
        ],
        "role": "user",
        "name": "name",
        "otid": "otid",
        "sender_id": "sender_id",
        "type": "message"
      }
    ],
    "callback_url": "https://example.com",
    "include_return_message_types": [
      "system_message"
    ],
    "max_steps": 0
  },
  "next_scheduled_time": "next_scheduled_time",
  "schedule": {
    "scheduled_at": 0,
    "type": "one-time"
  }
}