chat.sprk.convo.getConvoAvailability Documentation (EN)

main query

Get whether the requester and the other members can chat. If an existing convo is found for these members, it is returned.

Parameters

members array of string Required

No description available.

Output

Encodingapplication/json

canChat boolean Required

No description available.

convo refchat.sprk.convo.defs#convoView Optional

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

members *

View raw schema

{
  "description": "Get whether the requester and the other members can chat. If an existing convo is found for these members, it is returned.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "canChat": {
          "type": "boolean"
        },
        "convo": {
          "ref": "chat.sprk.convo.defs#convoView",
          "type": "ref"
        }
      },
      "required": [
        "canChat"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "members": {
        "items": {
          "format": "did",
          "type": "string"
        },
        "maxLength": 10,
        "minLength": 1,
        "type": "array"
      }
    },
    "required": [
      "members"
    ],
    "type": "params"
  },
  "type": "query"
}