Auth & Tokens

API Reference

All GraphQL requests require a Bearer token in the Authorization header and a c-id (client ID) header. Obtain both from PlainApp Settings → Sessions & API Tokens. The ADB token is separate and only used for Android automation to start or stop the HTTP server — find it in Settings → Developer Options.

Type Definitions

bash

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

# Endpoint : POST /graphql

Operations

http

API Token

Create an API token in PlainApp Settings → Sessions & API Tokens → API Tokens tab. Each token has a client ID and a token value. Send both as request headers: c-id for the client ID and Authorization: Bearer for the 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

The ADB token is used exclusively for Android automation — starting and stopping the PlainApp HTTP server via adb broadcast. Find it in PlainApp Settings → Developer Options. It is NOT a Bearer token for GraphQL requests.

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 is a Rust command-line tool designed as an AI-callable CLI. Feed it to any AI agent that can run shell commands to let the agent inspect and control phone data — contacts, SMS, files, notes, calls, and more — via the PlainApp GraphQL API.

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