Retrieve Scheduled Agent Message

get/v1/agents/{agent_id}/schedule/{scheduled_message_id}

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

Path ParametersExpand Collapse

agent_id: string

scheduled_message_id: string

ReturnsExpand Collapse

id: string

agent_id: string

message: object { messages, callback_url, include_return_message_types, max_steps }

messages: array of object { content, role, name, 3 more }

content: array of object { text, signature, type } or object { source, type } or string

Accepts one of the following:

UnionMember0 = array of object { text, signature, type } or object { source, type }

Accepts one of the following:

UnionMember0 = object { text, signature, type }

text: string

signature: optional string

type: optional "text"

UnionMember1 = object { source, type }

source: object { data, media_type, detail, type }

data: string

media_type: string

detail: optional string

type: optional "base64"

type: "image"

UnionMember1 = string

role: "user" or "assistant" or "system"

Accepts one of the following:

"user"

"assistant"

"system"

name: optional string

otid: optional string

sender_id: optional string

type: optional "message"

callback_url: optional string

include_return_message_types: optional array of "system_message" or "user_message" or "assistant_message" or 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 number

next_scheduled_time: string

schedule: object { scheduled_at, type } or object { cron_expression, type }

Accepts one of the following:

UnionMember0 = object { scheduled_at, type }

scheduled_at: number

type: optional "one-time"

UnionMember1 = object { cron_expression, type }

cron_expression: string

type: "recurring"

Retrieve Scheduled Agent Message

curl https://api.letta.com/v1/agents/$AGENT_ID/schedule/$SCHEDULED_MESSAGE_ID \
    -H "Authorization: Bearer $LETTA_API_KEY"

{
  "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"
  }
}