place.stream.beta.getStatus Documentation (EN)

main query

Report an account's access status for a named beta feature: whether it has been granted (via a trusted place.stream.beta.invite, or because this node isn't beta-gating the feature), has an outstanding place.stream.beta.request, or neither. Defaults to the authenticated caller when `did` is omitted.

Parameters

did string did Optional

Account to check. Defaults to the authenticated caller's DID when omitted.

feature string Required

Identifier of the beta feature to check (e.g. "vod").

Output

Encodingapplication/json

did stringdid Required

The account this status applies to.

feature string Required

The feature this status applies to (echoes the request).

status string Required

granted: the account may use the feature. requested: no grant yet, but an access request is on file. none: no grant and no request.

Known values: granted, requested, none

Errors

DidRequired No did supplied and the request was not authenticated, so there is no account to check.

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

did Account to check. Defaults to the authenticated caller's DID when omitted.

feature * Identifier of the beta feature to check (e.g. "vod").

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "DidRequired",
      "description": "No did supplied and the request was not authenticated, so there is no account to check."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "feature",
        "did",
        "status"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The account this status applies to."
        },
        "status": {
          "type": "string",
          "description": "granted: the account may use the feature. requested: no grant yet, but an access request is on file. none: no grant and no request.",
          "knownValues": [
            "granted",
            "requested",
            "none"
          ]
        },
        "feature": {
          "type": "string",
          "description": "The feature this status applies to (echoes the request)."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "feature"
    ],
    "properties": {
      "did": {
        "type": "string",
        "format": "did",
        "description": "Account to check. Defaults to the authenticated caller's DID when omitted."
      },
      "feature": {
        "type": "string",
        "description": "Identifier of the beta feature to check (e.g. \"vod\")."
      }
    }
  },
  "description": "Report an account's access status for a named beta feature: whether it has been granted (via a trusted place.stream.beta.invite, or because this node isn't beta-gating the feature), has an outstanding place.stream.beta.request, or neither. Defaults to the authenticated caller when `did` is omitted."
}