Heedjy API

Name: Heedjy API
Brand: Heedjy API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceStorefrontoauth22 EndpointsREST

For Agents

Authenticate with OAuth 2.0 and list apps available on a Heedjy marketplace through 2 endpoints.

Install Jentic One Beta

Connect the Heedjy API to your agent

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

Exchange client credentials for an OAuth 2.0 access token via POST /api/oauth2/token

List apps published on the connected Heedjy marketplace via GET /api/v1/apps

Filter app listings by query parameters supported on /api/v1/apps for paginated browsing

GET STARTED

Start building with Heedjy API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Heedjy API for, with concrete tasks.

★ Embedded Marketplace App Picker

A SaaS product embeds Heedjy's app catalog inside a settings page so end-users can browse and install third-party integrations. The token endpoint authenticates the SaaS, and GET /api/v1/apps returns the catalog payload that the UI renders. The integration only needs two endpoints to power the picker.

Call POST /api/oauth2/token with client credentials, then GET /api/v1/apps with the bearer token to render a list of marketplace apps

Catalog Sync to Internal Database

An ops team mirrors the Heedjy app catalog into their internal database nightly so analytics and merchandising teams can join it against installation data. The OAuth token plus a single paginated GET /api/v1/apps call provides the canonical app records.

Authenticate with POST /api/oauth2/token, then iterate GET /api/v1/apps with pagination and upsert each record into the internal catalog table

Token Lifecycle Manager

A platform service manages OAuth 2.0 tokens for many tenants, refreshing them ahead of expiry. The /api/oauth2/token endpoint accepts client credentials and returns a token plus expiry, letting the service schedule renewal jobs.

Call POST /api/oauth2/token with grant_type=client_credentials and persist the returned access_token and expires_in for renewal

AI Agent Marketplace Browser

An AI assistant helps users discover Heedjy apps by intent, e.g. 'find a CRM integration for my store'. Through Jentic, the agent obtains a token, calls /api/v1/apps, and filters the response by name or category before presenting matches.

Search Jentic for 'list marketplace apps', load the GET /api/v1/apps operation, and return the apps whose names match a user-supplied keyword

Key Endpoints

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

METHOD

PATH

DESCRIPTION

POST

/api/oauth2/token

Exchange client credentials for an access token

GET

/api/v1/apps

List apps on the Heedjy marketplace

POST

/api/oauth2/token

Exchange client credentials for an access token

GET

/api/v1/apps

List apps on the Heedjy marketplace

Why Jentic?

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

Credential isolation

Heedjy OAuth 2.0 client_id and client_secret are stored encrypted in the Jentic vault. Tokens are minted at execution time and the secrets never enter the agent's context.

Intent-based discovery

Agents search by intent (e.g. 'list marketplace apps' or 'get an oauth token for heedjy') and Jentic returns the matching operation with its parameters typed, including the token-then-list call sequence.

Time to first call

Direct integration: a few hours to wire up the OAuth client-credentials grant and bearer token storage. Through Jentic: under 30 minutes — search, load, execute.

FAQs

Specific to using Heedjy API through Jentic.

Why is there no official OpenAPI spec for Heedjy API?

Heedjy publishes reference docs on heedjy.readme.io but does not distribute a maintained OpenAPI file. Jentic generates and maintains this spec so that AI agents and developers can call Heedjy 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 Heedjy API use?

Heedjy uses OAuth 2.0 client-credentials flow. POST /api/oauth2/token returns a bearer token that is sent as Authorization: Bearer ... on /api/v1/apps. Through Jentic, the client_id and client_secret live in the encrypted vault.

Can I list every app on my Heedjy marketplace with this API?

Yes. GET /api/v1/apps returns the catalog of apps for the connected client. Pagination parameters on the endpoint let an agent walk the full list in chunks.

What are the rate limits for the Heedjy API?

The OpenAPI spec does not declare hard rate limits; Heedjy applies fair-use limits per client. For catalog sync jobs, request a fresh token only when the previous one is near expiry rather than on every call.

How do I authenticate and list apps through Jentic?

Run pip install jentic, have the agent search for 'list marketplace apps', load the operation chain (token then apps), and execute it with the stored client credentials.

Does the Heedjy API support creating or updating apps?

No. The current published surface is limited to issuing tokens and listing apps. Authoring or editing app records happens inside the Heedjy admin UI.