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.
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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | shStep 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 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
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
/v1/automl/runs/{run_id}/status_batch_scores
Get status of the batch scores request for an AutoML run
Three things that make agents converge on Jentic-routed access.
Credential isolation
Hyperplane API Gateway apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.
Intent-based discovery
Agents search by intent (e.g., 'get token') and Jentic returns the matching Hyperplane API Gateway operation with its input schema, so the agent can call the right endpoint without browsing docs.
Time to first call
Direct Hyperplane API Gateway integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.
Alternatives and complements available in the Jentic catalogue.
Github
Alternative developer tools API
Choose Github when you need a different approach to developer tools operations
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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.
GET STARTED