Install Jentic One Beta

Connect the HeyYumi API to your agent

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

Search food and drink venues and filter by category, region, price band, rating, and freshness

Run a nearby search to find venues around a point

Retrieve a venue's full detail, including standardized hours and menu, using a field mask on the fields param

Request a reservation at a venue and poll its status

Ask a venue for its live status right now and read the result

GET STARTED

Start building with HeyYumi API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use HeyYumi API for, with concrete tasks.

★ Agent Venue Discovery and Booking

An AI concierge agent uses the HeyYumi API through Jentic to find, recommend, and book food and drink venues: it searches places by category, region, and price band, reads a venue's standardized hours, menu, and rating, and requests a reservation, then polls the reservation status. A field mask on the fields query param lets the agent pull only the tiers it needs, keeping responses lean. Because a reservation is a single POST and status is a long-poll GET, the agent can complete a booking end to end.

Search venues in a region filtered by price band, read the top result's hours and menu, then request a reservation and poll its status

Nearby Food & Drink Search

A local-discovery app finds venues around a point using the HeyYumi nearby search, returning identity, location, standardized hours, rating, and freshness for each. The fields query param selects which tiers come back, and the regions and categories endpoints help turn a neighborhood name or cuisine into a filter. This powers a 'what is good near me' experience on refined venue data.

Run a nearby search around a coordinate, filter to open venues, and return each venue's name, rating, and hours

Live Venue Status Checks

Before recommending a venue, an application confirms its current state with the HeyYumi live-status endpoint, which asks the venue right now and returns the answer on a long-poll. Paired with the standardized hours and the freshness and confidence signals on each place, this reduces the chance of sending a user to a closed or stale listing. The result is retrieved by its queryId once ready.

Submit a live-status query for a venue, then poll the result by queryId and report whether it is open

Key Endpoints

13 endpoints — the heyyumi api serves refined food and drink venue data so an agent can find, recommend, and book places: each venue carries identity, location, standardized hours, menu, price band, rating, and freshness and confidence signals.

METHOD

PATH

DESCRIPTION

GET

/api/v1/places

Search food and drink venues

GET

/api/v1/places/nearby

Nearby venue search

GET

/api/v1/places/{id}

Venue detail

GET

/api/v1/places/{id}/history

Venue history

POST

/api/v1/reservations

Request a reservation

GET

/api/v1/reservations/{id}

Reservation status (long-poll)

POST

/api/v1/live-status

Ask the venue its live status now

GET

/api/v1/regions

Resolve a region or dong name

GET

/api/v1/places

Search food and drink venues

GET

/api/v1/places/nearby

Nearby venue search

GET

/api/v1/places/{id}

Venue detail

GET

/api/v1/places/{id}/history

Venue history

POST

/api/v1/reservations

Request a reservation

GET

/api/v1/reservations/{id}

Reservation status (long-poll)

POST

/api/v1/live-status

Ask the venue its live status now

GET

/api/v1/regions

Resolve a region or dong name

Why Jentic?

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

Setup

Wiring the HeyYumi API by hand means handling its bearer token or `X-API-Key` header, learning the field-mask tiers on the fields query param, and polling reservation and live-status results yourself. Through Jentic you install once, import it from the API Directory, store the key once, and your agent calls it.

Permission scoping

HeyYumi puts the place and reservation ids in the URL path, so a rule can bound your agent to specific read operations while leaving writes out. You choose the operations it may call, so a read-only agent can search venues and read details without being able to request a reservation unless you add that operation.

Credential isolation

Your HeyYumi 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 'find a restaurant nearby' or 'book a table', and Jentic returns the matching HeyYumi operation with its input schema so the agent sets the right filters without reading the reference docs.

FAQs

Specific to using HeyYumi API through Jentic.

What authentication does the HeyYumi API use?

The HeyYumi API accepts a bearer token in the Authorization header or an API key in the `X-API-Key` header, per its OpenAPI spec; passing the key in the query string is deprecated. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never appears in a URL or the agent's logs.

Can I search and book venues with the HeyYumi API?

Yes. You search places, run a nearby search, and read a venue's detail, hours, menu, and rating, using the fields query param to choose which tiers you receive. You then request a reservation with a single POST and poll its status, and you can ask a venue for its live status right now.

What are the rate limits for the HeyYumi API?

The OpenAPI spec does not specify request rate limits; billing is tiered by the fields you request through the field mask. For current limits and tier details, see the HeyYumi documentation at https://heyyumi.ai.

How do I book a venue through Jentic?

Search Jentic with a query like 'book a table', add the HeyYumi API from the directory, and store your API key once. Your agent searches for a venue, requests a reservation with a POST, and polls the reservation status until it resolves. 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 HeyYumi API?

Yes. Write a rule that allows only the read operations, such as searching places and reading venue details, so the agent can discover and recommend venues but cannot request a reservation unless you add that operation, with every call logged. Place and reservation ids travel in the URL path, so scoping bounds which operations run.

Is there a HeyYumi API MCP server?

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

HeyYumi API

AI ReadinessAI-Aware (B)65/100

See full scorecard

Official vendor OpenAPI document · agent-readyMaps GeolocationPlaces Searchbearer, apiKey13 EndpointsREST

For Agents

Search refined food and drink venue data by category, region, and price band, read standardized hours and ratings, check a venue's live status, and request a reservation. A curated dining dataset served as a REST API.

Use for: Find food and drink venues near a location, Search venues by category and price band, Get the full detail and hours for a venue by id, Request a reservation at a restaurant

Not supported: Does not deliver food, process payments, or cover venues outside its curated food and drink dataset. Use for discovering, detailing, and booking food and drink venues only.

The HeyYumi API serves refined food and drink venue data so an agent can find, recommend, and book places: each venue carries identity, location, standardized hours, menu, price band, rating, and freshness and confidence signals. You search and run nearby lookups, read a venue's full detail and history, resolve regions and categories, and request reservations. A field mask on the fields query param lets you choose which data tiers you receive, and a live-status endpoint asks a venue its current state on demand.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: A-Signals: 4

97%

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

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: BSignals: 4

38%

Example Density

How richly the API is illustrated with examples.

76%

Example Validity

Percentage of examples that conform to their schemas.

50%

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: D+Signals: 4

63%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

85%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

50%

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

55%

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

76%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the HeyYumi API to your agent

Capabilities

Start building with HeyYumi API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

HeyYumi API

Jentic AI Readiness Score

HeyYumi 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