Retrieve Scheduled Agent Message

client.agents.schedule.retrieve(, , ?): ScheduleRetrieveResponse { id, agent_id, message, 2 more }

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

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

ParametersExpand Collapse

scheduledMessageID: string

params: ScheduleRetrieveParams { agent_id }

agent_id: string

ReturnsExpand Collapse

ScheduleRetrieveResponse { id, agent_id, message, 2 more }

id: string

agent_id: string

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

messages: Array<Message>

content: Array<UnionMember0 { text, signature, type } | UnionMember1 { source, type } > | string

Accepts one of the following:

Array<UnionMember0 { text, signature, type } | UnionMember1 { source, type } >

UnionMember0 { text, signature, type }

text: string

signature?: string | null

type?: "text"

UnionMember1 { source, type }

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

data: string

media_type: string

detail?: string

type?: "base64"

type: "image"

string

role: "user" | "assistant" | "system"

Accepts one of the following:

"user"

"assistant"

"system"

name?: string

otid?: string

sender_id?: string

type?: "message"

callback_url?: string

include_return_message_types?: Array<"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?: number

next_scheduled_time: string | null

schedule: UnionMember0 { scheduled_at, type } | UnionMember1 { cron_expression, type }

Accepts one of the following:

UnionMember0 { scheduled_at, type }

scheduled_at: number

type?: "one-time"

UnionMember1 { cron_expression, type }

cron_expression: string

type: "recurring"

Retrieve Scheduled Agent Message

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: process.env['LETTA_API_KEY'], // This is the default and can be omitted
});

const schedule = await client.agents.schedule.retrieve('scheduled_message_id', { agent_id: 'agent_id' });

console.log(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"
  }
}