ELelizaos
messaging

Send session heartbeat

Keep a session alive with a heartbeat. If auto-renewal is enabled, this will also renew the session.

post/api/messaging/sessions/{sessionId}/heartbeat

Request

  • Base URL
    http://localhost:3000
  • URL
    http://localhost:3000/api/messaging/sessions/{sessionId}/heartbeat
  • Auth
    none declared

Path parameters

sessionIdstring required

ID of the session

Response

Heartbeat received successfully

sessionIdstring

Unique session identifier

agentIdstring uuid

UUID of the agent

userIdstring uuid

UUID of the user

createdAtstring date-time

Session creation timestamp

lastActivitystring date-time

Last activity timestamp

metadataobject

Session metadata

expiresAtstring date-time

When the session will expire

renewalCountinteger

Number of times the session has been renewed

timeRemaininginteger

Milliseconds until session expiration

isNearExpirationboolean

Whether the session is within the warning threshold

Changes

No recorded changes to this operation across all 2 revisions of this API.