dev.knotless.putDelegation Documentation (EN)

main procedure

Starts delegating the caller's writes to a gateway. The gateway, an OAuth client of the caller's PDS, pushes an authorization request for the caller and answers with the page where the caller approves it; once they do, the gateway keeps the session, replacing any it held, to write on the caller's behalf for collaborators and batched commits. Requires a service token from the caller's PDS, audience the gateway's DID, for this method.

Output

Encodingapplication/json

state string Required

Names the delegation to dev.knotless.getDelegation.

url stringuri Required

The authorization page for the caller to open.

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://bsky.social)

View raw schema

{
  "description": "Starts delegating the caller's writes to a gateway. The gateway, an OAuth client of the caller's PDS, pushes an authorization request for the caller and answers with the page where the caller approves it; once they do, the gateway keeps the session, replacing any it held, to write on the caller's behalf for collaborators and batched commits. Requires a service token from the caller's PDS, audience the gateway's DID, for this method.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "state": {
          "description": "Names the delegation to dev.knotless.getDelegation.",
          "maxLength": 64,
          "type": "string"
        },
        "url": {
          "description": "The authorization page for the caller to open.",
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "url",
        "state"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}