Referencia de la API

Autenticación y Tokens

Todas las solicitudes GraphQL requieren un Bearer token en la cabecera Authorization y una cabecera c-id (ID de cliente). Obtén ambos en PlainApp Settings → Sessions & API Tokens. El token ADB es independiente y solo se usa para la automatización de Android para iniciar o detener el servidor HTTP — encuéntralo en Settings → Developer Options.

Definiciones de tipos

bash
# GraphQL requests must include both headers:
c-id: <client-id>
Authorization: Bearer <api-token>

# Endpoint : POST /graphql

Operaciones

http

API Token

Crea un token de API en PlainApp Settings → Sessions & API Tokens → pestaña API Tokens. Cada token tiene un ID de cliente y un valor de token. Envía ambos como cabeceras de solicitud: c-id para el ID de cliente y Authorization: Bearer para el token.

bash
# On your Android device:
# 1. Open PlainApp
# 2. Go to Settings → Sessions & API Tokens
# 3. Open the "API Tokens" tab
# 4. Tap + to create a new token
# 5. Copy the c-id and token values shown

curl --request POST \
  --url http://192.168.1.100:8080/graphql \
  --header 'c-id: <your-client-id>' \
  --header 'Authorization: Bearer <your-api-token>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"{ chatItems { content } }"}'
app

ADB Token

El token ADB se usa exclusivamente para la automatización de Android — iniciar y detener el servidor HTTP de PlainApp mediante adb broadcast. Encuéntralo en PlainApp Settings → Developer Options. NO es un Bearer token para solicitudes GraphQL.

bash
# Start the HTTP server
adb shell am broadcast -a com.ismartcoding.plain.action.START_HTTP_SERVER -p com.ismartcoding.plain --es token <your-adb-token>

# Stop the HTTP server
adb shell am broadcast -a com.ismartcoding.plain.action.STOP_HTTP_SERVER -p com.ismartcoding.plain --es token <your-adb-token>
app

plainapp-cli (AI Agent)

plainapp-cli es una herramienta de línea de comandos en Rust diseñada como una CLI invocable por IA. Pásala a cualquier agente de IA que pueda ejecutar comandos de shell para que el agente inspeccione y controle los datos del teléfono — contactos, SMS, archivos, notas, llamadas y más — a través de la API GraphQL de PlainApp.

bash
# Install (macOS & Linux one-liner)
bash <(curl -fsSL https://raw.githubusercontent.com/plainhub/plainapp-cli/main/install.sh)

# Or build from source (requires Rust ≥ 1.75)
cargo install --path .

# --- Setup ---
# 1. Open PlainApp → Settings → Sessions & API Tokens → API Tokens tab
# 2. Tap + to create a token, note the Client ID and Token
# 3. Run to generate config:
plainapp-cli --init
# Edit ~/.config/plainapp-cli/config.toml:
# api_url   = "https://192.168.1.100:8443"
# client_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# token     = "BASE64_ENCODED_32_BYTE_TOKEN"

# --- Usage ---
# Fetch the full GraphQL schema (for AI introspection)
plainapp-cli --schema

# Execute any GraphQL query or mutation
plainapp-cli --exec '<json>'

# Examples:
# List SMS conversations
plainapp-cli -e '{"query":"{ smses(limit:20,offset:0) { id address body date } }","variables":null}'

# List notes
plainapp-cli -e '{"query":"{ app { battery sdcardPath } }","variables":null}'

# Delete a file
plainapp-cli -e '{
  "query": "mutation DeleteFiles($paths:[String!]!) { deleteFiles(paths:$paths) }",
  "variables": {"paths":["/sdcard/tmp/test.txt"]}
}'