Ntfy Sh ntfy API
56
AI ReadinessFoundational (C)56/100
Official vendor OpenAPI document · agent-readyCommunicationsPush Notificationsoptional (basic or bearer)7 EndpointsREST
For Agents
Publish push notifications to a topic with titles, priorities, tags, and attachments, and subscribe to a topic as JSON, SSE, raw text, or WebSocket.
Use for: Publish a notification to a topic, Send an alert with a high priority and tags, Subscribe to a topic and stream new messages, I want to attach a file to a notification
Not supported: Does not handle SMS, voice calls, or email delivery. Use for topic-based push notifications only.
The ntfy API is an open-source push notification service that sends and receives notifications over simple HTTP requests. Its publish and subscribe operations need no credential for public topics, so a message can be sent with a single request. Publishing supports titles, priorities, tags, actions, attachments, and scheduled delivery, and subscribers can read a topic as a JSON stream, Server-Sent Events, raw text, or a WebSocket.
Install Jentic One Beta
Connect the ntfy API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ntfy 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%2Fntfy.sh%2Fntfy" | 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%2Fntfy.sh%2Fntfy" | 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 ntfy API.
Publish a notification to a topic with a title, priority, tags, and actions
Attach a file or schedule delivery when publishing a message
Subscribe to a topic as a JSON stream, Server-Sent Events, raw text, or WebSocket
Publish a notification using a JSON payload to the root endpoint
Send notifications to public topics without an account
Use Cases
Patterns agents use ntfy API for, with concrete tasks.
★ AI Agent Alerting
An AI agent connected through Jentic sends operational alerts by publishing a notification to a topic when a task finishes or fails, setting a priority and tags so the message is easy to triage. Because public topics need no account, the agent can start sending with a single request.
Publish a high-priority notification with a title and tags to a topic when a job finishes
Message Subscription Stream
A service subscribes to an ntfy topic and processes each new message as it arrives, choosing a JSON stream or Server-Sent Events depending on the client. This turns a topic into a lightweight message channel between systems.
Subscribe to a topic via Server-Sent Events and process each new message
Self-Hosted Push Without Accounts
A team running its own ntfy instance publishes notifications to public topics without managing credentials, keeping the whole flow on its own infrastructure. Optional token or Basic auth can be added later for private topics.
Publish a notification to a public topic without any credential
Key Endpoints
7 endpoints — the ntfy api is an open-source push notification service that sends and receives notifications over simple http requests.
METHOD
PATH
DESCRIPTION
POST
/{topic}
Publish a notification to a topic
PUT
/{topic}
Publish a notification to a topic (PUT variant)
POST
/
Publish a notification using a JSON payload
GET
/{topic}/json
Subscribe via a JSON stream
GET
/{topic}/sse
Subscribe via Server-Sent Events
GET
/{topic}/ws
Subscribe via WebSocket
POST
/{topic}
Publish a notification to a topic
PUT
/{topic}
Publish a notification to a topic (PUT variant)
POST
/
Publish a notification using a JSON payload
GET
/{topic}/json
Subscribe via a JSON stream
GET
/{topic}/sse
Subscribe via Server-Sent Events
GET
/{topic}/ws
Subscribe via WebSocket
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.
N
ntfy API
- Foundational (C)56/100
93
Foundational Compliance52
Developer Experience & Jentic Compatibility44
AI-Readiness & Agent Experience94
Agent Usability35
Security59
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
93
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
98%
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).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
52
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: C-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
21%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
87%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
44
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
21%
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.
54%
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.
35
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
35%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
59
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: C+Signals: 1
59%
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 ntfy API by hand means choosing between public topics and optional Basic or bearer auth, and shaping each publish request with its title, priority, and tags yourself. Through Jentic you install once, import ntfy from the API Directory, store a token only if you need one, and your agent calls it.
Permission scoping
ntfy puts the topic in the URL path (/{topic}), so a rule can pin your agent to one topic. You choose the operations it may call, such as publishing to that topic, so subscribing to other topics is not included unless you add it.
Credential isolation
If you use an ntfy access token or Basic credentials, they are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'send a push notification' or 'subscribe to a topic', and Jentic returns the matching ntfy operation with its input schema so the agent calls the right endpoint without reading the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using ntfy API through Jentic.
What authentication does the ntfy API use?
Authentication is optional: ntfy supports HTTP Basic and bearer access-token auth, as declared in its OpenAPI spec, but the publish and subscribe operations need no credential for public topics. Through Jentic any token you do use is stored encrypted by your own Jentic One instance and injected at call time.
Can I set a priority and tags on a notification with the ntfy API?
Yes. When you publish to a topic you can set a title, priority, tags, and actions, attach a file, or schedule the message for later delivery.
What are the rate limits for the ntfy API?
The OpenAPI spec does not specify rate limits for the ntfy API. See the ntfy documentation at https://docs.ntfy.sh for the limits on the public server or configure your own on a self-hosted instance.
Can I limit what my agent is allowed to do with the ntfy API?
Yes. Write a rule that allows only publishing to one topic by naming it in the path, so the agent can send alerts to that topic but cannot subscribe to or publish on others, and every call it makes is logged.
How do I send a notification with the ntfy API through Jentic?
Search Jentic for 'send a push notification', add the ntfy API from the directory, and store a token once if you use private topics. Your agent then publishes a message to a topic in one call. To run it on your own infrastructure, install Jentic One from its GitHub repo.
Is there an ntfy API MCP server?
You don't need an MCP server to give your agent the ntfy API. Jentic connects it directly from the API Directory: import it, and your agent calls the publish and subscribe operations. That keeps extra tool definitions out of the agent's context.
GET STARTED