API Documentation

Welcome to the AstroSafe API documentation. These APIs provide a comprehensive set of tools for managing devices, users, content, and compliance requirements in a secure and scalable way.
We understand that every integration is unique, so as part of your onboarding we’ll schedule a call with your team. During this session, we’ll walk through how AstroSafe’s APIs can best fit into your existing systems and answer any technical questions you may have.
If you’d like more detailed guidance or a personalized tour of the platform, our team is happy to help.
Get a free Consultation
Table of Contents
Device Management
Device Statistics
User Management
Content Management
Session Management
Filtering & Moderation
COPPA Rulebook
ClearSearch

Device Management

AstroSafe’s Device Management APIs allow you to create, organize, and control devices under a single account. They support configuration of access policies such as screen-time limits, allowed usage windows, and remote locking.
POST
/auth/login
Authenticate a user and issue credentials for accessing AstroSafe resources.
POST
/devices
Create a new device entry.
GET
/devices
Retrieve a list of devices, filtered by groups or device IDs.
GET
/devices/{id}
Retrieve details for a specific device.
GET
/devices/{company}/{id}
Retrieve a device’s external ID from a company database.
DELETE
/devices/{id}
Delete a device and all associated data.
POST
/devices/{id}/config/screentime/allowed
Create a new allowed usage window.
PATCH
/devices/{id}/config/screentime/allowed/{id}
Update an allowed usage window.
PATCH
/devices/{id}/config/screentime/limits/{id}
Update total screen-time for a day.
POST
/devices/{id}/configs/enabled
Toggle app accessibility (kill switch).

Device Statistics

The Device Statistics APIs enable collection and analysis of device activity data, including activity type, duration, and timestamps. They also support COPPA compliance, allowing parents to view, delete, or disable future non-essential data collection.
GET
/devices/{id}/consent
Get the current consent data collection consent status for a device.
POST
/devices/{id}/consent
Enable or disable future non-essential data collection.
POST
/devices/{id}/history
Record a new activity entry.
GET
/devices/{id}/history
Retrieve a device’s activity history.
DELETE
/devices/{id}/history
Delete a time window of activity history.
GET
/devices/{id}/statistics
Retrieve aggregated usage statistics (daily totals, by category).
GET
/devices/{id}/insights
Retrieve AI-generated insights with suggested actions and alerts.

User Management

Groups are collections of devices and users managed together. A group typically includes devices running the app and adults with access to the parent portal. Groups also support a universal PIN for secure access. Users are typically adults (e.g., parents) who access the parent portal. These APIs manage who has access and their permissions.
POST
/groups
Create a new group with devices and users.
GET
/groups/{id}
Retrieve details for a group, including devices, users, and configurations.
DELETE
/groups/{id}
Delete a group and all its associated devices and users.
PATCH
/groups/{id}/pin
Update the PIN for parent portal access.
GET
/users
Retrieve multiple users, filtered by group or user IDs.
GET
/users/{id}
Retrieve details for a specific user.
PATCH
/users/{id}
Update user details (name, email, access level).
DELETE
/users/{id}
Delete a user and associated content.

Content Management

The Content Management APIs enable creation, organization, and distribution of content to devices. Content is structured with a title and image, plus either a URL or content body. Content collections are grouped into buckets.
POST
/content/buckets
Create a new content bucket.
GET
/content/buckets
Retrieve buckets by group ID or bucket IDs.
GET
/content/buckets/{id}
Retrieve a specific bucket and its contents.
POST
/content/buckets/{id}/devices
Assign a device to a content bucket.
POST
/content
Add content (title, image, URL, or body) to a bucket.
GET
/content
Retrieve content by bucket ID or content IDs.
GET
/content/{id}
Retrieve a specific content item.
POST
/devices/{id}/requests
Submit a request for access to a resource (resolvable in parent portal).
GET
/devices/{id}/requests
Retrieve all access requests for a device.

Session Management

