neuralpress
v1.0.9
Published
Official Node.js & TypeScript SDK for the NeuralPress AI News API. Query, search, and stream real-time aggregated global news with AI summaries, translations, and verified semantic insights.
Maintainers
Readme
NeuralPress: AI News API & Global News Aggregator SDK
The official Node.js & TypeScript client SDK for the NeuralPress AI News API. Programmatically ingest, search, and aggregate global news feeds with structured data, real-time AI summaries, multi-lingual translations, and semantic keyword filtering.
🔗 Official Website & Console: neuralpress.site
🔑 Developer Portal: console.neuralpress.site
Key Features
- 🌐 Unified News Aggregator: Query articles across thousands of verified publications and local sources.
- 🤖 AI-Synthesized Summaries: Retrieve direct, clean-structured summaries powered by advanced LLMs.
- 🗣️ Multi-Lingual Translation: Built-in translation options including Sinhala titles and summaries.
- 🔍 Fuzzy & Semantic Search: Search news articles with advanced fuzzy scoring, keywords, and relevance indicators.
- 📄 Structured References: Access parsed, LLM-ready markdown content from original source articles.
- 🛡️ TypeScript Native: Full autocomplete safety and robust interface declarations.
Installation
npm install neuralpressRequires Node.js version 18.0.0 or higher (utilizes native global fetch utility).
Getting Started: Obtaining an API Key
To integrate the NeuralPress API, you must configure a developer access key:
- Create an Account: Go to the official website at neuralpress.site and register a developer profile.
- Generate API Key: Navigate to the Developer Keys Console and create a new active API key. Keep this key secure as it authenticates your requests.
- Monitor Usage & Responses: Visit the main Developer Dashboard to view logs, remaining daily quotas, request latency, and raw response details.
Integration & Quick Start Examples
Below are standard patterns to consume the NeuralPress AI News SDK in both modern modules and legacy CommonJS servers.
ES Modules & TypeScript (Next.js, Vite, NestJS)
import { NeuralPress } from "neuralpress";
// Initialize the news API client using your developer key
const client = new NeuralPress("YOUR_DEVELOPER_API_KEY");
async function main() {
try {
// 1. Fetch recent news feeds and aggregated articles
const articles = await client.getNews({
limit: 10,
category: "Sri Lanka",
});
console.log("Aggregated News Articles:", articles);
// 2. Perform fuzzy semantic search across indexed sources
const results = await client.searchNews("Artificial Intelligence", {
limit: 5,
});
console.log("Search Query Results:", results);
} catch (error: any) {
console.error("NeuralPress Client Error:", error.message);
}
}
main();CommonJS (Node.js & Express)
const { NeuralPress } = require("neuralpress");
// Initialize using your news ingestion API key
const client = new NeuralPress("YOUR_DEVELOPER_API_KEY");
client
.getNews({ limit: 5 })
.then((articles) => console.log("News Articles:", articles))
.catch((error) => console.error("Request Error:", error.message));API Reference & Request Options
The client class provides methods designed for querying curated content feeds.
client.getNews(options)
Retrieve a list of aggregated news articles based on filters.
options.limit(number, optional): Max count of news items returned.- Free tier: Capped at maximum of 3.
- Business/Advanced tiers: Defaults to 20, maximum 100.
options.skip(number, optional): Offset index for pagination support.options.category(string, optional): Filter by topic tag (e.g.,'Sri Lanka','Business','Technology').options.fields(string, optional): Comma-separated list of response fields to retrieve (e.g.'title,slug,publishDate') to minimize payload bandwidth.
client.searchNews(query, options)
Fuzzy text search query matching indexed articles and semantic clusters.
query(string, required): Keywords or natural search queries.options.limit(number, optional): Limit search response item counts.- Free tier: Capped at maximum of 3.
Subscription Plans & API Quotas
NeuralPress API capabilities dynamically shift based on your active license key:
| Plan Tier | Daily API Quota | Rate Limit (RPM) | Max Items / Req | Unlocked Premium Features | | :--- | :--- | :--- | :--- | :--- | | Free | 100 requests / day | 5 requests / min | 3 items | Global news, keyword tags | | Business | 3,300 requests / day | 300 requests / min | 100 items | Sinhala translation, AI summaries, webhook | | Advanced | 1,000,000 requests / day | Unlimited | 100 items | Vector coordinates, custom endpoints |
If rate or quota limits are exceeded, the SDK throws a typed API exception: NeuralPress: API rate limit exceeded... or NeuralPress: Daily API request limit exceeded....
Sample JSON Response Schemas
Free Tier Payload Sample
For Free plan developers, translations, SEO metadata, and AI concept vectors are locked, and original reference content is truncated.
{
"id": "e42998a4-ea67-4e6f-99e2-d7b6b19a2e6f",
"title": "Local Tech Summit Announced in Colombo",
"slug": "local-tech-summit-announced-in-colombo",
"source": "NeuralPress",
"content": "The annual national technology summit has been scheduled to take place at the Colombo Exhibition Hall...",
"publishDate": "2026-06-11T04:30:00.000Z",
"categories": ["Sri Lanka", "Technology"],
"keywords": ["Colombo", "Tech Summit", "Events"],
"imageUrl": null,
"sinhalaTitle": "[LOCKED - Upgrade to Business Plan to read Sinhala translations]",
"sinhalaSummary": "[LOCKED - Upgrade to Business Plan to read Sinhala summaries]",
"summary": "[LOCKED - Upgrade to Business Plan to unlock synthesized summaries]",
"seo": "[LOCKED - Upgrade to Business Plan to unlock SEO Metadata]",
"aiConcepts": null,
"references": {
"primary": [
{
"title": "Colombo Tech Expo Details",
"url": "https://example.com/expo-details",
"content": "Colombo will host the annual tech event. Key speakers include global tech leaders...",
"engine": "NeuralPress Search"
}
],
"others": [
{
"title": "Summit Announcements",
"url": "https://example.com/summit-news",
"content": "Dates are confirmed for Colombo's premium tech show starting July...",
"engine": "NeuralPress Search"
}
]
}
}Business Tier Payload Sample (AI-Synthesized)
For Business and Advanced plan developers, translations, summaries, and SEO tags are fully populated, references include full content, and AI concepts are unlocked.
{
"id": "e42998a4-ea67-4e6f-99e2-d7b6b19a2e6f",
"title": "Local Tech Summit Announced in Colombo",
"slug": "local-tech-summit-announced-in-colombo",
"source": "NeuralPress",
"content": "The annual national technology summit has been scheduled to take place at the Colombo Exhibition Hall...",
"publishDate": "2026-06-11T04:30:00.000Z",
"categories": ["Sri Lanka", "Technology"],
"keywords": ["Colombo", "Tech Summit", "Events"],
"imageUrl": "https://images.neuralpress.site/og-images/summit-og.png",
"sinhalaTitle": "කොළඹ තාක්ෂණික සමුළුව නිල වශයෙන් ප්රකාශයට පත් කෙරේ",
"sinhalaSummary": "කොළඹදී පැවැත්වීමට නියමිත වාර්ෂික තාක්ෂණික ප්රදර්ශනයේ සහ සමුළුවේ කාලසටහන් නිකුත් කෙරේ.",
"summary": "The annual national Colombo Technology Summit schedule has been officially declared for July, highlighting key global tech expert panels.",
"seo": "{\"title\": \"Colombo Tech Summit 2026 Schedule declared\", \"description\": \"Annual technology conference in Colombo schedule details and speakers list details.\"}",
"aiConcepts": [
{
"concept": "Technology Conferences",
"relevance": 0.94,
"vectors": "[LOCKED - Upgrade to Advanced Plan to retrieve vector coordinates]"
}
],
"references": {
"primary": [
{
"title": "Colombo Tech Expo Details",
"url": "https://example.com/expo-details",
"content": "Colombo will host the annual tech event. Key speakers include global tech leaders, organizers, and tech associations with live hands-on exhibitions.",
"engine": "NeuralPress Search"
}
],
"others": [
{
"title": "Summit Announcements",
"url": "https://example.com/summit-news",
"content": "Dates are confirmed for Colombo's premium tech show starting July. Registration portals are open starting this week.",
"engine": "NeuralPress Search"
}
]
}
}Security, Best Practices & Troubleshooting
To ensure smooth operation and credentials safety, note the following developer best practices:
1. Browser Context Restrictions (credential protection)
By default, initializing the client in browser-like environments throws an error to prevent leaking secret developer API keys:
NeuralPress: Running this SDK in browser contexts is blocked to prevent public exposure of your secret API Key.
If you must run the client inside client-side or static mockups, bypass this check via config options:
const client = new NeuralPress({
apiKey: "YOUR_DEVELOPER_API_KEY",
dangerouslyAllowBrowser: true
});2. Error Message Masking
The SDK automatically sanitizes and redacts the apiKey and paths in error logs to avoid accidental exposures in your production logging systems (e.g. Datadog, Sentry).
3. Connection Enforcements
Connecting to custom baseUrl targets using raw unencrypted HTTP (excluding localhost / 127.0.0.1) triggers a console warning reminder:
NeuralPress Security Warning: You are using an unencrypted HTTP baseUrl for a remote server connection.
Always configure https endpoints for remote services in production environments.
