social.colibri.beta.bridge.uploadBlob

colibri.social

Documentation

Uploads a file to the community's repo for use in a bridged message or as a bridged author's avatar.

main procedure

Uploads a file to the community's repo for use in a bridged message or as a bridged author's avatar.

Parameters

community stringdid Required

The community the registration belongs to.

registration stringtid Required

Record key of the registration.

Input

Encoding*/*

Accepts raw binary data

Output

Encodingapplication/json
blob blob Required

The uploaded blob, to reference from a message or author.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
CommunityNotFound No community exists at the given DID.
RegistrationNotFound The community has no bridge registration with that id.
Forbidden The caller is not the bridge this registration belongs to.
RegistrationDisabled An admin has paused this registration.
RateLimited The bridge sent too many requests. Retry after the interval in the response headers.
BlobTooLarge The file is larger than this AppView accepts from bridges.
CredentialsUnavailable The AppView cannot act as the community because its stored credentials are missing or unusable.
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 
{
  "description": "Uploads a file to the community's repo for use in a bridged message or as a bridged author's avatar.",
  "errors": [
    {
      "description": "The request is missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "No community exists at the given DID.",
      "name": "CommunityNotFound"
    },
    {
      "description": "The community has no bridge registration with that id.",
      "name": "RegistrationNotFound"
    },
    {
      "description": "The caller is not the bridge this registration belongs to.",
      "name": "Forbidden"
    },
    {
      "description": "An admin has paused this registration.",
      "name": "RegistrationDisabled"
    },
    {
      "description": "The bridge sent too many requests. Retry after the interval in the response headers.",
      "name": "RateLimited"
    },
    {
      "description": "The file is larger than this AppView accepts from bridges.",
      "name": "BlobTooLarge"
    },
    {
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
      "name": "CredentialsUnavailable"
    }
  ],
  "input": {
    "description": "The raw file bytes.",
    "encoding": "*/*"
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "blob": {
          "description": "The uploaded blob, to reference from a message or author.",
          "type": "blob"
        }
      },
      "required": [
        "blob"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "community": {
        "description": "The community the registration belongs to.",
        "format": "did",
        "type": "string"
      },
      "registration": {
        "description": "Record key of the registration.",
        "format": "tid",
        "type": "string"
      }
    },
    "required": [
      "community",
      "registration"
    ],
    "type": "params"
  },
  "type": "procedure"
}

Lexicon Garden

@