Octanist API

Name: Octanist API
Brand: Octanist API
Availability: InStock

✓ Official Vendor SpecMarketingMarketing AutomationapiKey7 EndpointsREST

For Agents

Capture leads, read campaign statistics, and pull ad spend numbers from Octanist for marketing analytics workflows.

Install Jentic One Beta

Connect the Octanist API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Octanist 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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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 Octanist API.

Submit a new lead to Octanist via /api/leads with source and campaign attribution

Retrieve a single lead by ID via /api/leads/{id}

Read aggregated campaign statistics via /api/stats

Pull paid-channel ad spend totals via /api/ad-spend

GET STARTED

Start building with Octanist API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Octanist API for, with concrete tasks.

★ Webform Lead Capture Sync

Forward leads captured on a marketing site to Octanist by POSTing to /api/leads from the form handler with source and campaign attribution. Octanist stores the lead and exposes it through /api/leads/{id} for later retrieval. Useful for in-house growth teams that already use Octanist as the system of record for paid-channel leads and want their site forms to write directly to it.

POST a lead with name, email, and source 'google-ads' to /api/leads and return the new lead ID.

Ad Spend Reporting Sync

Pull Octanist's recorded ad-spend totals into a BI warehouse on a nightly cadence by calling /api/ad-spend with the relevant date range and writing the rows into an analytics table. The endpoint returns aggregated spend ready to join with internal revenue data for ROAS reporting. Saves marketing teams from exporting CSVs and emailing them to analytics.

Call /api/ad-spend for the previous week and return total spend grouped by channel.

Campaign Performance Dashboard

Render an internal campaign performance dashboard by combining /api/stats for engagement metrics with /api/ad-spend for cost numbers. The two endpoints together provide enough signal to compute cost-per-lead and channel efficiency without leaving the Octanist dataset. Suitable for agencies running weekly client report-outs.

Call /api/stats and /api/ad-spend for the last 30 days and return cost-per-lead by campaign.

AI Agent Marketing Reporter

An AI marketing agent can answer ad-hoc questions like 'how much did we spend on Meta last week' by routing to Octanist through Jentic. The agent finds /api/ad-spend by intent, executes with the requested date range, and returns a natural-language summary. Credentials remain in the Jentic vault throughout, so the agent never sees the raw API key.

Use Jentic to call /api/ad-spend for last week and answer 'how much did we spend on paid channels'.

Key Endpoints

7 endpoints — octanist's api exposes lead capture, campaign statistics, and ad-spend data for performance marketing teams.

METHOD

PATH

DESCRIPTION

GET

/api/check

Validate API key and connectivity

POST

/api/leads

Create a new lead

GET

/api/leads/{id}

Retrieve a lead by ID

GET

/api/stats

Aggregated campaign statistics

GET

/api/ad-spend

Aggregated ad spend

GET

/api/check

Validate API key and connectivity

POST

/api/leads

Create a new lead

GET

/api/leads/{id}

Retrieve a lead by ID

GET

/api/stats

Aggregated campaign statistics

GET

/api/ad-spend

Aggregated ad spend

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Octanist API keys are stored encrypted in the Jentic vault. Agents receive scoped access — the X-API-KEY value is injected at execution time and never enters the agent's prompt.

Intent-based discovery

Agents search by intent (e.g. 'pull ad spend' or 'create a lead') and Jentic returns the matching Octanist operation with its input schema, so the agent calls the right endpoint without browsing docs.

Time to first call

Direct Octanist integration: 1 day for auth, lead-payload mapping, and date-range handling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Octanist API through Jentic.

What authentication does the Octanist API use?

An API key supplied via the X-API-KEY header. Jentic stores the key encrypted in its vault and injects it at execution time so the raw secret never enters the agent's prompt or model context.

Can I create a lead with the Octanist API?

Yes. POST to /api/leads with the lead payload — Octanist stores the record and returns its ID, which can later be fetched with /api/leads/{id}. This is the primary integration point for syncing webform submissions into Octanist.

What are the rate limits for the Octanist API?

Octanist does not encode a hard limit in the spec. Use /api/check at the start of scheduled jobs to confirm your key is valid, batch lead creation rather than sending one request per submission burst, and respect any 429 responses with exponential backoff.

How do I pull ad spend through Jentic?

Search Jentic for 'pull Octanist ad spend by date', load the schema for /api/ad-spend, and execute with the date range. With pip install jentic the call is await client.search(...), await client.load(...), await client.execute(...) inside an asyncio.run wrapper.

Is the Octanist API free?

API access is tied to an Octanist subscription — confirm tier-specific limits in your Octanist account. There is no separate free API tier exposed in the spec.

Does the API let me update or delete a lead?

The endpoints in this spec cover lead creation and retrieval but not update or delete operations. Make any record changes inside the Octanist UI or contact Octanist if your workflow needs write-back beyond /api/leads POST.