Install Jentic One Beta

Connect the Vuepak API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Vuepak API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Foauth.vuepak.com%2Fvuepak" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Foauth.vuepak.com%2Fvuepak" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Vuepak API.

List Vuepak address books for the authenticated account

Pull contacts and company contacts segmented inside Vuepak address books

Surface inbound leads captured by Vuepak campaigns for downstream follow-up

Subscribe an address book to a CRM target so contacts sync outward

Unsubscribe an address book from a CRM target when a sync is retired

GET STARTED

Start building with Vuepak API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Vuepak API for, with concrete tasks.

★ Sync Vuepak leads into a CRM

Move inbound leads captured by Vuepak campaigns into a CRM by polling GET /api/v1/leads and forwarding new records to the CRM's create-lead endpoint. The Vuepak API returns lead records associated with the authenticated workspace, so revenue operations teams can keep Salesforce or HubSpot up to date without manual export. A simple poller wired to the OAuth token is enough to bridge the two systems.

Authenticate via /api/v1/token, call GET /api/v1/leads every 10 minutes, and post new leads into the CRM

Manage Vuepak address book subscriptions

Programmatically subscribe and unsubscribe Vuepak address books from CRM destinations using POST /api/v1/addressbooks/subscribe/{crm} and POST /api/v1/addressbooks/unsubscribe/{crmName}. Marketing ops teams can wire this into onboarding scripts so a new product line provisions a fresh address book and CRM connection without manual clicks.

Call POST /api/v1/addressbooks/subscribe/{crm} for a new product address book, then list address books to verify the subscription is active

Audience segmentation pull for analytics

Build segmentation reports by retrieving address books, contacts, and company contacts and joining them with engagement data from a warehouse. The Vuepak API exposes paginated GET endpoints for /api/v1/contacts and /api/v1/contacts/company, which lets a daily ETL job snapshot the Vuepak audience for downstream BI without scraping the UI.

Pull all pages of GET /api/v1/contacts and GET /api/v1/contacts/company nightly and load both into the warehouse for joined reporting

AI agent integration via Jentic

A revenue agent searches Jentic for Vuepak lead retrieval, loads the GET /api/v1/leads schema, and runs the call after Jentic mints an OAuth access token via /api/v1/token. The agent then picks the freshest leads, summarises them, and either posts a Slack digest or hands them to a CRM agent. Jentic abstracts the OAuth dance so the agent code stays simple.

Use Jentic to search 'list vuepak leads', load GET /api/v1/leads, and execute it after Jentic acquires the OAuth token

Key Endpoints

9 endpoints — the vuepak api exposes the multichannel outreach platform's address books, contacts, leads, and subscription endpoints over oauth 2.

METHOD

PATH

DESCRIPTION

GET

/oauth/authorize

Initiate OAuth 2.0 authorization

POST

/api/v1/token

Obtain an access token

GET

/api/v1/addressbooks

List address books

GET

/api/v1/contacts

List contacts

GET

/api/v1/leads

List leads

POST

/api/v1/addressbooks/subscribe/{crm}

Subscribe an address book to a CRM

POST

/api/v1/addressbooks/unsubscribe/{crmName}

Unsubscribe an address book from a CRM

GET

/me

Get current user info

GET

/oauth/authorize

Initiate OAuth 2.0 authorization

POST

/api/v1/token

Obtain an access token

GET

/api/v1/addressbooks

List address books

GET

/api/v1/contacts

List contacts

GET

/api/v1/leads

List leads

POST

/api/v1/addressbooks/subscribe/{crm}

Subscribe an address book to a CRM

POST

/api/v1/addressbooks/unsubscribe/{crmName}

Unsubscribe an address book from a CRM

GET

/me

Get current user info

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Vuepak API by hand means running the OAuth authorization-code flow against oauth.vuepak.com, exchanging and refreshing tokens at POST /api/v1/token, attaching the bearer header, and handling retries yourself. Through Jentic you install once, import the Vuepak API from the API Directory, store the client credentials once, and your agent calls it.

Permission scoping

Vuepak subscription targets travel as the {crm} value in the request, so scope this API by operation rather than by one CRM: limit the agent to the operations it needs, such as listing address books, contacts, and leads, and leave the subscribe and unsubscribe operations out unless you add them. You choose which operations it may call, so nothing beyond the allowed set runs.

Credential isolation

