pub.chive.actor.getDiscoverySettings

chive.pub View official

Documentation

Get the authenticated user's discovery settings from their PDS

main query

Get the authenticated user's discovery settings from their PDS

Output

Encodingapplication/json
citationNetworkDisplay string Required

How to display citation network

Known values: hidden, preview, expanded
enablePersonalization boolean Required

Enable personalized recommendations based on profile

followedFieldUris array Optional

Field URIs the user follows for discovery

followingTabIncludesWorkFields boolean Optional

Whether the Following tab also includes the user's work fields

minimumEndorsementThreshold integer Optional

Minimum number of endorsements for a paper to appear in recommendations

recommendationDiversity string Optional

How diverse recommendations should be relative to user's fields

Known values: low, medium, high
showRecommendationReasons boolean Required

Show explanations for why papers are recommended

Errors

AuthenticationRequired
PDSNotFound
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)
View raw schema 
{
  "description": "Get the authenticated user's discovery settings from their PDS",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "PDSNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "citationNetworkDisplay": {
          "description": "How to display citation network",
          "knownValues": [
            "hidden",
            "preview",
            "expanded"
          ],
          "type": "string"
        },
        "enablePersonalization": {
          "description": "Enable personalized recommendations based on profile",
          "type": "boolean"
        },
        "followedFieldUris": {
          "description": "Field URIs the user follows for discovery",
          "items": {
            "format": "at-uri",
            "type": "string"
          },
          "type": "array"
        },
        "followingTabIncludesWorkFields": {
          "description": "Whether the Following tab also includes the user's work fields",
          "type": "boolean"
        },
        "minimumEndorsementThreshold": {
          "description": "Minimum number of endorsements for a paper to appear in recommendations",
          "type": "integer"
        },
        "recommendationDiversity": {
          "description": "How diverse recommendations should be relative to user's fields",
          "knownValues": [
            "low",
            "medium",
            "high"
          ],
          "type": "string"
        },
        "relatedPapersSignals": {
          "description": "Signals to use for related papers",
          "ref": "#relatedPapersSignals",
          "type": "ref"
        },
        "relatedPapersThresholds": {
          "description": "Thresholds for related papers filtering",
          "ref": "#relatedPapersThresholds",
          "type": "ref"
        },
        "relatedPapersWeights": {
          "description": "Relative weights for related papers signals",
          "ref": "#relatedPapersWeights",
          "type": "ref"
        },
        "showRecommendationReasons": {
          "description": "Show explanations for why papers are recommended",
          "type": "boolean"
        },
        "trendingPreferences": {
          "description": "Preferences for the trending feed",
          "ref": "#trendingPreferences",
          "type": "ref"
        }
      },
      "required": [
        "enablePersonalization",
        "relatedPapersSignals",
        "citationNetworkDisplay",
        "showRecommendationReasons"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {},
    "type": "params"
  },
  "type": "query"
}
relatedPapersSignals object

Configuration for related papers panel signals

Properties

authors boolean Optional

Show papers by overlapping authors

bibliographicCoupling boolean Optional

Show papers that cite the same references

citations boolean Optional

Show citation-based relationships

coCitation boolean Optional

Show papers frequently cited together

collaborative boolean Optional

Show collaborative filtering recommendations

semantic boolean Optional

Show semantically similar papers (SPECTER2 / MLT)

topics boolean Optional

Show topic/concept-based relationships

View raw schema 
{
  "description": "Configuration for related papers panel signals",
  "properties": {
    "authors": {
      "description": "Show papers by overlapping authors",
      "type": "boolean"
    },
    "bibliographicCoupling": {
      "description": "Show papers that cite the same references",
      "type": "boolean"
    },
    "citations": {
      "description": "Show citation-based relationships",
      "type": "boolean"
    },
    "coCitation": {
      "description": "Show papers frequently cited together",
      "type": "boolean"
    },
    "collaborative": {
      "description": "Show collaborative filtering recommendations",
      "type": "boolean"
    },
    "semantic": {
      "description": "Show semantically similar papers (SPECTER2 / MLT)",
      "type": "boolean"
    },
    "topics": {
      "description": "Show topic/concept-based relationships",
      "type": "boolean"
    }
  },
  "type": "object"
}
relatedPapersThresholds object

Thresholds for related papers filtering

Properties

maxResults integer Optional

Maximum number of related papers to show

minimum: 1maximum: 50
minScore integer Optional

Minimum combined score to include a paper (0-100, maps to 0.0-1.0)

minimum: 0maximum: 100
View raw schema 
{
  "description": "Thresholds for related papers filtering",
  "properties": {
    "maxResults": {
      "description": "Maximum number of related papers to show",
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "minScore": {
      "description": "Minimum combined score to include a paper (0-100, maps to 0.0-1.0)",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}
relatedPapersWeights object

Relative importance of each related papers signal (0-100, auto-normalized)

Properties

authorNetwork integer Optional

Weight for co-author network proximity

minimum: 0maximum: 100
coCitation integer Optional

Weight for co-citation and bibliographic coupling

minimum: 0maximum: 100
collaborative integer Optional

Weight for collaborative filtering signal

minimum: 0maximum: 100
conceptOverlap integer Optional

Weight for OpenAlex concept/topic overlap

minimum: 0maximum: 100
semantic integer Optional

Weight for SPECTER2 / MLT semantic similarity

minimum: 0maximum: 100
View raw schema 
{
  "description": "Relative importance of each related papers signal (0-100, auto-normalized)",
  "properties": {
    "authorNetwork": {
      "description": "Weight for co-author network proximity",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "coCitation": {
      "description": "Weight for co-citation and bibliographic coupling",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "collaborative": {
      "description": "Weight for collaborative filtering signal",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "conceptOverlap": {
      "description": "Weight for OpenAlex concept/topic overlap",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "semantic": {
      "description": "Weight for SPECTER2 / MLT semantic similarity",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}
trendingPreferences object

Preferences for the trending feed

Properties

defaultLimit integer Optional

Default number of trending results to show

minimum: 5maximum: 100
defaultWindow string Optional

Default time window for trending

Known values: 24h, 7d, 30d
View raw schema 
{
  "description": "Preferences for the trending feed",
  "properties": {
    "defaultLimit": {
      "description": "Default number of trending results to show",
      "maximum": 100,
      "minimum": 5,
      "type": "integer"
    },
    "defaultWindow": {
      "description": "Default time window for trending",
      "knownValues": [
        "24h",
        "7d",
        "30d"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Lexicon Garden

@