---
title: "Check a Bridge's credential in and learn who it acts as"
method: POST
path: "/api/preview/bridge/check-in"
tags: ["bridge"]
---

# Check a Bridge's credential in and learn who it acts as

`POST /api/preview/bridge/check-in`

## Request

- Base URL: `https://symbol.chat` (the document declares no server; this is the origin it was published from)
- URL: `https://symbol.chat/api/preview/bridge/check-in`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-next-auth.session-token`
  - OAuth 2
    - Authorization code: `https://mcp.symbol.chat/authorize`
    - Token URL: `https://mcp.symbol.chat/token`

## Request body

- object
  - `bridge_version` string, required
  - `client_app` string, required: The assistant app the Bridge runs under, as it names itself.
  - `device_name` string, required: The computer's name as the person knows it.
  - `install_id` string, required: The Bridge install id: 32 lowercase hex characters, shared by every Bridge process on one computer.
  - `platform` 'darwin' | 'win32' | 'linux' | 'other', required
  - `resume` boolean: True to use this install's credential again after it was signed out from symbol.chat.

## Response `200`

Successful response

- object
  - `account` object, nullable, required
    - `email` string, nullable, required
    - `id` string, required
    - `name` string, nullable, required
  - `credential` object, required
    - `id` string, required: UUID v4 string
    - `kind` 'personal_key' | 'oauth_grant' | 'organization_key', required
  - `default_workspace` object, nullable, required
    - `id` string, nullable, required: UUID v4 string
    - `kind` 'personal' | 'organization', required
    - `name` string, required
  - `install` object, nullable, required
    - `signed_out` boolean, required
  - `organization` object, nullable, required
    - `id` string, required: UUID v4 string
    - `name` string, required

## Changes

- **2026-10-19** `5778844d1f9e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/symbol/apis/symbol-api/changes/api/preview/bridge/check-in/post.md)

---

[API](https://skmtc.dev/symbol/apis/symbol-api.md) - [All operations](https://skmtc.dev/symbol/apis/symbol-api/llms.txt) - [OpenAPI document](https://skmtc.dev/symbol/apis/symbol-api/revisions/3a2c4ebeab51?raw)