Skip to main content

API Reference

The Nile API is based on REST. The API has predictable resource-oriented URLs, accepts and returns JSON-encoded responses, uses standard HTTP response codes, authentication, and verbs.

An authentication token for the API can be obtained by making a request to /auth/login. The response will contain a token field, which should be used for subsequent requests.

If you are new to Nile, check out the quick start guide.

REST API

Documentation

Client Libraries

In addition to the API, we currently support the following client libraries:

Javascript

In addition to the Javascript client, we also provide a set of React components to make getting started with development easier.