Install Jentic One Beta

Connect the HelmIQ API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the HelmIQ 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%2Fhelmiq.net%2Fhelmiq" | 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%2Fhelmiq.net%2Fhelmiq" | 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 HelmIQ API.

List contacts and retrieve a single contact by id, scoped to your organization

Create and update contacts when the key carries the write scopes

List and look up companies, and add or update company records

Browse deals and retrieve one deal by id, read-only

Fetch the live OpenAPI document that describes the workspace

GET STARTED

Start building with HelmIQ API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use HelmIQ API for, with concrete tasks.

★ Agent-Maintained CRM Records

An AI agent keeping a CRM tidy uses the HelmIQ API through Jentic to read and update the organization's contacts and companies: it lists contacts, retrieves one by id, and patches details, and it creates or updates company records when the key carries the write scopes. All data is scoped to the organization that owns the key, so the agent only ever sees that workspace. Deals are available read-only for context when qualifying a contact.

List contacts, retrieve one by id, update its details, then look up the related company

Company and Deal Lookup

A reporting workflow reads the organization's companies and deals to build a snapshot. The HelmIQ API lists companies and deals and retrieves any one of them by id, all scoped to the key's organization. Because deals are read-only here, the workflow can pull pipeline context without risk of changing it.

List companies and deals, then retrieve the full record for one company and one deal by id

Contact Creation From Inbound Leads

When a lead arrives, an application creates a contact and the company it belongs to in HelmIQ, then updates them as more detail comes in. The API accepts create and update calls on contacts and companies for keys that hold the write scopes, keeping the CRM current without manual entry. Reads stay available even on a read-only key.

Create a company, create a contact linked to it, then update the contact by id

Key Endpoints

11 endpoints — the helmiq api reads and maintains the contacts, companies, and deals in a helmiq crm workspace.

METHOD

PATH

DESCRIPTION

GET

/contacts

List contacts

POST

/contacts

Create a contact

PATCH

/contacts/{id}

Update a contact by id

GET

/companies

List companies

POST

/companies

Create a company

GET

/deals

List deals

GET

/deals/{id}

Retrieve a deal by id

GET

/contacts

List contacts

POST

/contacts

Create a contact

PATCH

/contacts/{id}

Update a contact by id

GET

/companies

List companies

POST

/companies

Create a company

GET

/deals

List deals

GET

/deals/{id}

Retrieve a deal by id

Why Jentic?

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

Setup

Wiring the HelmIQ API by hand means issuing an API key, sending it as a bearer token on every request, and tracking which write scopes the key holds before an update. Through Jentic you install once, import it from the API Directory, store the key once, and your agent calls it.

Permission scoping

A HelmIQ key is issued with specific scopes, so a read-only key already blocks writes to contacts and companies. A Jentic rule can go further and allow only the operations your agent needs, such as listing and reading records, while leaving create and update out unless you add them.

Credential isolation

Your HelmIQ API key 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 'list CRM contacts' or 'create a company', and Jentic returns the matching HelmIQ operation with its input schema so the agent calls the right endpoint without reading the reference docs.

FAQs

Specific to using HelmIQ API through Jentic.

What authentication does the HelmIQ API use?

The HelmIQ API authenticates with an API key sent as a bearer token in the Authorization header, an `hk_live_` key, per its OpenAPI spec. All data is scoped to the organization that owns the key, and write operations require a key that carries the write scopes. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time.

Can I create and update contacts with the HelmIQ API?

Yes, when your key carries the write scopes. You can create a contact, update one by id, and do the same for companies, while listing and retrieving contacts, companies, and deals works on any key. Deals themselves are read-only.

What are the rate limits for the HelmIQ API?

The OpenAPI spec does not specify rate limits. For current limits, see the HelmIQ documentation at https://helmiq.net.

How do I update a contact through Jentic?

Search Jentic with a query like 'update a CRM contact', add the HelmIQ API from the directory, and store your bearer API key once. Your agent lists contacts, finds the one it needs, and patches it by id, all scoped to your organization. To run it on your own infrastructure, install Jentic One from its GitHub repo.

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

Yes. Start with a read-only HelmIQ key so the agent cannot write at all, then write a Jentic rule that allows only the operations it needs, such as listing and retrieving contacts and companies, and leave create and update out unless you add them, with every call logged. Record ids travel in the URL path, so scoping bounds which operations run.

Is there a HelmIQ API MCP server?

You don't need an MCP server to give your agent the HelmIQ API. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent calls the contact, company, and deal operations on demand without loading another server's tool definitions into its context.

HelmIQ API

AI ReadinessAI-Aware (B+)70/100

See full scorecard

Official vendor OpenAPI document · agent-readyCRMContact Managementbearer11 EndpointsREST

For Agents

List, read, create, and update HelmIQ CRM contacts and companies, and read deals, all scoped to one organization by the API key. A compact REST surface for keeping a CRM current.

Use for: List all contacts in my HelmIQ workspace, Create a new contact for a company, Update a contact's details by id, Get a single company record by id

Not supported: Does not send email, manage tasks, or process payments. Use for reading and maintaining HelmIQ contacts, companies, and deals only.

The HelmIQ API reads and maintains the contacts, companies, and deals in a HelmIQ CRM workspace. You list and retrieve contacts and companies, create and update them when your key carries the write scopes, and browse deals read-only for pipeline context. All data is scoped to the organization that owns the key, so an application only ever works with its own workspace.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A-Signals: 4

98%

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).

14%

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.

70%

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

61%

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.

58%

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: B-Signals: 1

60%

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: ASignals: 1

86%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the HelmIQ API to your agent

Capabilities

Start building with HelmIQ API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

HelmIQ API

Jentic AI Readiness Score

HelmIQ 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