Skip to main content
Version: 1.0.0

Numeno Admin API

Introduction​

Use the Numeno Administration API to create API Keys and set their permissions (which we call Scopes). This API is meant to be used by administrators of your organization.

Scopes​

Scopes are used to let API Keys access only certain parts of the API.

Scopes are expressed as a string of the form api:resource:action.

For example, from the Numeno Article Recommender API (art-rec):

  • art-rec:feeds:read - can read any Feed (eg. GET /feeds, /feeds/:id, /feeds/:id/streams, etc.)
  • art-rec:feeds:write - can write (and read) any Feed
  • art-rec:feeds:* - can perform any action on Feeds
  • art-rec:*:read - can read any resource on art-rec
  • *:*:* - can do everything

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 -H 'X-Numeno-Key: YOUR_API_KEY' \
     https://api.numeno.ai/admin/v1/keys

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