# BlueBubbles SDK

## Docs

- [Attachments API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/attachments.md): Upload, download, and inspect iMessage attachments — including blurhash previews and Live Photos — using the BlueBubbles SDK AttachmentsService.
- [Backups API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/backups.md): Save, retrieve, and delete settings and theme backups stored on your BlueBubbles Server. Sync client configuration across devices.
- [Chats API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/chats.md): Create and manage iMessage chats, control participants, set group icons, handle read state, and send typing indicators with the BlueBubbles SDK.
- [Contacts API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/contacts.md): Fetch and query contacts stored on the macOS device running BlueBubbles Server. Look up contact details by one or more phone numbers or email addresses.
- [FCM API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/fcm.md): Retrieve your server's Firebase Cloud Messaging client config and register devices to receive push notifications from BlueBubbles Server.
- [Handles API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/handles.md): Query, count, and look up iMessage handles by address. Check iMessage and FaceTime availability, and read focus status for any handle.
- [Messages API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/messages.md): Send texts, attachments, and reactions, query message history, and manage scheduled messages using the BlueBubbles SDK MessagesService.
- [Server API reference — BlueBubbles SDK](https://bluebubbles.anmho.com/api/server.md): Inspect server metadata, read logs, manage alerts, restart services, view media statistics, and install updates for your BlueBubbles Server.
- [Authentication: Connecting to BlueBubbles Server](https://bluebubbles.anmho.com/authentication.md): Learn how BlueBubbles Server password-based authentication works, how to pass credentials to the SDK, and how to handle authentication failures.
- [The BlueBubblesClient: SDK entry point](https://bluebubbles.anmho.com/concepts/client.md): Learn how to instantiate BlueBubblesClient, configure authentication and HTTP options, and navigate its resource-grouped service properties.
- [Understanding GUIDs in BlueBubbles](https://bluebubbles.anmho.com/concepts/guids.md): Understand the GUID format used across the BlueBubbles API — how chats, messages, attachments, and handles are identified and referenced in SDK calls.
- [Private API features in BlueBubbles SDK](https://bluebubbles.anmho.com/concepts/private-api.md): Discover which BlueBubbles SDK features require the Private API, how to enable it, and how to call Private API-backed methods in your application.
- [Work with Attachments in the BlueBubbles SDK](https://bluebubbles.anmho.com/guides/attachments.md): Upload files before multipart sends, download attachments by GUID, generate blurhashes for placeholders, and retrieve live photo videos.
- [Manage iMessage Chats with the BlueBubbles SDK](https://bluebubbles.anmho.com/guides/managing-chats.md): List, create, and manage iMessage chats with the BlueBubbles SDK — add participants, mark read state, send typing indicators, and delete chats.
- [Schedule iMessages with the BlueBubbles SDK](https://bluebubbles.anmho.com/guides/scheduled-messages.md): Schedule iMessages for future one-time delivery or on a recurring cadence — hourly, daily, weekly, monthly, or yearly — with full CRUD support.
- [Send iMessages with the BlueBubbles SDK](https://bluebubbles.anmho.com/guides/sending-messages.md): Send plain text, file attachments, multipart messages with mentions, and tapback reactions to any iMessage chat using the BlueBubbles TypeScript SDK.
- [BlueBubbles TypeScript SDK: iMessage automation](https://bluebubbles.anmho.com/introduction.md): A production-ready TypeScript SDK for the BlueBubbles Server REST API. Send messages, manage chats, and automate iMessage workflows with full type safety.
- [Quickstart: Send your first iMessage with the SDK](https://bluebubbles.anmho.com/quickstart.md): Install the BlueBubbles TypeScript SDK, connect to your server, and send a text message in under five minutes with this step-by-step guide.
- [Handle errors from the BlueBubbles SDK](https://bluebubbles.anmho.com/resources/error-handling.md): Learn how to catch ApiError exceptions, inspect HTTP status codes, and cancel in-flight requests using CancelablePromise in the BlueBubbles SDK.
- [TypeScript support in the BlueBubbles SDK](https://bluebubbles.anmho.com/resources/typescript.md): Explore the types, generics, and configuration interfaces exported by the BlueBubbles SDK to build fully type-safe integrations in TypeScript.