Skip to main content
Version: 1.0.0

Numeno Article Recommender API

Introduction​

Use the Numeno Article Recommender API to receive a curated selection of articles from across the web.

See below for the steps to creating a Feed, as well as an introduction to the top-level concepts making up the Article Recommender API.

Steps to creating a Feed​

  1. Create a Feed - /feeds
  2. Pull from the Feed as the Feed refreshes - /feeds/:feedId/articles
  3. Use those Article IDs to look up metadata for the Articles -/articles/:id
  4. Visit the Article links and render to your server DB or client app.

Sources, Articles and Topics​

A Source is a place where Articles come from, typically a website, a blog, or a knowledgebase endpoint. Sources can be queried for activity via the /sources endpoint. Beyond the Sources Numeno regularly indexes, additional Sources can be associated with Feed queries, and Sources can be allowlist/denylist'd.

Articles are the documents produced by Sources, typically pages from a blogpost or website, articles from a news source, or posts from a social platform or company intranet. See the /articles endpoint.

Topics - Numeno has millions of Topics that it associates with Articles when they are sourced. Topics are used in Feed queries, which themselves are composed to create Feeds. Get topics via the /topics endpoint.

Feeds​

Feeds can be of different types:

  • query - a Feed that is generated by a search query and refreshes on a regular schedule. In addition, Query Feed have a "volume control knob" that allows you to control how many of the search results are included in the Feed. It's a collection of Topics that you're interested and a collection of Sources you'd explicitly like to include or exclude. No new Articles are published to a Feed except when it's refreshed. Query Feeds can be refreshed manually if the API Key Scopes allow.

  • mix - a Feed that is generated by a mix of ofther Feeds. Mix Feeds refresh as soon as one of their subfeed refreshes.

  • external - a Feed that is generated by an external source, such as an Agent from the Persona API. External Feeds refresh when new Articles are added to them.

You can ask for Feed Articles chronologically or by decreasing score. You can also limit Articles to a date-range, meaning that you can produce Feeds from historical content.

Interact with Feeds via the /feeds endpoint.

Authentication​

Each Numeno API call identifies each of your requests by your unique API Key, which can be found on the Numeno Dashboard or using the Numeno Administration API.

All endpoints expect the API Key to be passed as an HTTP header:

curl -s -X POST \
     -H 'X-Numeno-Key: YOUR_API_KEY' \
     -H 'Content-type: application/json' \
     -data '{“feedID”:”feedString”,“limit”:10}' \
     https://api.numeno.ai/art-rec/v1/feed/getPosts

Important: when calling any public Numeno API, you should always use the secure HTTPS endpoint to protect your credentials.

Security Scheme Type:

apiKey

Header parameter name:

X-Numeno-Key

Contact

API Support: support@numeno.ai

URL: https://numeno.ai/

Terms of Service

https://numeno.ai/terms/

License

Apache 2.0