llms.txt
Compare with other sites' llms.txt files →# Ably Documentation
> Ably is a realtime experience infrastructure platform that provides pub/sub messaging, chat, realtime data synchronization, and more.
- **Global Edge Network**: Ultra-low latency realtime messaging delivered through a globally distributed edge network
- **Enterprise Scale**: Built to handle millions of concurrent connections with guaranteed message delivery
- **Multiple Products**: Pub/Sub, AI Transport, Chat, LiveSync, LiveObjects and Spaces
- **Developer-Friendly SDKs**: SDKs available for JavaScript, Node.js, Java, Python, Go, Objective-C, Swift, Csharp, PHP, Flutter, Ruby, React, React Native, and Kotlin
## Platform
- [About Ably](https://ably.com/docs/platform.md?source=llms.txt): An introduction to Ably and its highly-available, scalable platform.
- [llms.txt](https://ably.com/docs/platform/ai-llms/llms-txt.md?source=llms.txt): Discover all Ably documentation pages using llms.txt, a machine-readable index optimized for LLMs and AI assistants.
- [Building with LLMs](https://ably.com/docs/platform/ai-llms.md?source=llms.txt): Learn how to use LLMs to build with Ably documentation. Access markdown versions of docs and use our LLM-optimized resources.
- [Product guidance](https://ably.com/docs/platform/products.md?source=llms.txt): Choose the right Ably SDK and package for your use case. Compare device and server packages, and protocol adapters.
- [Support tickets](https://ably.com/docs/platform/support.md?source=llms.txt): Learn how to get support from Ably, file tickets, and access technical resources.
- [Ably CLI](https://ably.com/docs/platform/tools/cli.md?source=llms.txt): The Ably CLI is a command-line interface for managing Ably resources and interacting with Ably's products APIs directly from your terminal.
### Account Management
- [Two-factor authentication \(2FA\)](https://ably.com/docs/platform/account/2fa.md?source=llms.txt): Enable two-factor authentication for your Ably account.
- [Access tokens](https://ably.com/docs/platform/account/access-tokens.md?source=llms.txt): Create and manage access tokens to authenticate with the Ably Control API and Ably CLI, including expiration and rotation.
- [Programmatic management with Control API](https://ably.com/docs/platform/account/control-api.md?source=llms.txt): The Control API is a REST API that enables you to manage your Ably account programmatically. This is the Control API user guide.
- [Enterprise customization](https://ably.com/docs/platform/account/enterprise-customization.md?source=llms.txt): How Enterprise customers can create a custom endpoint and benefit from Active Traffic Management and other advanced Ably features.
- [Organizations](https://ably.com/docs/platform/account/organizations.md?source=llms.txt): Manage Ably organizations, provision users, configure SSO with SCIM, and handle account roles.
- [Account overview](https://ably.com/docs/platform/account.md?source=llms.txt): Overview of the Ably dashboard for managing apps, account settings, team, billing, and usage.
- [Single sign-on \(SSO\)](https://ably.com/docs/platform/account/sso.md?source=llms.txt): Single sign-on enables users to authenticate with Ably using your own identity provider.
- [Team](https://ably.com/docs/platform/account/team.md?source=llms.txt): Manage users, roles, and team access in your Ably account.
### Architecture
- [Connection recovery](https://ably.com/docs/platform/architecture/connection-recovery.md?source=llms.txt): Understand how Ably's platform ensures reliable connection recovery when clients experience network disruption.
- [Edge network](https://ably.com/docs/platform/architecture/edge-network.md?source=llms.txt): Understand how Ably's edge network provides reliable, low-latency connectivity to its platform from anywhere in the world.
- [Fault tolerance](https://ably.com/docs/platform/architecture/fault-tolerance.md?source=llms.txt): Understand how Ably's platform is built to be fault tolerant to ensure high availability and reliability to clients.
- [Infrastructure operations](https://ably.com/docs/platform/architecture/infrastructure-operations.md?source=llms.txt): Understand how Ably manages its infrastructure operations to ensure continued reliability and availability of its platform.
- [Idempotency](https://ably.com/docs/platform/architecture/idempotency.md?source=llms.txt): Understand how Ably provides exactly-once message delivery through idempotent publishing.
- [Architecture overview](https://ably.com/docs/platform/architecture.md?source=llms.txt): Learn more about Ably's platform architecture.
- [Latency](https://ably.com/docs/platform/architecture/latency.md?source=llms.txt): Understand Ably's latency performance metrics and how they ensure consistent, low-latency message delivery across the global platform.
- [Message ordering](https://ably.com/docs/platform/architecture/message-ordering.md?source=llms.txt): Understand how Ably achieves reliable message ordering across its platform.
- [Scalability of the Ably platform](https://ably.com/docs/platform/architecture/platform-scalability.md?source=llms.txt): Understand how Ably's platform achieves horizontal scalability to handle large-scale realtime messaging.
- [Performance](https://ably.com/docs/platform/architecture/performance.md?source=llms.txt): Understand how Ably delivers messages quickly and efficiently, even at high volumes.
### Authentication
- [Basic auth](https://ably.com/docs/auth/basic.md?source=llms.txt): Basic authentication allows you to authenticate a secure server using an Ably API key and secret.
- [Identified clients](https://ably.com/docs/auth/identified-clients.md?source=llms.txt): Clients can be allocated a client ID to help control their operations and interactions with Ably channels.
- [Capabilities](https://ably.com/docs/auth/capabilities.md?source=llms.txt): Capabilities define which operations can be carried out on which channels by a client.
- [Authentication overview](https://ably.com/docs/auth.md?source=llms.txt): Ably supports two main authentication schemes: basic authentication and token authentication. Token authentication can be implemented using JWTs, Ably tokens, and Ably token requests.
- [Token revocation](https://ably.com/docs/auth/revocation.md?source=llms.txt): Token revocation is a mechanism that enables an app to invalidate authentication tokens.
- [Ably Tokens](https://ably.com/docs/auth/token/ably-tokens.md?source=llms.txt): Ably Tokens are an alternative to JWTs when you need to keep capabilities confidential or when your capability list is very large.
- [Token auth](https://ably.com/docs/auth/token.md?source=llms.txt): Token authentication allows clients to authenticate with Ably, without exposing the Ably API key and secret.
- [JSON Web Tokens \(JWTs\)](https://ably.com/docs/auth/token/jwt.md?source=llms.txt): JWT authentication is the recommended approach for authenticating clients with Ably. Create JWTs signed with your Ably API key.
### Deprecations
- [Deprecation policy](https://ably.com/docs/platform/deprecate.md?source=llms.txt): A policy detailing how Ably deprecates SDKs and APIs.
- [Deprecation of protocol version 1 - November 2025](https://ably.com/docs/platform/deprecate/protocol-v1.md?source=llms.txt): Details on the deprecation of Ably's realtime protocol version 1 and migration to protocol version 2.
- [Deprecation of TLS 1.0 and 1.1 - June 2025](https://ably.com/docs/platform/deprecate/tls-v1-1.md?source=llms.txt): A policy detailing how Ably is deprecating support for TLS 1.0 and 1.1.
### Errors
- [Debugging](https://ably.com/docs/platform/errors.md?source=llms.txt): Debugging in Ably supported apps, including troubleshooting techniques, logging options, and tools for error analysis.
- [10000: No error](https://ably.com/docs/platform/errors/codes/10000-no-error.md?source=llms.txt): A placeholder code indicating success, used where an error code is expected but the operation completed normally. It does not represent a failure.
- [101000: Space name is empty](https://ably.com/docs/platform/errors/codes/101000-space-name-is-empty.md?source=llms.txt): A space could not be created or referenced because no name was supplied.
- [101001: Space must be entered first](https://ably.com/docs/platform/errors/codes/101001-space-must-be-entered-first.md?source=llms.txt): An operation was attempted that requires having first entered the space. In Ably Spaces, actions such as updating a member's location or profile are only available once the space has been entered.
- [101002: Lock request already pending](https://ably.com/docs/platform/errors/codes/101002-lock-request-already-pending.md?source=llms.txt): A lock could not be requested because a request for the same lock is already in progress. In Ably Spaces, a member may only have one outstanding request for a given lock at a time.
- [101003: Lock already held](https://ably.com/docs/platform/errors/codes/101003-lock-already-held.md?source=llms.txt): A lock could not be acquired because it is currently held by another member. In Ably Spaces, only one member can hold a given lock at a time, and it must be released before another can take it.
- [101004: Lock invalidated by concurrent request](https://ably.com/docs/platform/errors/codes/101004-lock-invalidated-by-concurrent-request.md?source=llms.txt): A lock that appeared to be acquired was invalidated because another member requested the same lock concurrently and now holds it.
- [102000: Invalid chat room name](https://ably.com/docs/platform/errors/codes/102000-invalid-chat-room-name.md?source=llms.txt): A Chat room could not be used because the name supplied for it was not valid.
- [102002: Room attach failed for presence](https://ably.com/docs/platform/errors/codes/102002-room-attach-failed-for-presence.md?source=llms.txt): Attaching a Chat room failed because its presence feature could not be attached.
- [102001: Room attach failed for messages](https://ably.com/docs/platform/errors/codes/102001-room-attach-failed-for-messages.md?source=llms.txt): Attaching a Chat room failed because its messages feature could not be attached.
- [102003: Room attach failed for reactions](https://ably.com/docs/platform/errors/codes/102003-room-attach-failed-for-reactions.md?source=llms.txt): Attaching a Chat room failed because its reactions feature could not be attached.
- [102004: Room attach failed for occupancy](https://ably.com/docs/platform/errors/codes/102004-room-attach-failed-for-occupancy.md?source=llms.txt): Attaching a Chat room failed because its occupancy feature could not be attached.
- [102050: Room detach failed for messages](https://ably.com/docs/platform/errors/codes/102050-room-detach-failed-for-messages.md?source=llms.txt): Detaching a Chat room failed because its messages feature could not be detached.
- [102005: Room attach failed for typing](https://ably.com/docs/platform/errors/codes/102005-room-attach-failed-for-typing.md?source=llms.txt): Attaching a Chat room failed because its typing feature could not be attached.
- [102051: Room detach failed for presence](https://ably.com/docs/platform/errors/codes/102051-room-detach-failed-for-presence.md?source=llms.txt): Detaching a Chat room failed because its presence feature could not be detached.
- [102052: Room detach failed for reactions](https://ably.com/docs/platform/errors/codes/102052-room-detach-failed-for-reactions.md?source=llms.txt): Detaching a Chat room failed because its reactions feature could not be detached.
- [102053: Room detach failed for occupancy](https://ably.com/docs/platform/errors/codes/102053-room-detach-failed-for-occupancy.md?source=llms.txt): Detaching a Chat room failed because its occupancy feature could not be detached.
- [102054: Room detach failed for typing](https://ably.com/docs/platform/errors/codes/102054-room-detach-failed-for-typing.md?source=llms.txt): Detaching a Chat room failed because its typing feature could not be detached.
- [102100: Room continuity not guaranteed](https://ably.com/docs/platform/errors/codes/102100-room-continuity-not-guaranteed.md?source=llms.txt): A discontinuity was detected on the Chat room, so the continuity of messages could not be guaranteed. This usually follows a disconnection long enough that the room could not resume from where it left off.
- [102101: Room is in the failed state](https://ably.com/docs/platform/errors/codes/102101-room-is-in-the-failed-state.md?source=llms.txt): The operation could not be performed because the Chat room is in the failed state. A room enters this state when an earlier operation on it failed and could not recover.
- [102102: Room is being released](https://ably.com/docs/platform/errors/codes/102102-room-is-being-released.md?source=llms.txt): The operation could not be performed because the Chat room is in the process of being released.
- [102103: Room has been released](https://ably.com/docs/platform/errors/codes/102103-room-has-been-released.md?source=llms.txt): The operation could not be performed because the Chat room has already been released.
- [102105: Unknown room lifecycle error](https://ably.com/docs/platform/errors/codes/102105-unknown-room-lifecycle-error.md?source=llms.txt): An unexpected error occurred in the Chat room lifecycle that does not correspond to a known condition.
- [102104: Room operation failed after earlier attempt](https://ably.com/docs/platform/errors/codes/102104-room-operation-failed-after-earlier-attempt.md?source=llms.txt): The operation failed because a preceding attempt to perform it had already failed.
- [102106: Room released before operation completed](https://ably.com/docs/platform/errors/codes/102106-room-released-before-operation-completed.md?source=llms.txt): The operation could not complete because the Chat room was released while it was still in progress.
- [102108: Feature not enabled in room options](https://ably.com/docs/platform/errors/codes/102108-feature-not-enabled-in-room-options.md?source=llms.txt): The operation required a feature that was not enabled when the Chat room was created. Features such as presence or typing indicators must be enabled in the room options to be used.
- [102109: History requested for an unsubscribed listener](https://ably.com/docs/platform/errors/codes/102109-history-requested-for-an-unsubscribed-listener.md?source=llms.txt): A request for the messages published before a listener's subscription point was rejected because that listener was not subscribed. This history is only available while the listener is subscribed to the room.
- [102110: Channel serial not defined](https://ably.com/docs/platform/errors/codes/102110-channel-serial-not-defined.md?source=llms.txt): A channel serial was expected but was not defined at the point it was needed.
- [102112: Room is in an invalid state](https://ably.com/docs/platform/errors/codes/102112-room-is-in-an-invalid-state.md?source=llms.txt): The operation could not be performed because the Chat room was in a state that does not permit it.
- [102107: Room already exists with different options](https://ably.com/docs/platform/errors/codes/102107-room-already-exists-with-different-options.md?source=llms.txt): A Chat room with the same name already exists but was created with different options. A room must be released before it can be requested again with a different configuration.
- [102113: Sequential execution could not be enforced](https://ably.com/docs/platform/errors/codes/102113-sequential-execution-could-not-be-enforced.md?source=llms.txt): The operation failed because its sequential execution could not be enforced. Chat room lifecycle operations are expected to run one at a time, and that ordering could not be guaranteed.
- [102111: Channel options modified after request](https://ably.com/docs/platform/errors/codes/102111-channel-options-modified-after-request.md?source=llms.txt): Channel options could not be changed because the underlying channel had already been requested.
- [102200: Hook used outside its provider](https://ably.com/docs/platform/errors/codes/102200-hook-used-outside-its-provider.md?source=llms.txt): An Ably Chat React hook was used in a component that is not wrapped in the required provider. The hooks depend on context supplied by a provider higher in the component tree.
- [102202: Presence data could not be fetched](https://ably.com/docs/platform/errors/codes/102202-presence-data-could-not-be-fetched.md?source=llms.txt): The Ably Chat React hooks could not retrieve presence data after the maximum number of retries. This usually points to a persistent problem reaching presence rather than a transient one.
- [102201: Component unmounted before completion](https://ably.com/docs/platform/errors/codes/102201-component-unmounted-before-completion.md?source=llms.txt): An operation started by the Ably Chat React hooks could not finish because the React component was unmounted while it was still in progress.
- [103000: Push notification internal error](https://ably.com/docs/platform/errors/codes/103000-unable-to-publish-push-notification.md?source=llms.txt): The push notification was not delivered because of an unexpected error within the Ably platform during preparation, dispatch, or requeue. The cause is not related to the contents of the request or the device's registration.
- [103001: Push notification retry limit reached](https://ably.com/docs/platform/errors/codes/103001-push-publish-retries-exhausted.md?source=llms.txt): The push notification was not delivered because the configured retry limit was reached after repeated unsuccessful delivery attempts. The underlying failures are typically transient, such as provider outages, rate limits, or network errors.
- [103002: Push notification recipient missing](https://ably.com/docs/platform/errors/codes/103002-push-direct-publish-no-recipient.md?source=llms.txt): The push notification was not delivered because the direct push request was submitted without a recipient device. Direct push targets a single device by ID and cannot be processed when no recipient is supplied.
- [103003: Push notification body invalid](https://ably.com/docs/platform/errors/codes/103003-push-cannot-handle-body.md?source=llms.txt): The push notification was not delivered because its body could not be processed. This typically indicates a malformed or unsupported message structure in the publish request.
- [103004: Push notification rejected by provider](https://ably.com/docs/platform/errors/codes/103004-push-notification-rejected-by-provider.md?source=llms.txt): The push notification was not delivered because the provider (APNs, FCM, or WebPush) rejected the request due to a problem with the payload or delivery parameters. Typical causes include an oversized payload, a disallowed topic, or an unsupported field.
- [103007: Push notification provider unreachable](https://ably.com/docs/platform/errors/codes/103007-push-notification-provider-unreachable.md?source=llms.txt): The push notification was not delivered because the provider (APNs, FCM, or WebPush) could not be reached, returned a server error, or sent a response that could not be processed. The condition is usually transient.
- [103008: Push transport credentials invalid](https://ably.com/docs/platform/errors/codes/103008-push-transport-credentials-invalid.md?source=llms.txt): A push notification could not be sent because the credentials configured for the target platform were rejected or had expired, such as an expired APNs certificate.
- [103006: Push transport not configured](https://ably.com/docs/platform/errors/codes/103006-push-transport-not-configured.md?source=llms.txt): The push notification was not delivered because the device's push notification provider (APNs, FCM, or WebPush) has no credentials configured on the application. No deliveries can be made through that provider until the credentials are present.
- [103010: Push recipient endpoint invalid](https://ably.com/docs/platform/errors/codes/103010-push-recipient-endpoint