Your Vuepak client credentials and refresh token are stored once, encrypted, by your own Jentic One instance, and Jentic mints the access token and adds the bearer header at execution time. The raw secret never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'list Vuepak leads' or 'subscribe an address book to a CRM', and Jentic returns the matching Vuepak operation with its input schema so the agent calls the right endpoint without reading the Vuepak documentation.

FAQs

Specific to using Vuepak API through Jentic.

What authentication does the Vuepak API use?

Vuepak uses OAuth 2.0 with the authorization code flow. The agent or app sends users to GET /oauth/authorize, then exchanges the code at POST /api/v1/token for an access token used as a bearer credential on the data endpoints. Through Jentic, the OAuth client secret and refresh token are held in the vault (your Jentic One instance) and injected at execution time.

Can I export Vuepak leads with the API?

Yes. GET /api/v1/leads returns leads captured by the authenticated workspace's campaigns. Pair it with a poller or scheduled job to forward records to a CRM, and call /me first to confirm the OAuth token is still valid for the target workspace.

Can I sync a Vuepak address book to my CRM through the API?

Yes. POST /api/v1/addressbooks/subscribe/{crm} subscribes a Vuepak address book to a CRM destination, and POST /api/v1/addressbooks/unsubscribe/{crmName} retires the subscription. Use GET /api/v1/addressbooks to enumerate the address books available for subscription.

What are the rate limits for the Vuepak API?

The OpenAPI spec does not publish explicit rate limits. Vuepak controls quotas per workspace; check your account or contact Vuepak support for figures. Through Jentic, agents can pace calls to /api/v1/contacts and /api/v1/leads to stay within the workspace allowance.

How do I list Vuepak contacts through Jentic?

Install the SDK with pip install jentic, search 'list vuepak contacts', load GET /api/v1/contacts, and execute it after Jentic obtains the OAuth access token via /api/v1/token. Jentic returns the JSON pages so the agent can paginate without dealing with the OAuth handshake itself.

Does the Vuepak API expose campaign sending or content editing?

No. The published endpoints cover OAuth, address books, contacts, leads, and the authenticated user. Sending emails or SMS, editing campaign templates, and reading engagement events are not part of this surface - use the Vuepak UI or contact Vuepak for those flows.

Can I limit what my agent is allowed to do with the Vuepak API?

Yes. Because your Jentic One instance is self-hosted, your own rules decide which Vuepak operations and credentials the agent may use. Scope this API by operation: allow only the reads it needs, such as GET /api/v1/addressbooks, GET /api/v1/contacts, and GET /api/v1/leads, and leave POST /api/v1/addressbooks/subscribe/{crm} and its unsubscribe counterpart out unless you add them. Since the subscription target travels as the {crm} value in each request, restricting the operation set is what keeps the agent from touching CRM subscriptions, so nothing beyond the allowed operations runs.

Oauth Vuepak Vuepak API

AI ReadinessAI-Aware (A-)74/100

See full scorecard

Official vendor OpenAPI document · agent-readyMarketingMarketing Automationoauth29 EndpointsREST

For Agents

List Vuepak contacts and leads, manage address book CRM subscriptions, and authenticate via OAuth 2.0 authorization code flow.

Use for: I want to fetch all Vuepak contacts in a specific address book, Retrieve the latest leads captured by my Vuepak campaign, List all address books available to my Vuepak account, Subscribe a Vuepak address book to my Salesforce CRM

Not supported: Does not send emails or SMS, edit campaign content, or expose engagement events - use for OAuth-authenticated audience and lead retrieval and CRM subscription management only.

The Vuepak API exposes the multichannel outreach platform's address books, contacts, leads, and subscription endpoints over OAuth 2.0 authorization code flow. Connected applications can list and segment contacts, surface inbound leads created from Vuepak campaigns, and toggle CRM subscriptions on address books so Vuepak audiences stay in sync with downstream systems. It is intended for marketing operations teams who run Vuepak campaigns and need to push or pull audience data programmatically.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

100

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A+Signals: 4

99%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

100%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: B-Signals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

47%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: CSignals: 4

72%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

50%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: A+Signals: 1

90%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: A-Signals: 1

78%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the Vuepak API to your agent

Capabilities

Start building with Vuepak API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Oauth Vuepak Vuepak API

Jentic AI Readiness Score

Vuepak API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness