Skip to main content
POST
/
v1
/
vault
/
connections
Connect a vault provider
curl --request POST \
  --url https://agent.tinyfish.ai/v1/vault/connections \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "provider": "1password",
  "token": "<string>",
  "clientId": "<string>",
  "clientSecret": "<string>",
  "masterPassword": "<string>",
  "serverUrl": "https://vault.example.com"
}
'
{
  "connectionId": "conn_123",
  "connected": true,
  "provider": "1password",
  "items": [
    {
      "itemId": "cred:conn-123:Personal:item-abc123",
      "connectionId": "conn_123",
      "label": "Amazon Login",
      "vaultName": "Personal",
      "domains": [
        "amazon.com"
      ],
      "fieldMetadata": [
        {
          "fieldId": "password",
          "label": "Password",
          "type": "CONCEALED"
        }
      ],
      "hasTotp": true,
      "enabled": true
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Body

application/json

Connect a vault provider. For 1password, provide token. For bitwarden, provide clientId, clientSecret, and masterPassword.

​
provider
enum<string>
required

Vault provider identifier.

Available options:
1password,
bitwarden
Example:

"1password"

​
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<uri>

Optional self-hosted Bitwarden server URL.

Example:

"https://vault.example.com"

Response

Vault connected successfully.

​
connectionId
string
required
Example:

"conn_123"

​
connected
enum<boolean>
required
Available options:
true
​
provider
enum<string>
required

Vault provider identifier.

Available options:
1password,
bitwarden
Example:

"1password"

​
items
object[]
required