Skip to main content
The LiveObjects REST API provides HTTP access to LiveObjects state management functionality for server-side operations. Use this API to query object state, perform administrative tasks, and integrate LiveObjects with server-side workflows.

​
Overview

The LiveObjects REST API enables you to:
  • Query current state of LiveObjects
  • Retrieve object history
  • List objects in a namespace
  • Perform administrative operations

​
Base URL

All LiveObjects REST API requests use:

​
Authentication

The LiveObjects REST API uses the same authentication as the standard REST API:

​
Basic Authentication

​
Token Authentication

​
Objects

Query and manage LiveObject instances.

​
Get Object

Retrieve the current state of a LiveObject:
​
objectId
string
Unique identifier for the object.
​
data
object
Current state data of the object.
​
version
string
Version identifier for the current state.
​
timestamp
integer
Timestamp when the object was last modified.

​
List Objects

List all objects in a namespace:
​
limit
integer
default:"100"
Maximum number of objects to return.
​
prefix
string
Filter objects by ID prefix.

​
Get Object History

Retrieve the history of state changes for an object:
​
start
integer
Start time in milliseconds since epoch.
​
end
integer
End time in milliseconds since epoch.
​
limit
integer
default:"100"
Maximum number of history entries to return.
​
direction
string
default:"backwards"
Query direction: forwards or backwards.

​
State Operations

Query and modify object state.

​
Update Object State

Update the state of a LiveObject:
​
data
object
required
New state data to merge with existing state.
​
version
string
Optional version for optimistic concurrency control.

​
Delete Object

Delete a LiveObject:

​
Namespaces

Manage LiveObjects namespaces.

​
Get Namespace Info

Retrieve information about a namespace:
​
namespaceId
string
Namespace identifier.
​
objectCount
integer
Number of objects in the namespace.
​
lastActivity
integer
Timestamp of last activity in milliseconds.

​
List Namespaces

List all LiveObjects namespaces:

​
Subscriptions

Manage subscriptions to LiveObjects state changes.

​
Get Active Subscriptions

Retrieve active subscriptions for an object:
​
subscriptions
array
List of active subscriptions.
​
subscriptions[].connectionId
string
Connection ID of the subscriber.
​
subscriptions[].clientId
string
Client ID of the subscriber.

​
Error Handling

The LiveObjects REST API uses standard HTTP status codes: Common errors:
  • 400 - Invalid request parameters
  • 401 - Authentication failed
  • 403 - Insufficient permissions
  • 404 - Object or namespace not found
  • 409 - Version conflict (optimistic concurrency)
  • 429 - Rate limit exceeded

​
Rate Limits

The LiveObjects REST API shares rate limits with the standard REST API:
  • State queries: Up to 50 requests per second
  • State updates: Up to 2,000 updates per second
See rate limits for details.

​
Examples

​
Query Object State

​
Update Object State

​
List Objects in Namespace

Build docs developers (and LLMs) love

Get started for freeTalk to us