> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tinyfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# TinyAgent Reference — Vault

> Connect password managers and sync vault credentials

Connect password managers and sync credentials for use in automation runs. All requests require
the `X-API-Key` header unless noted otherwise. See [Authentication](https://docs.tinyfish.ai/authentication.md).

## Quick Setup

**1. Connect a provider**

`POST /v1/vault/connections` once per password manager — see [Connect Your Vault](https://docs.tinyfish.ai/vault-setup.md)
for the supported providers and their exact fields.

**2. Run with vault access**

Pass `use_vault: true` (and optionally `credential_item_ids`) on an automation request — full
walkthrough: [Scrape Content Behind a Login Using Vault](https://docs.tinyfish.ai/agent/how-to/vault-login.md).

The sections below are the exact request/response schema for every Vault endpoint.

## Endpoints

| Endpoint | Method | Purpose |
| - | - | - |
| `/v1/vault/connections` | `POST` | Connect a vault provider |
| `/v1/vault/connections` | `GET` | List vault connections |
| `/v1/vault/connections/{connectionId}` | `DELETE` | Disconnect a vault provider |
| `/v1/vault/items` | `GET` | List vault items |
| `/v1/vault/items/sync` | `POST` | Sync vault items |

## Connect a Vault Provider

`POST /v1/vault/connections`

Connect a supported password manager and immediately sync display-safe credential metadata.

**provider** `string` *required*

Vault provider identifier.

**token** `string`

1Password service account token — required when `provider` is `1password`.

**clientId** `string`

Bitwarden client ID — required when `provider` is `bitwarden`.

**clientSecret** `string`

Bitwarden client secret — required when `provider` is `bitwarden`.

**masterPassword** `string`

Bitwarden master password — required when `provider` is `bitwarden`.

**serverUrl** `string`

Optional self-hosted Bitwarden server URL.

**connectionId** `string`

**connected** `boolean`

**provider** `string`

**items** `array`

## List Vault Connections

`GET /v1/vault/connections`

List all connected vault providers for the authenticated user.

```json theme={null}
{ "connections": [ { "connectionId": "conn_abc", "provider": "1password" } ] }
```

## Disconnect a Vault Provider

`DELETE /v1/vault/connections/{connectionId}`

Disconnect a vault provider and remove its stored, enabled items.

**connectionId** `string` *required*

**disconnected** `boolean`

**connectionId** `string`

## List Vault Items

`GET /v1/vault/items`

List all vault items currently available from connected providers. Use the `id` values returned
here as `credential_item_ids` on an automation request — see [Vault Credentials](https://docs.tinyfish.ai/key-concepts/credentials.md).

**items** `array`

## Sync Vault Items

`POST /v1/vault/items/sync`

Re-sync items from all connected providers and return merged item state plus sync counters.

**items** `array`

**sync\_summary** `object`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.