chat.bsky.convo.getConvoForMembers

bsky-lexicons.bsky.social

Documentation

Get or create a 1-1 conversation for the given members. Always returns the same direct (non-group) conversation. To create a group conversation, use createGroup.

main query

Get or create a 1-1 conversation for the given members. Always returns the same direct (non-group) conversation. To create a group conversation, use createGroup.

Parameters

members array of string Required

No description available.

Output

Encodingapplication/json

Errors

AccountSuspended
BlockedActor
MessagesDisabled
NotFollowedBySender
RecipientNotFound
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",
  "errors": [
    {
      "name": "AccountSuspended"
    },
    {
      "name": "BlockedActor"
    },
    {
      "name": "MessagesDisabled"
    },
    {
      "name": "NotFollowedBySender"
    },
    {
      "name": "RecipientNotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "convo"
      ],
      "properties": {
        "convo": {
          "ref": "chat.bsky.convo.defs#convoView",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "members"
    ],
    "properties": {
      "members": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "maxLength": 10,
        "minLength": 1
      }
    }
  },
  "description": "Get or create a 1-1 conversation for the given members. Always returns the same direct (non-group) conversation. To create a group conversation, use createGroup."
}

Lexicon Garden

@