Agent-ready OpenAPI document · curated by JenticAnalyticsProduct Analyticsbearer3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Send leads, sales, and custom user events into Hyros for ad attribution and conversion tracking. Useful for piping CRM and checkout data into paid-media reporting.
Use for: I need to submit a new lead to Hyros after a form fill, I want to log a $97 sale in Hyros from a Shopify webhook, Send a custom event for a webinar registration to Hyros, Push offline phone-sale conversions into Hyros attribution
Not supported: Does not handle ad campaign creation, audience management, or reporting reads - use for submitting leads, sales, and custom events into Hyros only.
Jentic publishes the only available OpenAPI specification for Hyros API, keeping it validated and agent-ready. Hyros is an ad attribution and tracking platform used by direct-response advertisers to tie ad spend to revenue across paid channels. The API exposes three core write endpoints that let you submit lead records, log sales transactions, and record custom user events so Hyros can stitch them into multi-touch attribution reports. It is suited for ingesting first-party conversion data from checkout pages, CRMs, and call centres into the Hyros tracking model.
Install Jentic One Beta
Connect the Hyros API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Hyros 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.
1
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%2Fhyros.com%2Fhyros" | sh2
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%2Fhyros.com%2Fhyros" | 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.
Capabilities
What an agent can do with Hyros API.
Submit a new lead record with email, phone, and tracking identifiers to /v1/leads
Log a completed sale transaction with amount, currency, and customer identifiers to /v1/sales
Record a custom user event such as a webinar registration or upsell click to /v1/events
Tie offline conversions back to ad clicks by including Hyros tracking IDs on submitted records
Stream checkout and CRM events into Hyros for multi-touch attribution reporting
Use Cases
Patterns agents use Hyros API for, with concrete tasks.
★ Offline Conversion Import
Push closed-won deals from a CRM into Hyros so phone and field sales are attributed to the ad click that generated the lead. Records sent to /v1/sales include the original tracking ID, currency, and amount so Hyros can credit the right ad source. Typical setup wires a CRM webhook to a Jentic toolkit and runs in under a day.
Post a sale of 1499.00 USD with the lead email and Hyros tracking ID to /v1/sales when a CRM deal moves to Closed Won.
Checkout Lead Capture
Submit lead records from a checkout or opt-in form to Hyros via /v1/leads as soon as the visitor enters contact details, before payment completes. This lets Hyros track the visitor across devices and attribute the eventual sale to the original ad. Useful for funnels with a two-step checkout or a high-ticket offer that closes by phone.
Send a lead with email, first name, and the visitor's Hyros click ID to /v1/leads when an opt-in form is submitted.
Custom Event Logging
Record arbitrary funnel events such as webinar registrations, demo bookings, or upsell views to /v1/events so they appear alongside leads and sales in Hyros reports. Each event carries a name, a timestamp, and the user identifier needed to link it to an existing tracked visitor. This makes it possible to optimise paid campaigns against intermediate funnel signals, not only purchases.
Send a custom event named webinar_registered with the user email and timestamp to /v1/events when a registration is confirmed.
AI Agent Conversion Sync
An AI agent triggered by a CRM or e-commerce platform searches Jentic for the Hyros operation that submits a sale, loads its schema, and posts the conversion. Because Hyros has only a handful of endpoints, an agent can cover the full reporting surface with three operations and reliably reconcile conversion data without hand-rolled integration code. Typical end-to-end agent integration is under one hour through Jentic.
Use Jentic search for 'log a sale in Hyros', load the /v1/sales schema, and post the order with tracking ID, amount, and currency.
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for hyros api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v1/leads
Submit a new lead record
POST
/v1/sales
Log a sale transaction
POST
/v1/events
Record a custom user event
POST
/v1/leads
Submit a new lead record
POST
/v1/sales
Log a sale transaction
POST
/v1/events
Record a custom user event
Jentic AI Readiness Score
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.
H
Hyros API
- AI-Aware (A-)73/100
100
Foundational Compliance69
Developer Experience & Jentic Compatibility56
AI-Readiness & Agent Experience94
Agent Usability60
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
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).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
69
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B+Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
75%
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.
56
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
72%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
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.
60
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).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
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>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Hyros API by hand means setting up bearer-token auth and shaping each lead, sale, and event payload to its ingestion contract yourself. Through Jentic you install once, import the Hyros API from the API Directory, store the token once, and your agent calls it.
Permission scoping
Hyros takes the target lead, sale, or event in the request body rather than a URL path, so limit the agent to the operations it needs, such as submitting leads or logging events. You choose that allowed set, so an agent that only records events cannot post sales unless you add that operation.
Credential isolation
Your Hyros token 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 'submit a new lead to Hyros' or 'record a sale event', and Jentic returns the matching Hyros operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Hyros API through Jentic.
Why is there no official OpenAPI spec for Hyros API?
Hyros does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Hyros API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Hyros API use?
The Hyros API uses HTTP bearer token authentication. Through Jentic, the Hyros bearer token is stored in your Jentic One instance and never enters the agent's prompt context - agents call Hyros operations using a scoped Jentic credential instead of the raw token.
Can I submit offline sales to Hyros through this API?
Yes. POST a record to /v1/sales with the customer email, the original Hyros tracking ID, the sale amount, and the currency. Hyros uses the tracking ID to attribute the offline sale back to the ad click that generated the lead.
How many endpoints does the Hyros API expose?
The current spec covers three POST endpoints: /v1/leads, /v1/sales, and /v1/events. These are the write operations Hyros uses to ingest funnel data - read-side reporting is done in the Hyros dashboard, not via this API.
How do I send a custom event to Hyros through Jentic?
Search Jentic for 'log a custom event in Hyros', load the /v1/events schema, and execute the call with the event name, timestamp, and user identifier. Install the SDK with pip install jentic and run the search, load, and execute steps with await.
What are the rate limits for the Hyros API?
The published spec does not declare rate limits. Hyros enforces account-level limits documented in their developer portal at hyros.com - start with conservative batching (a few requests per second) and back off on 429 responses.
Can I limit what my agent is allowed to do with the Hyros API?
Yes. Because you run Jentic One yourself and set its rules, you decide which of the three Hyros write operations the agent may call: submitting leads to /v1/leads, logging sales to /v1/sales, or recording custom events to /v1/events. Hyros takes the target lead, sale, or event in the request body rather than a URL path, so you scope access at the operation level. An agent granted only event logging cannot post a sale unless you add that operation to its allowed set.
GET STARTED