Skip to main content
Connect password managers and sync credentials for use in automation runs. All requests require the X-API-Key header unless noted otherwise. See Authentication.

​
Quick Setup

1

Connect a provider

POST /v1/vault/connections once per password manager — see Connect Your Vault 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.
The sections below are the exact request/response schema for every Vault endpoint.

​
Endpoints

​
Connect a Vault Provider

POST /v1/vault/connections Connect a supported password manager and immediately sync display-safe credential metadata.
​
string
required
Vault provider identifier.
​
string
1Password service account token — required when provider is 1password.
​
string
Bitwarden client ID — required when provider is bitwarden.
​
string
Bitwarden client secret — required when provider is bitwarden.
​
string
Bitwarden master password — required when provider is bitwarden.
​
string
Optional self-hosted Bitwarden server URL.
​
string
​
boolean
​
string
​
array

​
List Vault Connections

GET /v1/vault/connections List all connected vault providers for the authenticated user.

​
Disconnect a Vault Provider

DELETE /v1/vault/connections/{connectionId} Disconnect a vault provider and remove its stored, enabled items.
​
string
required
​
boolean
​
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.
​
array

​
Sync Vault Items

POST /v1/vault/items/sync Re-sync items from all connected providers and return merged item state plus sync counters.
​
array
​
object