Vital

Vital Link API

The link API from Vital — 13 operation(s) for link.

Documentation GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/link/bulk_op List bulk connection operations · List Bulk Ops #

Ask an LLM

“Can I see the status of my bulk import, export and pause jobs?”

“Which bulk link operations has my team run?”

Tell an agent

List my bulk link operations.

Show the next {page_size} bulk operations after cursor {next_cursor}.

POST /v2/link/bulk_import Bulk import existing provider connections · Bulk Import Connections #

Ask an LLM

“Can I import existing device connections for many users at once?”

“Is there a way to migrate already-authorized provider connections in bulk?”

Tell an agent

Bulk import connections {connections} for provider {provider}.

Import these {provider} connections and wait for completion: {connections}.

POST /v2/link/bulk_trigger_historical_pull Trigger historical pulls for many users · Bulk Trigger Historical Pull #

Ask an LLM

“Can I trigger a historical backfill for a batch of users at once?”

“How do I re-pull past data from a provider for a list of users?”

Tell an agent

Trigger historical pulls from {provider} for users {user_ids}.

Backfill {provider} history for {user_ids} and wait until it finishes.

POST /v2/link/bulk_export Export users' provider connections · Bulk Export Connections #

Ask an LLM

“Can I export my users' connections for a provider?”

“Is there a paginated export of provider connections?”

Tell an agent

Export {provider} connections for users {user_ids}.

Continue exporting {provider} connections from token {next_token}.

POST /v2/link/bulk_pause Pause provider connections in bulk · Bulk Pause Connections #

Ask an LLM

“Can I pause data syncing for many users' connections at once?”

“Which call pauses a provider connection for a batch of users?”

Tell an agent

Pause {provider} connections for users {user_ids}.

Stop syncing {provider} for {user_ids} for now.

POST /v2/link/token Generate a Link token to connect a user · Generate Vital Link Token #

Ask an LLM

“How do I start the Vital Link connection flow for one of my users?”

“How long is a link token valid, and can it be reused?”

Tell an agent

Generate a link token for user {user}.

Create a link token for {user} that redirects to {redirect_url} when done.

POST /v2/link/code/create Invite a mobile app user to my team · Create Token #

Ask an LLM

“Can I invite someone using the Vital mobile app to join my team?”

“Can a mobile app invite code be set to expire at a specific time?”

Tell an agent

Create a mobile app invite code for user {q_user}.

Generate a team invite code for {q_user} expiring at {expires_at}.

GET /v2/link/provider/oauth/{oauth_provider} Get an OAuth authorization link for a provider · Generate Oauth Link Endpoint #

Ask an LLM

“How do I get the OAuth URL a user visits to authorize a provider?”

“Which link do I send a user to connect an OAuth-based provider?”

Tell an agent

Generate an OAuth link for {oauth_provider}.

Get the {oauth_provider} authorization URL using link token {token}.

POST /v2/link/provider/password/{provider} Connect a password-based provider · Connect Password Provider #

Ask an LLM

“Can I connect a provider that signs in with a username and password?”

“Is a region needed when connecting a password-based provider?”

Tell an agent

Connect password provider {path_provider} with username {username} and password {password}.

Link {path_provider} using credentials {username} / {password} in region {region}.

POST /v2/link/provider/password/{provider}/complete_mfa Finish a password provider login with MFA · Complete Password Provider Mfa #

Ask an LLM

“What do I do when a password-based provider asks for an MFA code?”

“Can I finish connecting a provider that sent a two-factor code?”

Tell an agent

Complete MFA for {path_provider} with code {mfa_code}.

Submit verification code {mfa_code} to finish connecting {path_provider}.

POST /v2/link/provider/email/{provider} Connect an email-based provider · Connect Email Auth Provider #

Ask an LLM

“Can I connect a provider that only needs the user's email address?”

“Can I set a region when connecting an email-based provider?”

Tell an agent

Connect email provider {path_provider} for {email}.

Link {path_provider} by email {email} in region {region}.

GET /v2/link/providers List providers available to a link token · Get Providers #

Ask an LLM

“Which providers can a user connect with their link token?”

“What integrations show up in the link widget for a given token?”

Tell an agent

List providers available to link token {token}.

Show the providers a user can connect right now.

POST /v2/link/connect/demo Connect a user to a demo provider · Create Demo Connection #

Ask an LLM

“Can I connect a test user to a demo provider to get sample data?”

“Is there a way to simulate a wearable connection without a real device?”

Tell an agent

Connect user {user} to demo provider {provider}.

Create a demo {provider} connection for {user}.

Vital Link API

Operations 13

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification