For Agents
Programmatically create a session, create session with access key. Covers 6 operations with apiKey authentication.
Use for: I need to a session, I want to session with access key, Search for report data, Find all live clicks for campaign
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Voluum 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%2Fvoluum.com%2Fvoluum" | shStep 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%2Fvoluum.com%2Fvoluum" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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.
What an agent can do with Voluum API.
Create a session
Get report data
Update traffic source
Query and filter Voluum API records by parameters
GET STARTED
Not supported: Does not handle payments, communications, or crm - use for marketing only.
Voluum is a performance marketing tracker. The API allows managing campaigns, traffic sources, offers, and generating reports. The API exposes 6 endpoints secured with apiKey authentication.
Monitor Voluum API operational status and events
Patterns agents use Voluum API for, with concrete tasks.
★ Marketing Operations
Use the Voluum API to perform marketing operations programmatically. The API provides 6 endpoints covering core functionality including create a session, create session with access key, get report data.
Call POST /auth/session to create a session
Automated Auth Management
Automate auth operations by combining multiple Voluum API endpoints. Agents can create session with access key and then get report data in a single workflow.
Call POST /auth/access/session to create session with access key, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Voluum API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.
Search Jentic for 'create a session', load the operation schema, and execute with Jentic-managed credentials
6 endpoints — voluum is a performance marketing tracker.
METHOD
PATH
DESCRIPTION
/auth/session
Create a session
/auth/access/session
Create session with access key
/report
Get report data
/report/live/clicks/{campaignId}
Get live clicks for campaign
/campaign
Create campaign
/traffic-source/{trafficSourceId}
Update traffic source
/auth/session
Create a session
/auth/access/session
Create session with access key
/report
Get report data
/report/live/clicks/{campaignId}
Get live clicks for campaign
/campaign
Create campaign
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Voluum by hand means obtaining a session token from /auth/session, setting it in the cwauth-token header against api.voluum.com, and managing the report and campaign calls yourself. Through Jentic you install once, import Voluum from the API Directory, store the credential once, and your agent calls it.
Permission scoping
Voluum puts the campaign id in the URL path (/report/live/clicks/{campaignId}), so a rule can pin your agent to reading live clicks for one campaign. You choose the operations it may call, so updates like the traffic-source PUT are not included unless you add them.
Credential isolation
Your Voluum session token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'open a session' or 'pull a report', and Jentic returns the matching Voluum operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using Voluum API through Jentic.
What authentication does the Voluum API use?
The Voluum API uses an API key passed in the `cwauth-token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I create a session with the Voluum API?
Yes. Use the POST /auth/session endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Voluum API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I create a session through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a session'. Jentic returns the matching Voluum API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Voluum API have?
The Voluum API exposes 6 endpoints covering auth, campaign, report operations.
/traffic-source/{trafficSourceId}
Update traffic source