Tapicker Bridge API Reference

This page is a quick index. For setup steps, see Getting Started. For AI integrations, see Connect an AI Agent.

CLI Commands

Command	Purpose
`tapicker bridge start [--daemon]`	Start Bridge in the foreground or in the background
`tapicker bridge stop`	Stop a background Bridge
`tapicker bridge code [--refresh]`	Show or rotate the Extension pairing code
`tapicker bridge extensions`	List connected Extension clients
`tapicker workflow start <workflowId> [--watch]`	Start a Workflow and optionally stream its status
`tapicker workflow pause <workflowId>`	Pause a Workflow
`tapicker workflow resume <workflowId>`	Resume a paused Workflow
`tapicker workflow stop <workflowId>`	Stop a Workflow
`tapicker workflow status <workflowId>`	Get the latest Workflow status snapshot
`tapicker workflow watch <workflowId>`	Wait for Workflow status updates
`tapicker data get <tableId>`	Read an extracted data table
`tapicker data delete <tableId>`	Delete an extracted data table
`tapicker mcp`	Expose a running Bridge to a local MCP client over stdio

Run tapicker --help or tapicker <command> --help for all options.

HTTP Endpoints

Method	Endpoint	Purpose
`GET`	`/v1/health`	Check Bridge health
`GET`	`/v1/discovery`	Read Bridge metadata and the Extension WebSocket path
`GET`	`/v1/capabilities`	Discover commands and their input schemas
`GET`	`/v1/extensions`	List connected Extension clients
`POST`	`/v1/commands/{command}`	Call a Workflow or data command
WebSocket	`/v1/commands/workflow.watch`	Subscribe to one Workflow’s status events
Streamable HTTP MCP	`/mcp`	Connect an MCP client directly to Bridge
WebSocket	`/ws`	Extension pairing and internal command transport

/ws is for the Tapicker Extension, not an external Agent API. The full HTTP request and response format is available in the npm package’s docs/http-api.md.

Command Inputs

HTTP commands use this shape:

{
  "clientId": "optional-extension-uuid",
  "input": {
    "workflowId": "jr657xeb"
  }
}

clientId is optional only when exactly one ready Extension is connected. workflow.start also accepts an args object and a tab target (active, new, or an existing tab ID). Data commands use tableId.

MCP Tools

extensions_list, workflow_start, workflow_pause, workflow_resume, workflow_stop, workflow_status, workflow_watch, data_get, and data_delete.

data_get reads all table rows and consumes export quota. data_delete removes the selected table from Tapicker Data.

Workflow Status Events

Connect to ws://127.0.0.1:9520/v1/commands/workflow.watch (use wss:// with TLS), then send a workflow.watch request for one workflowId. Bridge responds to the request and pushes workflow.status messages until the client disconnects or the Workflow reaches a terminal state.

The terminal states are completed, stopped, and failed. Events are not replayed after a disconnect; reconnect and call workflow.status once to retrieve the latest persisted snapshot. A WebSocket disconnect never stops the Workflow.