pub.chive.claiming.autocomplete

chive.pub

Documentation

Provides fast autocomplete suggestions for claiming search. Optimized for low latency with short timeouts.

main query

Provides fast autocomplete suggestions for claiming search. Optimized for low latency with short timeouts.

Parameters

limit integer Optional

Maximum number of suggestions to return

query string Required

Search query prefix

Output

Encodingapplication/json
suggestions array Required

List of autocomplete suggestions

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
Maximum number of suggestions to return
Search query prefix
View raw schema
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "suggestions"
      ],
      "properties": {
        "suggestions": {
          "type": "array",
          "items": {
            "ref": "#suggestion",
            "type": "ref"
          },
          "description": "List of autocomplete suggestions"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "query"
    ],
    "properties": {
      "limit": {
        "type": "integer",
        "default": 8,
        "maximum": 10,
        "minimum": 1,
        "description": "Maximum number of suggestions to return"
      },
      "query": {
        "type": "string",
        "minLength": 2,
        "description": "Search query prefix"
      }
    }
  },
  "description": "Provides fast autocomplete suggestions for claiming search. Optimized for low latency with short timeouts."
}
suggestion object

An autocomplete suggestion for a claimable eprint

Properties

authors string Required

First 2 authors joined (e.g., 'Author1, Author2 et al.')

externalId string Required

Source-specific identifier

fieldMatchScore integer Optional

User field relevance score (0-100), present if authenticated

minimum: 0maximum: 100
highlightedTitle string Optional

Title with query portion highlighted using markdown bold

source string Required

External source identifier (e.g., arxiv, biorxiv)

title string Required

Eprint title

View raw schema
{
  "type": "object",
  "required": [
    "title",
    "authors",
    "source",
    "externalId"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Eprint title"
    },
    "source": {
      "type": "string",
      "description": "External source identifier (e.g., arxiv, biorxiv)"
    },
    "authors": {
      "type": "string",
      "description": "First 2 authors joined (e.g., 'Author1, Author2 et al.')"
    },
    "externalId": {
      "type": "string",
      "description": "Source-specific identifier"
    },
    "fieldMatchScore": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "User field relevance score (0-100), present if authenticated"
    },
    "highlightedTitle": {
      "type": "string",
      "description": "Title with query portion highlighted using markdown bold"
    }
  },
  "description": "An autocomplete suggestion for a claimable eprint"
}

Lexicon Garden

@