FansquareAPI reference
Open the app

AI control

List pending AI control requests

GET/v1/accounts/{account_id}/ai-requests

Lists the AI control requests a CRM user posed on this account and that you have not acknowledged yet, oldest first. Process them (relaunch or stop your AI), then acknowledge them so they drop off this list.

Required scoperead:ai_requests
Rate limit60 requests per minute
curl 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/ai-requests' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
{
  "data": [
    {
      "request_id": "0cbdfaac-d0e9-419e-a7b9-b438a95c3862",
      "fan_id": "a6df8022-e509-4575-ad28-e29c2d1d42dc",
      "intent": "relaunch",
      "requested_at": "2026-10-12T21:14:00.000Z"
    }
  ]
}

Parameters

Headers

  • Fansquare-Versionstringrequired

    API version to pin. Accepts the mineral name or the release date of a version.

Path

  • account_idstringrequired

    MYM account id (account.external_id in GET /v1/creators).

    min length 1

Query

  • status"pending"

    Only pending is returned (acknowledged requests are not retained for polling).

  • limitinteger

    Maximum number of requests returned (1-200). The list has no cursor: acknowledge, then list again.

    Default 50min 1max 200

Response

OK, application/json

  • dataarray of objectsrequired
    • request_idstringrequired

      Opaque id of the request. Pass it back to the ack endpoint.

    • fan_idstringrequired

      MYM fan id the request is about.

    • intentstringrequired

      'relaunch' = put the AI back on this conversation; 'stop' = a human is taking over.

      Valuesrelaunchstop
    • requested_atstringrequired

      When the CRM user posed the request (ISO 8601).

      format date-time
curl 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/ai-requests' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"
{
  "data": [
    {
      "request_id": "0cbdfaac-d0e9-419e-a7b9-b438a95c3862",
      "fan_id": "a6df8022-e509-4575-ad28-e29c2d1d42dc",
      "intent": "relaunch",
      "requested_at": "2026-10-12T21:14:00.000Z"
    }
  ]
}