chat.bsky.convo.getMessages Documentation (EN)

main query

Returns a page of messages from a conversation.

Parameters

convoId string Required

No description available.

cursor string Optional

No description available.

limit integer Optional

No description available.

Output

Encodingapplication/json

cursor string Optional

No description available.

messages array Required

No description available.

Errors

InvalidConvo

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

convoId *

cursor

limit

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "InvalidConvo"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "messages"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "messages": {
          "type": "array",
          "items": {
            "refs": [
              "chat.bsky.convo.defs#messageView",
              "chat.bsky.convo.defs#deletedMessageView",
              "chat.bsky.convo.defs#systemMessageView"
            ],
            "type": "union"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "convoId"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      },
      "convoId": {
        "type": "string"
      }
    }
  },
  "description": "Returns a page of messages from a conversation."
}