API-Referenz

Authentifizierung & Token

Alle GraphQL-Anfragen erfordern einen Bearer token im Authorization-Header und einen c-id-Header (Client-ID). Beide erhalten Sie in PlainApp Settings → Sessions & API Tokens. Der ADB-Token ist separat und wird nur für die Android-Automatisierung verwendet, um den HTTP-Server zu starten oder zu stoppen — finden Sie ihn unter Settings → Developer Options.

Typdefinitionen

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

# Endpoint : POST /graphql

Operationen

http

API Token

Erstellen Sie einen API-Token in PlainApp Settings → Sessions & API Tokens → API Tokens-Tab. Jeder Token hat eine Client-ID und einen Token-Wert. Senden Sie beide als Anfrage-Header: c-id für die Client-ID und Authorization: Bearer für den 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

Der ADB-Token wird ausschließlich für die Android-Automatisierung verwendet — Starten und Stoppen des PlainApp HTTP-Servers via adb broadcast. Finden Sie ihn in PlainApp Settings → Developer Options. Er ist KEIN Bearer token für GraphQL-Anfragen.

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 ist ein in Rust geschriebenes Kommandozeilen-Tool, das als KI-aufrufbare CLI konzipiert ist. Geben Sie es an einen KI-Agenten weiter, der Shell-Befehle ausführen kann, damit dieser Gerätedaten — Kontakte, SMS, Dateien, Notizen, Anrufe und mehr — über die PlainApp GraphQL-API einsehen und steuern kann.

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"]}
}'