Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Hyperplane API Gateway, 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%2Fsandbox-65ebc.chico.ai%2Fsandbox-65ebc-chico" | 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%2Fsandbox-65ebc.chico.ai%2Fsandbox-65ebc-chico" | 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 Hyperplane API Gateway API.
Get Token
Create an AutoML lookalike request
Rerun the inference and store the updated scores in the output connection of the
Query and filter Hyperplane API Gateway records by parameters
Monitor Hyperplane API Gateway operational status and events
GET STARTED
Patterns agents use Hyperplane API Gateway API for, with concrete tasks.
★ Developer Tools Operations
Use the Hyperplane API Gateway to perform developer tools operations programmatically. The API provides 29 endpoints covering core functionality including get token, create an automl lookalike request, get all automl runs in a specified module.
Call POST /v1/auth/token to get token
Automated AutoML Service Management
Automate automl service operations by combining multiple Hyperplane API Gateway endpoints. Agents can create an automl lookalike request and then get all automl runs in a specified module in a single workflow.
Call POST /v1/automl/lookalike to create an automl lookalike request, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Hyperplane API Gateway 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 'get token', load the operation schema, and execute with Jentic-managed credentials
29 endpoints — sandbox-65ebc.
METHOD
PATH
DESCRIPTION
/v1/auth/token
Get Token
/v1/automl/lookalike
Create an AutoML lookalike request
/v1/automl/runs
Get all AutoML runs in a specified module
/v1/automl/runs/{run_id}
Get run summary for a specified AutoML run
/v1/automl/runs/{run_id}/generate_batch_scores
Rerun the inference and store the updated scores in the output connection of the
/v1/automl/runs/{run_id}/rescore
Rerun inference on latest user snapshots to update scores
/v1/automl/runs/{run_id}/status
Get status of a specified AutoML run
/v1/automl/runs/{run_id}/status_batch_scores
Get status of the batch scores request for an AutoML run
/v1/auth/token
Get Token
/v1/automl/lookalike
Create an AutoML lookalike request
/v1/automl/runs
Get all AutoML runs in a specified module
/v1/automl/runs/{run_id}
Get run summary for a specified AutoML run
/v1/automl/runs/{run_id}/generate_batch_scores
Rerun the inference and store the updated scores in the output connection of the
/v1/automl/runs/{run_id}/rescore
Rerun inference on latest user snapshots to update scores
/v1/automl/runs/{run_id}/status
Get status of a specified AutoML run
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Hyperplane API Gateway by hand means obtaining a token, sending the PASETO key in the Authorization header to the sandbox host, and polling AutoML run status with your own retries. Through Jentic you install once, import Hyperplane from the API Directory, store the key once, and your agent calls it.
Permission scoping
Hyperplane puts the run id in the URL path (/v1/automl/runs/{run_id}/status), so a rule can pin your agent to specific runs: it can check status and read the runs you allow and nothing else. You choose the operations it may call, so actions like rescoring or generating batch scores are not included unless you add them.
Credential isolation
Your Hyperplane 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 'get an access token' or 'check an AutoML run status', and Jentic returns the matching Hyperplane 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 Hyperplane API Gateway API through Jentic.
What authentication does the Hyperplane API Gateway use?
The Hyperplane API Gateway uses an API key passed in the `Authorization` 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 get token with the Hyperplane API Gateway?
Yes. Use the POST /v1/auth/token endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Hyperplane API Gateway?
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 get token through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get token'. Jentic returns the matching Hyperplane API Gateway operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Hyperplane API Gateway have?
The Hyperplane API Gateway exposes 29 endpoints covering automl service, personas, enriched transactions operations.
Can I limit what my agent is allowed to do with the Hyperplane API Gateway?
Yes. Because you run Jentic One yourself, your own rules decide which Hyperplane operations and credentials the agent may use, so you can grant read-only access such as GET /v1/automl/runs/{run_id}/status while withholding everything else. Since Hyperplane puts the run id in the URL path, a rule can pin the agent to specific runs, letting it check status and read only the runs you permit. Write actions like POST /v1/automl/runs/{run_id}/rescore or generate_batch_scores stay off limits unless you explicitly add them.
Know of an official OpenAPI document? Contribute it →
For Agents
Programmatically get token, create an automl lookalike request. Covers 29 operations with apiKey authentication.
Use for: I need to token, I want to an automl lookalike request, Search for all automl runs in a specified module, Find all run summary for a specified automl run
Not supported: Does not handle payments, communications, or crm - use for developer tools only.
sandbox-65ebc.chico.ai/main version 1.0. The API exposes 29 endpoints secured with apiKey authentication.
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
/v1/automl/runs/{run_id}/status_batch_scores
Get status of the batch scores request for an AutoML run
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>