chat.bsky.convo.getConvoAvailability

bsky-lexicons.bsky.social

Documentation

Check whether the requester and the other members can start a 1-1 chat. Only applicable to direct (non-group) conversations. If an existing convo is found for these members, it is returned. Does not create a new convo if it doesn't exist.

main query

Check whether the requester and the other members can start a 1-1 chat. Only applicable to direct (non-group) conversations. If an existing convo is found for these members, it is returned. Does not create a new convo if it doesn't exist.

Parameters

members array of string Required

No description available.

Output

Encodingapplication/json
canChat boolean Required

No description available.

Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "canChat"
      ],
      "properties": {
        "convo": {
          "ref": "chat.bsky.convo.defs#convoView",
          "type": "ref"
        },
        "canChat": {
          "type": "boolean"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "members"
    ],
    "properties": {
      "members": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "maxLength": 10,
        "minLength": 1
      }
    }
  },
  "description": "Check whether the requester and the other members can start a 1-1 chat. Only applicable to direct (non-group) conversations. If an existing convo is found for these members, it is returned. Does not create a new convo if it doesn't exist."
}

Lexicon Garden

@