pub.chive.tag.listForEprint

chive.pub

Documentation

List tags for a specific eprint with TaxoFolk suggestions

main query

List tags for a specific eprint with TaxoFolk suggestions

Parameters

eprintUri string at-uri Required

AT-URI of the eprint to list tags for

Output

Encodingapplication/json
suggestions array Optional

TaxoFolk suggestions based on existing tags

tags array Required

Tags applied to the eprint

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
AT-URI of the eprint to list tags for
View raw schema
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "tags"
      ],
      "properties": {
        "tags": {
          "type": "array",
          "items": {
            "ref": "#userTag",
            "type": "ref"
          },
          "description": "Tags applied to the eprint"
        },
        "suggestions": {
          "type": "array",
          "items": {
            "ref": "#tagSuggestion",
            "type": "ref"
          },
          "description": "TaxoFolk suggestions based on existing tags"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri"
    ],
    "properties": {
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint to list tags for"
      }
    }
  },
  "description": "List tags for a specific eprint with TaxoFolk suggestions"
}
authorRef object

Reference to an author

Properties

avatar string uri Optional

Avatar URL

did string did Required

Author DID

displayName string Optional

Display name

handle string Optional

Author handle

View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Author DID"
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "Avatar URL"
    },
    "handle": {
      "type": "string",
      "description": "Author handle"
    },
    "displayName": {
      "type": "string",
      "description": "Display name"
    }
  },
  "description": "Reference to an author"
}
tagSuggestion object

A tag suggestion from the TaxoFolk system

Properties

confidence integer Required

Suggestion confidence (0-100, scaled from 0-1)

minimum: 0maximum: 100
displayForm string Required

Suggested display form

matchedTerm string Optional

Term that triggered this suggestion

normalizedForm string Required

Normalized form of the suggestion

source string Required

Source of the suggestion

Known values: cooccurrence, authority, facet
View raw schema
{
  "type": "object",
  "required": [
    "displayForm",
    "normalizedForm",
    "confidence",
    "source"
  ],
  "properties": {
    "source": {
      "type": "string",
      "description": "Source of the suggestion",
      "knownValues": [
        "cooccurrence",
        "authority",
        "facet"
      ]
    },
    "confidence": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Suggestion confidence (0-100, scaled from 0-1)"
    },
    "displayForm": {
      "type": "string",
      "description": "Suggested display form"
    },
    "matchedTerm": {
      "type": "string",
      "description": "Term that triggered this suggestion"
    },
    "normalizedForm": {
      "type": "string",
      "description": "Normalized form of the suggestion"
    }
  },
  "description": "A tag suggestion from the TaxoFolk system"
}
userTag object

A user-applied tag on an eprint

Properties

cid string Required

Content identifier

createdAt string datetime Required

Creation timestamp

displayForm string Required

Original display form of the tag

eprintUri string at-uri Required

Tagged eprint AT-URI

normalizedForm string Required

Normalized form (lowercase, hyphenated)

uri string at-uri Required

Tag AT-URI

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "eprintUri",
    "author",
    "displayForm",
    "normalizedForm",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "description": "Content identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Tag AT-URI"
    },
    "author": {
      "ref": "#authorRef",
      "type": "ref",
      "description": "Tag creator"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation timestamp"
    },
    "eprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Tagged eprint AT-URI"
    },
    "displayForm": {
      "type": "string",
      "description": "Original display form of the tag"
    },
    "normalizedForm": {
      "type": "string",
      "description": "Normalized form (lowercase, hyphenated)"
    }
  },
  "description": "A user-applied tag on an eprint"
}

Lexicon Garden

@