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

Schedule

Schedule Agent Message
agents.schedule.create(stragent_id, ScheduleCreateParams**kwargs) -> ScheduleCreateResponse
POST/v1/agents/{agent_id}/schedule
List Scheduled Agent Messages
agents.schedule.list(stragent_id, ScheduleListParams**kwargs) -> ScheduleListResponse
GET/v1/agents/{agent_id}/schedule
Retrieve Scheduled Agent Message
agents.schedule.retrieve(strscheduled_message_id, ScheduleRetrieveParams**kwargs) -> ScheduleRetrieveResponse
GET/v1/agents/{agent_id}/schedule/{scheduled_message_id}
Delete Scheduled Agent Message
agents.schedule.delete(strscheduled_message_id, ScheduleDeleteParams**kwargs) -> ScheduleDeleteResponse
DELETE/v1/agents/{agent_id}/schedule/{scheduled_message_id}
ModelsExpand Collapse
class ScheduleCreateResponse: …
id: str
next_scheduled_at: Optional[str]
class ScheduleListResponse: …
has_next_page: bool
scheduled_messages: List[ScheduledMessage]
id: str
agent_id: str
message: ScheduledMessageMessage
messages: List[ScheduledMessageMessageMessage]
content: Union[List[ScheduledMessageMessageMessageContentUnionMember0], str]
One of the following:
List[ScheduledMessageMessageMessageContentUnionMember0]
One of the following:
class ScheduledMessageMessageMessageContentUnionMember0UnionMember0: …
text: str
signature: Optional[str]
type: Optional[Literal["text"]]
class ScheduledMessageMessageMessageContentUnionMember0UnionMember1: …
source: ScheduledMessageMessageMessageContentUnionMember0UnionMember1Source
data: str
media_type: str
detail: Optional[str]
type: Optional[Literal["base64"]]
type: Literal["image"]
str
role: Literal["user", "assistant", "system"]
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]]]
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: ScheduledMessageSchedule
One of the following:
class ScheduledMessageScheduleUnionMember0: …
scheduled_at: float
type: Optional[Literal["one-time"]]
class ScheduledMessageScheduleUnionMember1: …
cron_expression: str
type: Literal["recurring"]
class ScheduleRetrieveResponse: …
id: str
agent_id: str
message: Message
messages: List[MessageMessage]
content: Union[List[MessageMessageContentUnionMember0], str]
One of the following:
List[MessageMessageContentUnionMember0]
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"]
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]]]
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
One of the following:
class ScheduleUnionMember0: …
scheduled_at: float
type: Optional[Literal["one-time"]]
class ScheduleUnionMember1: …
cron_expression: str
type: Literal["recurring"]
class ScheduleDeleteResponse: …
success: Literal[true]