integrations

Create or update the desktop app config (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
POST /app-config
Access token

Desktop plumbing: creates or updates the app configuration for a desktop install (systemId) and returns it with its device settings.

application/json

Body Required

  • systemId string Required

    Minimum length is 1, maximum length is 99999.

  • defaultBackupPath string
  • lastUsedBackupPath string
  • otherSettings object
  • osDetails object
    Hide osDetails attributes Show osDetails attributes object
    • arch string
    • platform string
    • version string
    • osType string
    • machine string
    • totalMemory number
    • cpus object Required
    • extraInformation object Required
  • lastUsedAppVersion string
  • lastAppUsedAt string

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • systemId string Required
      • deviceSettings array[object] | null Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide deviceSettings attributes Show deviceSettings attributes object
        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • systemId string Required
        • deviceId string Required
        • deviceType string Required

          Values are unknown, android, ios, facebook_dump, instagram_dump, threads_dump, or email.

        • backupPaths array[string] Required
        • defaultBackupPath string Required
        • lastUsedBackupPath string Required
        • device string | null Required

          Id of the device these settings belong to

        • lastBackupAt string(date-time) | null Required
        • lastLocalBackupAt string(date-time) | null Required
        • autoBackupFrequency string Required

          Values are none, daily, weekly, or monthly. Default value is none.

        • deviceMetadata object Required
        • otherSettings object Required
      • defaultBackupPath string Required
      • lastUsedBackupPath string Required
      • otherSettings object Required
      • osDetails object Required
        Hide osDetails attributes Show osDetails attributes object
        • arch string
        • platform string
        • version string
        • type string

          Never sent today: nothing fills it (the OS type is stored and sent as osType).

        • osType string

          Operating system type reported by the desktop app.

        • machine string
        • totalMemory number
        • cpus object
        • extraInformation object
      • lastAppUsedAt string(date-time) Required
      • lastUsedAppVersion string Required
      • defaultSettings object | null Required
    • statusCode number Required
    • timestamp string(date-time) Required
POST /app-config 
curl \
 --request POST 'http://api.example.com/app-config' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "systemId": "string",
  "defaultBackupPath": "string",
  "lastUsedBackupPath": "string",
  "otherSettings": {},
  "osDetails": {
    "arch": "string",
    "platform": "string",
    "version": "string",
    "osType": "string",
    "machine": "string",
    "totalMemory": 42.0,
    "cpus": {},
    "extraInformation": {}
  },
  "lastUsedAppVersion": "string",
  "lastAppUsedAt": "string"
}'
Request examples 
{
  "systemId": "string",
  "defaultBackupPath": "string",
  "lastUsedBackupPath": "string",
  "otherSettings": {},
  "osDetails": {
    "arch": "string",
    "platform": "string",
    "version": "string",
    "osType": "string",
    "machine": "string",
    "totalMemory": 42.0,
    "cpus": {},
    "extraInformation": {}
  },
  "lastUsedAppVersion": "string",
  "lastAppUsedAt": "string"
}
Response examples (201) 
{
  "data": {
    "createdAt": "2026-01-15T14:30:00.000Z",
    "updatedAt": "2026-01-15T14:30:00.000Z",
    "id": "507f1f77bcf86cd799439011",
    "systemId": "3f8e1c5a9b2d4e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f",
    "deviceSettings": [
      {
        "createdAt": "2026-01-15T14:30:00.000Z",
        "updatedAt": "2026-01-15T14:30:00.000Z",
        "id": "507f1f77bcf86cd799439011",
        "systemId": "3f8e1c5a9b2d4e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f",
        "deviceId": "00008110-001A2B3C4D5E",
        "deviceType": "unknown",
        "backupPaths": [
          "/Users/jane/HearsayBackups"
        ],
        "defaultBackupPath": "/Users/jane/HearsayBackups",
        "lastUsedBackupPath": "/Users/jane/HearsayBackups",
        "device": "507f1f77bcf86cd799439011",
        "lastBackupAt": "2026-01-15T14:30:00.000Z",
        "lastLocalBackupAt": "2026-01-15T14:30:00.000Z",
        "autoBackupFrequency": "none",
        "deviceMetadata": {
          "name": "Jane Doe's iPhone",
          "productType": "iPhone15,2",
          "productVersion": "17.4.1",
          "timeZone": "America/Chicago"
        },
        "otherSettings": {}
      }
    ],
    "defaultBackupPath": "/Users/jane/HearsayBackups",
    "lastUsedBackupPath": "/Users/jane/HearsayBackups",
    "otherSettings": {},
    "osDetails": {
      "arch": "arm64",
      "platform": "darwin",
      "version": "14.4",
      "type": "Darwin",
      "osType": "Darwin",
      "machine": "arm64",
      "totalMemory": 17179869184,
      "cpus": {},
      "extraInformation": {
        "cpu": {
          "manufacturer": "Apple",
          "brand": "M2",
          "physicalCores": 8
        },
        "mem": {
          "total": 17179869184
        },
        "osInfo": {
          "platform": "darwin",
          "distro": "macOS",
          "release": "14.4",
          "arch": "arm64"
        },
        "battery": {
          "hasBattery": true,
          "percent": 80
        }
      }
    },
    "lastAppUsedAt": "2026-01-15T14:30:00.000Z",
    "lastUsedAppVersion": "2.1.15",
    "defaultSettings": {
      "contactAdminDeviceRequestText": "Please add another device to my account."
    }
  },
  "statusCode": 201,
  "timestamp": "2026-01-15T10:15:00.000Z"
}