Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/pages/docs/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: API Reference
meta_description: "API reference section of the Ably developer documentation."
intro: "Ably's APIs enable you to build realtime experiences using Ably's SDKs, REST endpoints, and streaming protocols. These references provide comprehensive documentation for integrating Ably's pub/sub messaging, presence, and authentication capabilities into your applications."
meta_description: "Complete API reference documentation for Ably's realtime SDKs, REST APIs, SSE streaming, and Control API. Includes SDKs, authentication, and integration guides."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, REST SDK, REST API, SSE API, Control API"
---

This section of the documentation contains the API references for Ably.

The following API references are available:

* [Client library Realtime SDK](/docs/api/realtime-sdk)
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Constructor
meta_description: "Realtime Client Library SDK API reference section for the constructor object."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, constructor, instantiate"
intro: "The Realtime SDK constructor creates persistent connections for bidirectional messaging and event subscription. This enables realtime pub/sub, presence awareness, and live data synchronization across all connected clients."
meta_description: "Ably Realtime SDK constructor API reference. Create persistent connections for bidirectional messaging, pub/sub, presence, and realtime data synchronization."
meta_keywords: "Ably, Ably realtime, Realtime SDK, constructor, instantiate, persistent connection, bidirectional messaging"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk
- /docs/api/versions/v1.0/realtime-sdk
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Authentication
meta_description: "Realtime Client Library SDK API reference section for authentication."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, auth, authentication, token, JWT, basic auth"
intro: "The Realtime SDK auth object manages client authentication using API keys, tokens, or JWT for secure connections. This enables token generation, renewal, and client identity management for realtime applications."
meta_description: "Ably Realtime SDK authentication API reference. Manage auth tokens, JWT authentication, client identity, and secure connection establishment."
meta_keywords: "Ably, Ably realtime, Realtime SDK, authentication, auth tokens, JWT, client identity, secure connections"
jump_to:
Help with:
- Tokens#tokens
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/channel-metadata.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Channel Metadata
meta_description: "Realtime Client Library SDK API reference section for channel metadata."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, channel, metadata, channel metadata, occupancy"
intro: "Channel metadata provides occupancy information and channel lifecycle data without requiring subscription. The Realtime SDK metadata API enables monitoring active connections, presence counts, and channel status for operational insights."
meta_description: "Ably Realtime SDK channel metadata API reference. Monitor occupancy, presence counts, and channel status without subscription for operational insights."
meta_keywords: "Ably, Ably realtime, Realtime SDK, channel metadata, occupancy, presence counts, channel status, monitoring"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk/channel-metadata
- /docs/api/versions/v1.0/realtime-sdk/channel-metadata
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/channels.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Channels
meta_description: "Realtime Client Library SDK API reference section for the channels and channel objects."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, channel, channel, channels, publish, subscribe"
intro: "Channels enable topic-based pub/sub messaging and presence tracking across connected clients. The Realtime SDK channels API manages subscriptions, message publishing, and channel-specific operations for live data distribution."
meta_description: "Ably Realtime SDK channels API reference. Manage subscriptions, publish messages, track presence, and handle channel operations for realtime messaging."
meta_keywords: "Ably, Ably realtime, Realtime SDK, channels, pub/sub, subscriptions, messaging, presence"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk/channels
- /docs/api/versions/v1.0/realtime-sdk/channels
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/connection.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Connection
meta_description: "Realtime Client Library SDK API reference section for the connection object."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, connect, connection"
intro: "The connection object manages the persistent WebSocket connection to Ably's realtime infrastructure. This provides connection state monitoring, event handling, and automatic recovery for reliable realtime messaging."
meta_description: "Ably Realtime SDK connection API reference. Manage WebSocket connections, monitor states, handle events, and implement automatic connection recovery."
meta_keywords: "Ably, Ably realtime, Realtime SDK, connection, WebSocket, connection state, recovery, monitoring"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk/connection
- /docs/api/versions/v1.0/realtime-sdk/connection
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/encryption.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Encryption
meta_description: "Realtime Client Library SDK API reference section for the crypto object."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, encryption, crypto"
intro: "Channel-level encryption secures message payloads using AES encryption before transmission to Ably. The Realtime SDK crypto API manages encryption keys, cipher parameters, and automated encrypt/decrypt operations for secure messaging."
meta_description: "Ably Realtime SDK encryption API reference. Implement channel-level AES encryption for secure message payloads and automated encrypt/decrypt operations."
meta_keywords: "Ably, Ably realtime, Realtime SDK, encryption, crypto, AES, secure messaging, channel encryption"
jump_to:
API Reference:
- getDefaultParams#get-default-params
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/history.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: History
meta_description: "Realtime Client Library SDK API reference section for the history methods."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, history, message, presence"
intro: "History methods retrieve previously published messages and presence events from channel storage. The Realtime SDK history API enables message replay, backfill scenarios, and historical data analysis with time-based filtering."
meta_description: "Ably Realtime SDK history API reference. Retrieve stored messages and presence events with time-based filtering for replay and backfill scenarios."
meta_keywords: "Ably, Ably realtime, Realtime SDK, history, message history, presence history, storage, replay, backfill"
jump_to:
API reference:
- Message history#channel-history
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/messages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Messages
meta_description: "Realtime Client Library SDK API reference section for the message object."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, message, messages"
intro: "Message objects represent data published to channels and contain payload, metadata, and delivery information. The Realtime SDK message API handles publishing, subscription, and message processing for live data exchange."
meta_description: "Ably Realtime SDK messages API reference. Handle message publishing, subscriptions, payload processing, and metadata for realtime data exchange."
meta_keywords: "Ably, Ably realtime, Realtime SDK, messages, publishing, subscriptions, payload, metadata"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk/messages
- /docs/api/versions/v1.0/realtime-sdk/messages
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/presence.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Presence
meta_description: "Realtime Client Library SDK API reference section for the presence object."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, presence"
intro: "Presence tracking shows which clients are currently active on a channel and enables realtime awareness features. The Realtime SDK presence API manages member states, occupancy counts, and presence event notifications."
meta_description: "Ably Realtime SDK presence API reference. Track active channel members, manage presence states, and handle occupancy for real-time awareness features."
meta_keywords: "Ably, Ably realtime, Realtime SDK, presence, member tracking, occupancy, awareness, real-time"
jump_to:
Presence API properties:
- syncComplete#sync-complete
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/push-admin.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Push Notifications - Admin
meta_description: "Realtime Client Library SDK API reference section for push notifications admin."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, push, push notification, notification, push notifications, notifications, admin, push admin"
intro: "Push admin capabilities enable server-side management of device registrations, channel subscriptions, and direct push message delivery. The Realtime SDK push admin API provides programmatic control over push notification infrastructure and targeting."
meta_description: "Ably Realtime SDK push admin API reference. Manage device registrations, channel subscriptions, and direct push delivery for server-side push control."
meta_keywords: "Ably, Ably realtime, Realtime SDK, push admin, device management, push delivery, server-side notifications, targeting"
jump_to:
API reference:
- publish#publish
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/push.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Push Notifications - Device Activation and Subscription
meta_description: "Realtime Client Library SDK API reference section for push notification device subscription."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, push, push notification, notification, push notifications, notifications, device subscription, activate device"
intro: "Push notification device activation enables mobile apps to receive push messages through platform-specific services like FCM and APNs. The Realtime SDK push API manages device registration, subscription, and notification delivery for mobile engagement."
meta_description: "Ably Realtime SDK push notifications API reference. Activate devices, manage subscriptions, and deliver push messages via FCM and APNs for mobile apps."
meta_keywords: "Ably, Ably realtime, Realtime SDK, push notifications, device activation, FCM, APNs, mobile notifications, subscriptions"
jump_to:
API reference:
- activate#activate
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/statistics.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Statistics
meta_description: "Realtime Client Library SDK API reference section for the stats object."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, stats, statistics"
intro: "Statistics provide usage metrics and operational data for your Ably application including message volumes and connection counts. The Realtime SDK stats API retrieves time-series data for monitoring and analytics purposes."
meta_description: "Ably Realtime SDK statistics API reference. Retrieve usage metrics, message volumes, and connection data for monitoring and analytics."
meta_keywords: "Ably, Ably realtime, Realtime SDK, statistics, metrics, usage data, monitoring, analytics"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk/statistics
- /docs/api/versions/v1.0/realtime-sdk/statistics
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/realtime-sdk/types.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Types
meta_description: "Realtime Client Library SDK API reference section for types."
meta_keywords: "Ably, Ably realtime, API Reference, Realtime SDK, types, objects, options"
intro: "Type definitions specify data structures, configuration options, and callback interfaces used throughout the Realtime SDK. These reference types enable proper integration and type safety across all SDK operations."
meta_description: "Ably Realtime SDK types reference. Data structures, configuration options, and callback interfaces for proper SDK integration and type safety."
meta_keywords: "Ably, Ably realtime, Realtime SDK, types, data structures, configuration, interfaces, type safety"
redirect_from:
- /docs/api/versions/v1.1/realtime-sdk/types
- /docs/api/versions/v1.0/realtime-sdk/types
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-api.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: REST API Reference
meta_description: "Ably provides the raw REST API for situations where an Ably client library SDK is not available on the platform of choice, or due to resource constraints."
meta_keywords: "REST API, REST, protocol, resource constraints"
intro: "The raw REST API enables direct HTTP integration when SDKs are unavailable or impractical due to platform constraints. This provides complete access to Ably's messaging, presence, and administrative capabilities through standard HTTP requests and responses."
meta_description: "Ably raw REST API reference for direct HTTP integration when SDKs are unavailable. Complete messaging, presence, and admin capabilities via HTTP requests."
meta_keywords: "REST API, HTTP integration, raw API, platform constraints, direct HTTP, messaging API"
jump_to:
Intro:
- Common API behavior#common
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Constructor
meta_description: "Client Library SDK REST API Reference constructor documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, constructor"
intro: "The REST SDK constructor creates stateless clients for publishing messages and querying Ably services without persistent connections. This enables server-side message publishing, history retrieval, and administrative operations with minimal resource overhead."
meta_description: "Ably REST SDK constructor API reference. Create stateless clients for publishing, history retrieval, and admin operations without persistent connections."
meta_keywords: "Ably, Ably REST, REST SDK, constructor, stateless client, publishing, server-side operations"
redirect_from:
- /docs/api/versions/v1.1/rest-sdk
- /docs/api/versions/v1.0/rest-sdk
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Authentication
meta_description: "Client Library SDK REST API Reference Authentication documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Authentication"
intro: "The REST SDK auth object manages authentication for stateless operations using API keys, tokens, or JWT. This enables secure server-side publishing, token generation for clients, and administrative operations without persistent connections."
meta_description: "Ably REST SDK authentication API reference. Manage auth tokens, JWT authentication, and secure stateless operations for server-side publishing."
meta_keywords: "Ably, Ably REST, REST SDK, authentication, auth tokens, JWT, server-side auth, stateless operations"
jump_to:
Help with:
- Tokens#tokens
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/channel-status.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Channel Status
meta_description: "Client Library SDK REST API Reference Channel Status documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Channel Status"
intro: "Channel status operations provide detailed information about channel lifecycle, occupancy, and activity through stateless HTTP requests. This enables server-side monitoring of channel health, usage patterns, and operational metrics without subscriptions."
meta_description: "Ably REST SDK channel status API reference. Monitor channel lifecycle, occupancy, and activity via stateless HTTP requests for operational insights."
meta_keywords: "Ably, REST SDK, channel status, occupancy monitoring, channel lifecycle, operational metrics, HTTP requests"
section: api
index: 30
jump_to:
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/channels.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Channels
meta_description: "Client Library SDK REST API Reference Channels documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Channels"
intro: "REST SDK channels provide stateless operations for publishing messages and querying channel data without subscriptions. This enables server-side message distribution, presence queries, and channel management through HTTP requests."
meta_description: "Ably REST SDK channels API reference. Stateless message publishing, presence queries, and channel management via HTTP requests."
meta_keywords: "Ably, Ably REST, REST SDK, channels, stateless publishing, message distribution, HTTP requests"
redirect_from:
- /docs/api/versions/v1.1/rest-sdk/channels
- /docs/api/versions/v1.0/rest-sdk/channels
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/encryption.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Encryption
meta_description: "Client Library SDK REST API Reference Crypto documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Encryption, Crypto"
intro: "REST SDK encryption provides AES encryption capabilities for secure message publishing through stateless operations. This enables server-side payload encryption, cipher key management, and secure data transmission via HTTP requests."
meta_description: "Ably REST SDK encryption API reference. Implement AES encryption for secure message publishing and payload protection via stateless operations."
meta_keywords: "Ably, REST SDK, encryption, AES, secure publishing, cipher keys, stateless encryption, HTTP requests"
jump_to:
API Reference:
- getDefaultParams#get-default-params
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/history.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: History
meta_description: "Client Library SDK REST API Reference History documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, History"
intro: "REST SDK history operations retrieve previously published messages and presence events through stateless HTTP requests. This enables server-side data analysis, message replay, and historical reporting without persistent connections."
meta_description: "Ably REST SDK history API reference. Retrieve stored messages and presence events via stateless HTTP requests for analysis and replay."
meta_keywords: "Ably, REST SDK, history, message history, presence history, stateless retrieval, HTTP requests"
jump_to:
API reference:
- Message history#channel-history
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/messages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Messages
meta_description: "Client Library SDK REST API Reference Message documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Message"
intro: "Message objects in the REST SDK represent data for stateless publishing and historical retrieval operations. This enables server-side message distribution with payload handling, encoding, and delivery confirmation through HTTP requests."
meta_description: "Ably REST SDK messages API reference. Handle stateless message publishing, payload processing, and historical retrieval via HTTP requests."
meta_keywords: "Ably, Ably REST, REST SDK, messages, stateless publishing, payload handling, HTTP requests"
redirect_from:
- /docs/api/versions/v1.1/rest-sdk/messages
- /docs/api/versions/v1.0/rest-sdk/messages
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/presence.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Presence
meta_description: "Presence events provide clients with information about the status of other clients 'present' on a channel"
meta_keywords: "Ably, presence, presence events, channel members, presence history."
intro: "REST SDK presence operations provide stateless queries for channel member information and presence history. This enables server-side monitoring of active clients and presence data retrieval without maintaining persistent connections."
meta_description: "Ably REST SDK presence API reference. Query channel members and retrieve presence history via stateless HTTP operations."
meta_keywords: "Ably, REST SDK, presence, channel members, presence history, stateless queries"
jump_to:
Presence API reference:
- get
Expand Down
5 changes: 3 additions & 2 deletions src/pages/docs/api/rest-sdk/push-admin.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Push Notifications - Admin
meta_description: "Client Library SDK REST API Reference Push documentation."
meta_keywords: "Ably, Ably REST, API Reference, REST SDK, REST interface, REST API, Push"
intro: "REST SDK push admin operations manage device registrations and deliver push notifications through stateless HTTP requests. This enables server-side push notification management, device targeting, and message delivery without persistent connections."
meta_description: "Ably REST SDK push admin API reference. Manage device registrations and deliver push notifications via stateless HTTP operations."
meta_keywords: "Ably, REST SDK, push admin, device registration, push notifications, stateless delivery, HTTP requests"
jump_to:
Push Admin API properties:
- deviceRegistrations#device-registrations
Expand Down
Loading