Hilos API

Name: Hilos API
Brand: Hilos API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsChat MessagingapiKey3 EndpointsREST

For Agents

Send and retrieve WhatsApp Business messages and look up contacts via Hilos. Authenticated with an API key in the Authorization header.

Install Jentic One Beta

Connect the Hilos API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Hilos 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 Hilos API.

Send a WhatsApp message to a contact through POST /messages

Retrieve message history with GET /messages for inbound triage and audit

List Hilos contacts to choose recipients before sending

Trigger templated outbound WhatsApp notifications from a backend job

GET STARTED

Start building with Hilos API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Hilos API for, with concrete tasks.

★ WhatsApp Order Notifications

E-commerce teams send order confirmations and shipping updates over WhatsApp because open rates beat email. Hilos's POST /messages endpoint accepts a recipient and message body, so an agent can fire a notification from an order-events queue. Templates are managed in Hilos itself and selected by name in the message payload.

When an order is shipped, send a WhatsApp message via POST /messages to the customer's phone number with the shipping confirmation template.

Sales Reply Triage

A sales team wants every inbound WhatsApp reply scored and routed. An agent polls GET /messages, classifies each new inbound message, and pushes high-intent leads into the CRM. Because the API surface is small, the integration is straightforward and most engineering effort goes into the classifier.

Every 5 minutes, fetch new messages from GET /messages, classify each as 'hot', 'warm', or 'spam', and push hot leads to the CRM.

Customer Support Conversation History

Support agents need full message history when picking up a conversation. Hilos exposes /messages and /contacts so an interface can render the contact list and the historical thread for the selected customer, all driven by the API key configured for the workspace.

Given a contact ID from /contacts, fetch the last 50 messages from /messages filtered by that contact and render the thread.

AI Agent WhatsApp Assistant

An AI agent answers customer questions over WhatsApp by consuming inbound messages via Hilos and replying with generated answers. Through Jentic, the agent searches for the send and list operations, loads their schemas, and executes them with the user's vault-stored Hilos API key.

When a new inbound message arrives, search Jentic for 'send a WhatsApp message via Hilos', generate an answer, and execute POST /messages to reply.

Key Endpoints

3 endpoints — jentic publishes the only available openapi specification for hilos api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/messages

Send a WhatsApp message

GET

/messages

List messages and replies

GET

/contacts

List contacts in the workspace

POST

/messages

Send a WhatsApp message

GET

/messages

List messages and replies

GET

/contacts

List contacts in the workspace

Why Jentic?

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

Credential isolation

Your Hilos API key is stored encrypted in the Jentic vault (MAXsystem). The agent receives a scoped execution token, and Jentic injects the key into the Authorization header at call time so the raw value never enters the model context.

Intent-based discovery

Agents search by intent (e.g., 'send a WhatsApp message via Hilos') and Jentic returns the POST /messages operation with its body schema, so the agent calls it with a recipient and template name without reading docs.

Time to first call

Direct Hilos integration: half a day for auth, template wiring, and a polling loop for inbound. Through Jentic: under 30 minutes — search, load schema, execute.

FAQs

Specific to using Hilos API through Jentic.

Why is there no official OpenAPI spec for Hilos API?

Hilos does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Hilos API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Hilos API use?

The Hilos API uses an API key passed in the Authorization header. Through Jentic, your Hilos API key is held in the MAXsystem vault and injected into the Authorization header at execution time, so the raw key never enters the agent context.

Can I send WhatsApp messages with the Hilos API?

Yes. POST /messages sends an outbound WhatsApp message from your Hilos workspace to a contact. Templates are configured in the Hilos UI and referenced by name in the request payload to comply with WhatsApp Business policy.

What are the rate limits for the Hilos API?

The Hilos OpenAPI specification does not declare rate limits, but WhatsApp Business itself enforces messaging tiers based on quality rating. Build retry-with-backoff and respect template restrictions to avoid having your number throttled by Meta.

How do I read the latest replies through Jentic?

Run pip install jentic, then await client.search('list Hilos messages'), load the GET /messages schema, and execute it on a polling schedule. Persist the last seen message ID so you only process new inbound messages.

Does Hilos handle SMS or voice as well as WhatsApp?

No. The Hilos API in this spec exposes WhatsApp messaging and contacts only. For SMS or voice you need a dedicated provider such as Twilio or MessageBird.

Hilos API

Connect the Hilos API to your agent

Capabilities

Start building with Hilos API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs