social.coves.aggregator.getApiKey Documentation (EN)

main query

Get information about the authenticated aggregator's API key. Note: The actual key value is NEVER returned - only metadata about the key.

Output

Encodingapplication/json

hasKey boolean Required

Whether the aggregator has an API key (active or revoked)

keyInfo refsocial.coves.aggregator.defs#apiKeyView Optional

API key metadata. Only present if hasKey is true.

Errors

AuthenticationRequired Authentication is required to get API key info

AggregatorRequired Only registered aggregators can get API key info

AggregatorNotFound Aggregator not found

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)

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired",
      "description": "Authentication is required to get API key info"
    },
    {
      "name": "AggregatorRequired",
      "description": "Only registered aggregators can get API key info"
    },
    {
      "name": "AggregatorNotFound",
      "description": "Aggregator not found"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "hasKey"
      ],
      "properties": {
        "hasKey": {
          "type": "boolean",
          "description": "Whether the aggregator has an API key (active or revoked)"
        },
        "keyInfo": {
          "ref": "social.coves.aggregator.defs#apiKeyView",
          "type": "ref",
          "description": "API key metadata. Only present if hasKey is true."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {},
    "description": "No parameters required. Returns key info for the authenticated aggregator."
  },
  "description": "Get information about the authenticated aggregator's API key. Note: The actual key value is NEVER returned - only metadata about the key."
}