blue.catbird.circle.activateCircle

catbird.blue

Documentation

Ask this service to begin indexing a Circle Space. The service verifies the Space independently against the owner's PDS; it does not trust the caller's claim that the Space exists. Idempotent: activating an already-active Circle returns its current summary.

main procedure

Ask this service to begin indexing a Circle Space. The service verifies the Space independently against the owner's PDS; it does not trust the caller's claim that the Space exists. Idempotent: activating an already-active Circle returns its current summary.

Input

Encodingapplication/json
space stringspace-ref Required

No description available.

Output

Encodingapplication/json

Errors

AuthorizationRequired This service holds no usable OAuth grant for a participant of the Space, so it cannot obtain a Space credential.
NotAuthorized The caller is not on the Space's member list.
SpaceNotFound
SpaceNotEligible The Space exists but is not a usable Circle: its app access does not name this service, or its metadata record is absent.
UnsupportedPDS
ProtocolRevisionMismatch
UpstreamUnavailable
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://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "space"
      ],
      "properties": {
        "space": {
          "type": "string",
          "format": "space-ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthorizationRequired",
      "description": "This service holds no usable OAuth grant for a participant of the Space, so it cannot obtain a Space credential."
    },
    {
      "name": "NotAuthorized",
      "description": "The caller is not on the Space's member list."
    },
    {
      "name": "SpaceNotFound"
    },
    {
      "name": "SpaceNotEligible",
      "description": "The Space exists but is not a usable Circle: its app access does not name this service, or its metadata record is absent."
    },
    {
      "name": "UnsupportedPDS"
    },
    {
      "name": "ProtocolRevisionMismatch"
    },
    {
      "name": "UpstreamUnavailable"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "circle"
      ],
      "properties": {
        "circle": {
          "ref": "blue.catbird.circle.defs#circleSummary",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Ask this service to begin indexing a Circle Space. The service verifies the Space independently against the owner's PDS; it does not trust the caller's claim that the Space exists. Idempotent: activating an already-active Circle returns its current summary."
}

Lexicon Garden

@