The Sessions API enables real-time communication between parent portals and devices. It supports live updates of settings, enforcement of time limits, enabling/disabling the app, and streaming activity data.
GET
/sessions/groups/{groupId}
Establish a WebSocket connection for a group to stream activity, and control access in real time.
GET
/sessions/groups/{groupId}/devices
Retrieve the online status of devices in a group.

Filtering & Moderation

The Filtering APIs control what content can be accessed on devices. Filters can be applied to devices and configured to block access based on keywords or categories.
GET
/filters
Retrieve filters by group or filter IDs.
GET
/filters/{id}
Retrieve a specific filter.
PATCH
/filters/{id}
Update filter details (name, description, group ID).
DELETE
/filters/{id}
Delete a filter.
GET
/filters/{id}/devices
Retrieve devices where a filter is applied.
POST
/filters/{id}/devices
Assign a device to a filter.
DELETE
/filters/{id}/devices
Remove a device from a filter.
GET
/filters/{id}/blocklist/words
Retrieve blocked keywords.
POST
/filters/{id}/blocklist/words
Add keywords to the blocklist.
DELETE
/filters/{id}/blocklist/words
Remove keywords from the blocklist.
GET
/filters/{id}/blocklist/category
Retrieve allowed categories.
POST
/filters/{id}/blocklist/category
Add categories to the allowlist.
DELETE
/filters/{id}/blocklist/category
Remove categories from the allowlist.
GET
/shield/text
Applies moderation to text input and flags content as appropriate.
GET
/shield/image
Applies moderation to image input and flags content as appropriate.

COPPA Rulebook

The Rulebook APIs define and manage rules around data collection and retention to ensure COPPA compliance. Note: Several endpoints here overlap with those in the Device Statistics API (Haystack). They are repeated in this section for clarity because they directly support COPPA compliance.
POST
/rulebook/data
Specify the type of data being collected and the reason for its collection and its associated justification.
DELETE
/rulebook/data
Remove a type of data being collected and its associated justification.
GET
/rulebook/check
Retrieve the list of data types currently being collected.
GET
/devices/{id}/retention
Set the data retention policy for a device.
POST
/devices/{id}/retention
Set the data retention policy for a device.
GET
/devices/{id}/consent
Get the current consent data collection consent status for a device.
POST
/devices/{id}/consent
Enable or disable future non-essential data collection.
GET
/devices/{id}/history
Retrieve a device’s activity history.
DELETE
/devices/{id}/history
Delete a specified time window of activity history.
GET
/devices/{id}/statistics
Retrieve summary statistics of user activity, including time spent per day and aggregated topics.

ClearSearch

ClearSearch is AstroSafe’s end-to-end search solution, offered as a managed service. It enables customers to define what data they want to make searchable, configure how their data is indexed, and leverage neural search technology for more relevant and intelligent results. ClearSearch is designed to be COPPA-compliant, ensuring safe handling of sensitive data while still enabling powerful search capabilities. To learn more or enable ClearSearch for your account, please contact us.
GET
/search
Retrieve indexed content based on user query and parameters.
GET
/agent
Agent mode customisable to customers' needs. Streams conversational output

SDKs & Beyond!

Integrate AstroSafe’s SDK to embed our Safe Video Player and real-time WebSocket capabilities directly into your existing applications—no heavy lifting required.
Interested in adding the AstroSafe Safe Browser experience for kids? Book a call and we’ll walk through how the integration works end to end.

Need some help?

If you’d like to learn more about AstroSafe, need technical support, or have questions about your integration, we’re here to help. You can reach us anytime at hello@astrosafe.co.
If email isn’t convenient, simply use the buttons below to explore more about our product or book a call with our team for direct support — we’ll make sure you have everything you need to succeed.
Learn More
Book a Demo

SDKs & Beyond!

Integrate AstroSafe’s SDK to embed our Safe Video Player and real-time WebSocket capabilities directly into your existing applications—no heavy lifting required.
Interested in adding the AstroSafe Safe Browser experience for kids? Book a call and we’ll walk through how the integration works end to end.