Install Jentic One Beta

Connect the NudgeHost v1 API to your agent

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

Start an upload with filename, contentType, and fileSize and receive a presigned PUT URL plus the file's slug

Request a readable link with desiredSlug, falling back to a random slug when it is taken or reserved

Complete an upload to get the final link and its kind: file, docx, or site, among others

Publish a ZIP archive as a static site served from its own subdomain

GET STARTED

Start building with NudgeHost v1 API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use NudgeHost v1 API for, with concrete tasks.

★ Agent that shares its output as a link

A coding or research agent produces a PDF report and needs to hand the user a URL rather than an attachment. Through Jentic the agent searches for 'upload a file and get a shareable link', gets the NudgeHost start-upload operation with its input schema, and sends filename, contentType, and fileSize. It PUTs the bytes to the returned upload.url within the expiresInSeconds window, then calls the complete step and returns the url it reports.

Call POST /api/v1/uploads with filename q3-report.pdf, contentType application/pdf, and fileSize 184320, PUT the bytes to upload.url with upload.headers, then call POST /api/v1/uploads/{id}/complete and return the url

Publish a static site from a ZIP

A developer wants a quick public preview of a built static site. Uploading the ZIP through the same two-step flow lets the complete step unpack it, and when it unpacks into a site the kind is site and the url moves to the site's own subdomain. Calling complete twice is safe and returns the stored result instead of redoing the unpack.

Call POST /api/v1/uploads with filename site.zip, contentType application/zip, the exact fileSize, and desiredSlug launch-preview, PUT the archive to upload.url, then call POST /api/v1/uploads/{id}/complete and confirm kind is site

Link inventory and engagement check

Someone sharing many files wants to know which links get opened. GET /api/v1/files returns a keyset-paginated listing with limit and cursor, and each FileSummary carries viewCount, hasPassword, kind, and url. Deleted files are left out unless includeDeleted is set, and view counts survive deletion.

Call GET /api/v1/files with limit 50, follow the cursor until the listing ends, and report the five files with the highest viewCount

Retiring an outdated link

When a shared document is out of date, its link should stop serving. DELETE /api/v1/files/{id} soft-deletes the file and the serving path checks the deleted flag on every request, so the link stops immediately. A custom domain on the file stays attached and must be detached separately.

Call GET /api/v1/files to find the file whose filename is old-pricing.pdf, call DELETE /api/v1/files/{id} with its id, then call GET /api/v1/files with includeDeleted=true to confirm isDeleted is true

Key Endpoints

8 endpoints — the nudgehost v1 api uploads files to nudgehost and returns a public link to each one, then lists and soft-deletes them.

METHOD

PATH

DESCRIPTION

POST

/api/v1/uploads

Start an upload

POST

/api/v1/uploads/{id}/complete

Complete an upload

GET

/api/v1/files

List files

DELETE

/api/v1/files/{id}

Delete a file

POST

/api/v1/uploads

Start an upload

POST

/api/v1/uploads/{id}/complete

Complete an upload

GET

/api/v1/files

List files

DELETE

/api/v1/files/{id}

Delete a file

Why Jentic?

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

Setup

Wiring NudgeHost by hand means sending the bearer key to the www host rather than the redirecting apex, chaining start, PUT, and complete steps, and handling the expiring presigned URL. Through Jentic you install once, import NudgeHost from the API Directory, store the key once, and your agent calls it.

Permission scoping

NudgeHost keys carry full account authority with no scopes, so the rule is where the limit lives: each operation has its own path, such as /api/v1/uploads and /api/v1/files/{id}, and a rule can bound your agent to the ones its task needs. You choose the operations it may call, so file deletion is not included unless you add it.

Credential isolation

Your NudgeHost 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 'upload a file and get a shareable link' or 'list my hosted files', and Jentic returns the matching NudgeHost operation with its input schema, including filename, contentType, fileSize, and desiredSlug, so the agent calls the right endpoint directly.

FAQs

Specific to using NudgeHost v1 API through Jentic.

What authentication does the NudgeHost v1 API use?

Per its OpenAPI spec, the NudgeHost v1 API uses HTTP bearer authentication with an API key that begins with nh_sk_, created in the account dashboard. The spec notes a key carries the full authority of its account, with no scopes or read-only keys. Through Jentic the key is held by your own instance and injected at call time.

Why does the NudgeHost v1 API refuse my key as unauthorized?

Check the host. The apex nudgehost.com answers with a 308 redirect to www.nudgehost.com, and clients drop the Authorization header on that cross-origin hop, so the call arrives without a credential. Point your client at https://www.nudgehost.com directly.

What are the rate limits for the NudgeHost v1 API?

The spec states requests are counted per key over a one-minute window: 20 per minute on the free plan, 60 on Pro, and 150 on Studio. Going over returns rate_limited with a Retry-After header, and there are no headers reporting remaining quota, so pace calls yourself.

How does uploading work with the NudgeHost v1 API?

It takes two calls and a PUT. POST /api/v1/uploads with filename, contentType, and fileSize returns a presigned upload.url, you PUT exactly fileSize bytes to it before expiresInSeconds runs out, and then POST /api/v1/uploads/{id}/complete returns the final url and kind. If complete reports upload_incomplete, the id is spent and you start a new upload.

How do I upload a file and share the link through Jentic?

Search Jentic for 'upload a file and get a shareable link', load the NudgeHost start-upload operation, and send the filename, contentType, and fileSize. After the bytes are PUT to the returned upload.url, call the complete operation and hand the user the url it returns. To run it on your own infrastructure, install Jentic One from its GitHub repo.

Is there a NudgeHost MCP server?

You do not need an MCP server to give your agent NudgeHost. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent calls the upload, list, and delete operations it needs on demand.

Can I limit what my agent is allowed to do with the NudgeHost v1 API?

Yes, and it matters here because a NudgeHost key has no scopes of its own. Write a rule that allows POST /api/v1/uploads, POST /api/v1/uploads/{id}/complete, and GET /api/v1/files, and the agent can publish and list files but cannot call DELETE /api/v1/files/{id}. The calls it makes are logged for review.

NudgeHost v1 API

AI ReadinessAI-Aware (B)66/100

See full scorecard

Official vendor OpenAPI document · agent-readyStorageObject Storagebearer8 EndpointsREST

For Agents

Upload a file to NudgeHost in two steps and get a shareable public link, publish a ZIP as a static site, list uploaded files with their view counts, and soft-delete a file.

Use for: Upload this PDF and give me a shareable link, Publish a ZIP of my static site to a public URL, Share a report under the slug team-handbook, List the files I have uploaded to NudgeHost

Not supported: Does not sync folders, edit documents, manage collaborators, or detach custom domains. Use for uploading files to NudgeHost, publishing them as public links or static sites, listing them, and deleting them only.

The NudgeHost v1 API uploads files to NudgeHost and returns a public link to each one, then lists and soft-deletes them. Uploading is two steps: the start step creates the file row and returns a presigned storage URL that the bytes are PUT to, and the complete step confirms they landed and decides how the link serves the file. A plain file is served from the viewer path, a word processor document is converted for viewing with the original kept downloadable, and a ZIP that unpacks into a static site is served from its own subdomain. The file listing is keyset-paginated and reports each link's view count, password flag, and deleted state.

Jentic One on Github View OpenAPI Document

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.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: B+Signals: 4

20%

Example Density

How richly the API is illustrated with examples.

100%

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

75%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

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

81%

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

60%

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

34%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the NudgeHost v1 API to your agent

Capabilities

Start building with NudgeHost v1 API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

NudgeHost v1 API

Jentic AI Readiness Score

NudgeHost v1 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