API Reference

Bridges

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get bridge capabilities

GET/v1/bridges/{bridgeID}/capabilities

Get advanced network capabilities for a bridge. This endpoint is intended for clients that build custom connect or chat-creation flows.

Path ParametersExpand Collapse

bridgeID: string

Bridge ID.

minLength1

ReturnsExpand Collapse

ProvisioningCapabilities object { group_creation, resolve_identifier, image_pack_import }

Advanced network capabilities for account lookup and group creation.

group_creation: map[GroupTypeCapabilities { type_description, avatar, disappear, 5 more } ]

type_description: string

avatar: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

disappear: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

name: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

parent: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

participants: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

topic: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

username: optional GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean

max_length: optional number

min_length: optional number

required: optional boolean

settings: optional DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: array of "" or "after_read" or "after_send"

One of the following:

""

"after_read"

"after_send"

omit_empty_timer: optional true

timers: optional array of number

resolve_identifier: ResolveIdentifierCapabilities { any_phone, contact_list, create_dm, 4 more }

Identifier lookup capabilities for this bridge.

any_phone: boolean

contact_list: boolean

create_dm: boolean

lookup_email: boolean

lookup_phone: boolean

lookup_username: boolean

search: boolean

image_pack_import: optional boolean

Get bridge capabilities

HTTP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

curl http://localhost:23373/v1/bridges/$BRIDGE_ID/capabilities \
    -H "Authorization: Bearer $BEEPER_ACCESS_TOKEN"

200 example

{
  "group_creation": {
    "foo": {
      "type_description": "type_description",
      "avatar": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "disappear": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "name": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "parent": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "participants": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "topic": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "username": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      }
    }
  },
  "resolve_identifier": {
    "any_phone": true,
    "contact_list": true,
    "create_dm": true,
    "lookup_email": true,
    "lookup_phone": true,
    "lookup_username": true,
    "search": true
  },
  "image_pack_import": true
}

Returns Examples

200 example

{
  "group_creation": {
    "foo": {
      "type_description": "type_description",
      "avatar": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "disappear": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "name": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "parent": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "participants": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "topic": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "username": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      }
    }
  },
  "resolve_identifier": {
    "any_phone": true,
    "contact_list": true,
    "create_dm": true,
    "lookup_email": true,
    "lookup_phone": true,
    "lookup_username": true,
    "search": true
  },
  "image_pack_import": true
}