Référence de l'API

Authentification et jetons

Toutes les requêtes GraphQL nécessitent un Bearer token dans l'en-tête Authorization et un en-tête c-id (identifiant client). Obtenez les deux dans PlainApp Settings → Sessions & API Tokens. Le token ADB est distinct et utilisé uniquement pour l'automatisation Android afin de démarrer ou arrêter le serveur HTTP — trouvez-le dans Settings → Developer Options.

Définitions de types

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

# Endpoint : POST /graphql

Opérations

http

API Token

Créez un token d'API dans PlainApp Settings → Sessions & API Tokens → onglet API Tokens. Chaque token possède un identifiant client et une valeur de token. Envoyez les deux en tant qu'en-têtes de requête : c-id pour l'identifiant client et Authorization: Bearer pour le 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

Le token ADB est utilisé exclusivement pour l'automatisation Android — démarrer et arrêter le serveur HTTP de PlainApp via adb broadcast. Trouvez-le dans PlainApp Settings → Developer Options. Ce n'est PAS un Bearer token pour les requêtes 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 est un outil en ligne de commande écrit en Rust, conçu comme une CLI appelable par IA. Fournissez-le à n'importe quel agent IA capable d'exécuter des commandes shell pour lui permettre d'inspecter et de contrôler les données du téléphone — contacts, SMS, fichiers, notes, appels et plus — via l'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"]}
}'