Not found at this URL
https://docs.appio.so/llms-full.txt ↗- Discovery
- Conventional sibling path checked
- HTTP response
- 404 · text/html; charset=utf-8
Developer tools · llms.txt file breakdown
A directly retrieved Markdown index for Appio's documentation, with 23 links across 5 detected headings.
The actual file
The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.
Showing the first 18000 characters. Load the complete file to read the remainder.
# Appio Documentation
- [Overview](#overview)
- [Getting Started](#getting-started)
- [API Overview](#api-overview)
- [API Services](#api-services)
- [API Devices](#api-devices)
- [API Notifications](#api-notifications)
- [API errors](#api-errors)
- [AI Instructions](#ai)
## Overview
Appio helps businesses add widgets and notifications to their products, without building or maintaining mobile apps, hiring developers, or dealing with app stores.
Learn more about [Appio](https://appio.so), try our [interactive demo](https://demo.appio.so), or explore our [case studies](https://appio.so/#case-studies).
Found an issue or have feedback? [Let us know!](https://appio.so/contact)
## Getting Started
Before getting started, you'll need to [create an account](https://my.appio.so) and obtain your service\_id.
There are two integration options for Appio, both functionally identical.
### Option 1
Preview
Install code
```
<script src="https://cdn.appio.so/v1/appio.js"></script>
<script>
const appio = Appio({
service: "svc_00dddddd000000ccccccssssss"
})
function mobileApp() {
appio.open({
user: "23d0e9848fe0ad06272dea39a03679ff"
})
}
</script>
<a href="#" onclick="mobileApp()">Mobile APP</a>
```
Appio
service
Use your service ID, which was assigned to you during registration.
Replace svc\_\*\*YOUR\*SERVICE\*ID\*\* with your [service id](https://my.appio.so).
eventCallback
_optional_
Callback function to receive events from Appio.
function (type, data)
Appio.open
user
A unique identifier for your user. For security, use a non-sequential, non-predictable string.
Suggestion: Hash the customer’s unique ID and registration date using a function like SHA-256 or MD5.
service
_optional_
Use your service ID, which was assigned to you during registration.
* * *
### Option 2
Preview
Install code
```
<script src="https://cdn.appio.so/v1/appio.js"></script>
<a
data-appio="on"
data-service="svc_00dddddd000000ccccccssssss"
data-user="23d0e9848fe0ad06272dea39a03679ff"
href="#"
>
Mobile APP
</a>
```
data-appio
Activates Appio. The field is required, but its _value_ is optional and can be omitted.
data-service
Use your service ID, which was assigned to you during registration.
Replace svc\_\*\*YOUR\*SERVICE\*ID\*\* with your [service id](https://my.appio.so).
data-user
A unique identifier for your user. For security, use a non-sequential, non-predictable string.
Suggestion: Hash the customer’s unique ID and registration date using a function like SHA-256 or MD5.
## API Overview
All commands in this documentation are live and ready for testing.
**NOTE**:
Data is automatically reset every 15 minutes.
This will deactivate the "Appio Docs" service on your device.
### Authentication
All API requests must include an [authentication token](https://my.appio.so).
Each registered service is issued a unique authentication token.
You can validate your token by calling the testing endpoint:
Request
```
curl https://api.appio.so/hi \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A"
```
Response
```
HTTP Code: 200
```
```
👋
```
## API Services
### View service details
Returns the details of a single service.
The X-Service-Id header must match the {id} path parameter.
Path
```
GET /v1/services/{id}
```
Request
```
curl -X GET https://api.appio.so/v1/services/svc_00dddddd000000ccccccssssss \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"id": "svc_00dddddd000000ccccccssssss",
"title": "Appio Docs",
"description": "Try out the functionality of Appio by downloading the app.",
"logo_url": "https://cdn.appio.so/app/docs.appio.so/logo.png",
"banner_url": "https://cdn.appio.so/app/docs.appio.so/banner.jpg",
"url": "https://docs.appio.so",
"text_color": "#000000",
"background_color": "#ffffff",
"accent_color": "#0066cc"
}
```
## API Devices
### List devices subscribed to service
Returns a paginated list of devices subscribed to the service.
platform is one of ios, android or watchos.
#### Pagination parameters
limit
_optional_
Integer. Default: 50. Min: 1, Max: 100.
Maximum number of items to return.
after
_optional_
String. Cursor ID for pagination — returns items after this ID.
Path
```
GET /v1/devices
```
Request
```
curl -X GET https://api.appio.so/v1/devices \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"data": [
{
"id": "dvc_01jmpmh9fvxgyym44sqanjr9hs",
"user_id": "23d0e9848fe0ad06272dea39a03679ff",
"name": "iPhone 13",
"platform": "ios",
"os_version": "18.3",
"model": "iPhone",
"device_token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"notifications_enabled": true,
"device_identifier": "iPhone14,5",
"marketing_name": "iPhone 13"
},
...
],
"pagination": {
"next": "https://api.appio.so/v1/devices?after=dvc_01jmpmh9fvxgyym44sqanjr9hs"
}
}
```
* * *
### View device details
Path
```
GET /v1/devices/{id}
```
Request
```
curl -X GET https://api.appio.so/v1/devices/dvc_01jmpmh9fvxgyym44sqanjr9hs \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"id": "dvc_01jmpmh9fvxgyym44sqanjr9hs",
"user_id": "23d0e9848fe0ad06272dea39a03679ff",
"name": "iPhone 13",
"platform": "ios",
"os_version": "18.3",
"model": "iPhone",
"device_token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"notifications_enabled": true,
"device_identifier": "iPhone14,5",
"marketing_name": "iPhone 13"
}
```
* * *
### Deactivate device
Deactivate a device when it should no longer receive notifications or when its associated user has been deactivated.
Path
```
DELETE /v1/devices/{id}
```
Request
```
curl -X DELETE https://api.appio.so/v1/devices/dvc_01jmpmh9fvxgyym44sqanjr9hs \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"id": "dvc_01jmpmh9fvxgyym44sqanjr9hs"
}
```
* * *
### Deactivate all user devices
Deactivate all of a user’s devices when they should no longer receive notifications or when the user has been deactivated.
Path
```
DELETE /v1/devices?user_id={user_id}
```
Request
```
curl -X DELETE https://api.appio.so/v1/devices?user_id=23d0e9848fe0ad06272dea39a03679ff \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
[
{
"id": "dvc_01jmpmh9fvxgyym44sqanjr9hs"
},
...
]
```
## API Notifications
### Notification request
payload
[Notification payload](#api-notifications-payload)
scheduled\_at
_optional_
String. [RFC 3339 format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
Specifies the date and time to schedule the notification for future delivery, up to 30 days in advance. Must be in the future.
Empty value means immediate delivery.
### Notification payload
title
String. Max 50 characters.
message
String. Max 200 characters.
link
_optional_
String. Valid URL.
image\_url
_optional_
String. Image url.
Image dimension ratio 16/9, up to 3MB.
Allowed formats: .gif, .jpg, .png, .webp
### Notification status
created
All device deliveries exist and are waiting to be sent.
queued
All device deliveries exist and are waiting to be sent.
completed
The notification has been processed and no delivery is pending.
failed
The notification could not be processed.
skipped
The notification was not sent out.
### Filter options
status
_optional_
String. Filter notifications by status: created, queued, completed, failed, skipped
device\_id
_optional_
String. Filter notifications for a specific device.
user\_id
_optional_
String. Filter notifications for a specific user.
If both device\_id and user\_id are provided, only device\_id is used.
### Pagination parameters
limit
_optional_
Integer. Default: 50. Min: 1, Max: 100.
Maximum number of items to return.
after
_optional_
String. Cursor ID for pagination — returns items after this ID.
* * *
### List notifications
Path
```
GET /v1/notifications
```
Request
```
curl -X GET https://api.appio.so/v1/notifications \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"data": [
{
"id": "ntf_01jmpmgb6my0s57c960q1s862v",
"service_id": "svc_00dddddd000000ccccccssssss",
"status": "completed",
"payload": {
"link": "https://docs.appio.so",
"title": "Notification",
"message": "Hello from Appio Docs",
"image_url": "https://cdn.appio.so/app/docs.appio.so/banner.jpg"
},
"scheduled_at": "2025-03-24T14:23:37.016526Z"
},
...
],
"pagination": {
"next": "https://api.appio.so/v1/notifications?after=ntf_01jmpmgb6my0s57c960q1s862v"
}
}
```
* * *
### List delivered notifications
Path
```
GET /v1/notifications?status=completed
```
Request
```
curl -X GET https://api.appio.so/v1/notifications?status=completed \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"data": [
{
"id": "ntf_01jmpmgb6my0s57c960q1s862v",
"service_id": "svc_00dddddd000000ccccccssssss",
"status": "completed",
"payload": {
"link": "https://docs.appio.so",
"title": "Notification",
"message": "Hello from Appio Docs",
"image_url": "https://cdn.appio.so/app/docs.appio.so/banner.jpg"
},
"scheduled_at": "2025-03-24T14:23:37.016526Z"
},
...
],
"pagination": {
"next": "https://api.appio.so/v1/notifications?status=completed&after=ntf_01jmpmgb6my0s57c960q1s862v"
}
}
```
* * *
### List notifications for a device
Path
```
GET /v1/notifications?device_id={device_id}
```
Request
```
curl -X GET https://api.appio.so/v1/notifications?device_id=dvc_01jmpmh9fvxgyym44sqanjr9hs \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"data": [
{
"id": "ntf_01jmpmgb6my0s57c960q1s862v",
"service_id": "svc_00dddddd000000ccccccssssss",
"status": "completed",
"payload": {
"link": "https://docs.appio.so",
"title": "Notification",
"message": "Hello from Appio Docs",
"image_url": "https://cdn.appio.so/app/docs.appio.so/banner.jpg"
},
"scheduled_at": "2025-03-24T14:23:37.016526Z"
},
...
],
"pagination": {
"next": "https://api.appio.so/v1/notifications?device_id=dvc_01jmpmh9fvxgyym44sqanjr9hs&after=ntf_01jmpmgb6my0s57c960q1s862v"
}
}
```
* * *
### List notifications for a user
Path
```
GET /v1/notifications?user_id={user_id}
```
Request
```
curl -X GET https://api.appio.so/v1/notifications?user_id=23d0e9848fe0ad06272dea39a03679ff \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"data": [
{
"id": "ntf_01jmpmgb6my0s57c960q1s862v",
"service_id": "svc_00dddddd000000ccccccssssss",
"status": "completed",
"payload": {
"link": "https://docs.appio.so",
"title": "Notification",
"message": "Hello from Appio Docs",
"image_url": "https://cdn.appio.so/app/docs.appio.so/banner.jpg"
},
"scheduled_at": "2025-03-24T14:23:37.016526Z"
},
...
],
"pagination": {
"next": "https://api.appio.so/v1/notifications?user_id=23d0e9848fe0ad06272dea39a03679ff&after=ntf_01jmpmgb6my0s57c960q1s862v"
}
}
```
* * *
### View notification details
View a notification's details, including its sending status.
Each notification may be delivered to multiple devices.
Path
```
GET /v1/notifications/{id}
```
Request
```
curl -X GET https://api.appio.so/v1/notifications/ntf_01jmpmgb6my0s57c960q1s862v \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss"
```
Response
```
HTTP Code: 200
```
```
{
"id": "ntf_01jmpmgb6my0s57c960q1s862v",
"service_id": "svc_00dddddd000000ccccccssssss",
"status": "completed",
"payload": {
"link": "https://docs.appio.so",
"title": "Notification",
"message": "Hello from Appio Docs",
"image_url": "https://cdn.appio.so/app/docs.appio.so/banner.jpg"
},
"scheduled_at": "2025-03-24T14:23:37.016526Z",
"delivery_stats": {
"total": 1,
"created": 0,
"queued": 0,
"completed": 1,
"failed": 0,
"skipped": 0
}
}
```
* * *
### Target options
The audience of POST /v1/notifications is chosen by two optional query parameters:
device\_id
_optional_
String. Deliver to that single device.
user\_id
_optional_
String. Deliver to all devices of that user.
Omitting both sends the notification to every device. This is the default behaviour.
If both are given, device\_id is used and user\_id is ignored.
Notification is delivered only to _eligible_ devices: devices that are linked to the service, have notifications enabled, and have a push token.
Targeted notification (<var>device_id</var> / <var>user_id</var>) sent to an empty audience returns 404 and creates nothing
A notification sent to a service with no eligible devices is still created and completes with zero deliveries.
* * *
### Send a notification to all subscribed devices
Sent to every eligible device linked to the service.
A broadcast is fanned out by the queueing cron, which does not pick the notification up before scheduled\_at has passed. Until then it reports status: created and has no deliveries; it becomes queued once every per-device delivery exists.
Path
```
POST /v1/notifications
```
Request
```
curl -X POST https://api.appio.so/v1/notifications \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "Content-Type: application/json" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss" \
-d '{"payload":{"title":"Notification","message":"Hello from Appio Docs"}}'
```
Request body
```
{
"payload": {
"title": "Notification",
"message": "Hello from Appio Docs"
}
}
```
Response
```
HTTP Code: 201
```
```
{
"id": "ntf_01jv7938vhvsccakmeq7c1hcy8"
}
```
* * *
### Send a scheduled notification to a user
Sends a notification to all eligible devices belonging to this user.
Returns 404, and creates nothing, if the user is unknown to the service or none of their devices can receive a push.
The per-device deliveries are created immediately, so the notification reports status: queued from creation onwards; the deliveries are simply held back until scheduled\_at.
Path
```
POST /v1/notifications?user_id={user_id}
```
Request
```
curl -X POST https://api.appio.so/v1/notifications?user_id=23d0e9848fe0ad06272dea39a03679ff \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "Content-Type: application/json" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss" \
-d '{"payload":{"title":"Notification","message":"Hello from Appio Docs"},"scheduled_at":"2025-03-24T14:23:37.016526Z"}'
```
Request body
```
{
"payload": {
"title": "Notification",
"message": "Hello from Appio Docs"
},
"scheduled_at": "2025-03-24T14:23:37.016526Z"
}
```
Response
```
HTTP Code: 201
```
```
{
"id": "ntf_01jv7akwwbj47rf3je11jgpvvf"
}
```
* * *
### Send a notification to a single device
Sends a notification to one device.
Returns 404, and creates nothing, if the device is unknown to the service or cannot receive a push (notifications disabled, no push token).
The delivery is created immediately, so the notification reports status: queued from creation onwards.
Path
```
POST /v1/notifications?device_id={device_id}
```
Request
```
curl -X POST https://api.appio.so/v1/notifications?device_id=dvc_01jmpmh9fvxgyym44sqanjr9hs \
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \
-H "Content-Type: application/json" \
-H "X-Service-Id: svc_00dddddd000000ccccccssssss" \
-d '{"payload":{"title":"Notification","message":"Hello from Appio Docs"}}'
```
Request body
```
{
"payload": {
"title": "Notification",
"message": "Hello from Appio Docs"
}
}
```
Response
```
HTTP Code: 201
```
```
{
"id": "ntf_01jmpmgb6my0s57c960q1s862v"
}
```
## API Errors
400
Bad Request
The request contains invalid or missing data.
Please double-check the API endpoint URL and ensure the request body is correctly formatted and complete.
401
Unauthorized
Authentication is required.
Ensure that a valid access token is included in the request headers.
402
Payment Required
Your organizationMeasured from the saved file
Size measures the captured UTF-8 text, not compressed transfer size. Tokens are counted with a named tokenizer; other models can count differently. Neither measure establishes context compatibility or answer quality.
Context architecture
8 H2 sections organize 23 parsed Markdown links. 0 links point to .md or .markdown paths; 11 link occurrences use another hostname. Linked destinations have not been recursively validated.
| H2 section | Links | UTF-8 bytes | Tokens |
|---|---|---|---|
| OverviewLine 12 | 4 | 400 | 92 |
| Getting StartedLine 20 | 3 | 1844 | 499 |
| API OverviewLine 109 | 1 | 593 | 161 |
| API ServicesLine 140 | 0 | 864 | 280 |
| API DevicesLine 181 | 0 | 3087 | 1067 |
| API NotificationsLine 350 | 2 | 10483 | 3156 |
| API ErrorsLine 850 | 2 | 1556 | 327 |
| AI InstructionsLine 919 | 3 | 221 | 61 |
Link counts exclude parsed fenced and inline code and resolve relative destinations against the final endpoint. Section sizes cover the text below each H2 until the next H2.
Embedded material
Embedded example text and links to further documentation are counted separately. A code block does not establish that a sample runs or that an authentication flow succeeds.
Source line 127 · unlabeled
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A"Source line 157 · unlabeled
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \Source line 211 · unlabeled
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \Source line 258 · unlabeled
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \Source line 299 · unlabeled
-H "Authorization: Bearer docs_g3psUMsuKZ7NGGJvuk1csf47pvJfukz97cS5ZrOuHnY98yhY5A" \Source line 150 · unlabeled
GET /v1/services/{id}Source line 156 · unlabeled
curl -X GET https://api.appio.so/v1/services/svc_00dddddd000000ccccccssssss \Source line 204 · unlabeled
GET /v1/devicesSource line 210 · unlabeled
curl -X GET https://api.appio.so/v1/devices \Source line 251 · unlabeled
GET /v1/devices/{id}Publisher prioritization
No H2 section named “Optional” was detected in this file.
The community proposal uses Optional by convention for secondary links that can be skipped for a shorter context. This label does not establish that everything outside it is critical, or that the material inside it is deprecated.
Machine-readable routes
No MCP or Model Context Protocol term was detected in the captured file. 0 links have MCP-related labels or paths. 0 fenced lines match mcpServers, mcp_servers or an mcp add command.
These are text and link observations. No MCP server connection, authentication or tool call was tested.
Index and bundle
Not found at checked URLs
A verified text response establishes a companion at the checked URL. It does not prove the bundle contains all product documentation, that generation is automated, or that it fits an assistant’s context window.
Change evidence
This capture establishes a baseline. Update frequency cannot be determined from one observation.
File changes can reveal documentation edits or navigation changes. They do not by themselves measure product release velocity, accuracy, agent adoption or AI visibility.
14f74f4463c0895bfff56363618201c0ff81f0292d5ee7aa5367f45bda296defCounts use a deterministic parser, not a spec-compliance grade. Unusual Markdown and indented code can fall outside its recognized patterns. See the llms.txt proposal and tokenizer implementation.