Basic API Usage

Basic information about forming Knewton API requests

In this section:


Knewton API Environments and Hostnames

Integration / Sandbox environment

Your testing environments should be configured to send Knewton API requests to dev-api.knewton.com.

Production environments

When your application is ready for real users, your production environments should be configured to send Knewton API requests to the appropriate hostname below, based on your region.

  • api.knewton.ie: Europe, Middle East, Africa (EMEA)
  • api.knewton.com: All other partners

knAtom Talk to your Knewton representative for more information about GDPR compliance.

The Version Path Prefix

All of the endpoint paths described in the pages of this API Reference are relative to <hostname>/<version>/, using the <hostname>s described in Knewton API Environments and Hostnames.

Example: POST https://api.knewton.com/v0/accounts

The current version of the platform is v0.

See API Versioning for more information about API version management.

Request and Response Content-Types

Currently application/json is the only supported content type. The response’s Content-Type header will be set to the same type as the request, and all response bodies are returned as JSON.

Additionally, the Knewton API supports content IDs containing unicode characters that are submitted in the UTF-8 encoding. When providing content IDs containing UTF-8 encoded strings the Content-Type header should be set to application/json;charset=UTF-8, and the request library serializing the request should be configured to match this encoding.