Neutrino API Fundamentals

Neutrino API is a "RESTful" style API and will accept request parameters as either HTTP GET or HTTP POST.

When sending API requests as HTTP POST we accept the following content types:

• application/x-www-form-urlencoded
• application/json
• multipart/form-data

Authentication

All API requests must be authenticated using an API key and your user ID.
The following authentication parameters can be sent with POST, GET or as HTTP headers:

Parameter	Description
user-id	Your user ID, this is the static ID for your account and cannot be changed.
api-key	One of your API keys, generate keys from your account. If authenticating using HTTP headers this value may also combine your user ID using the following header format: "API-Key: your-user-id:your-api-key"

Structured Responses

Most APIs will return structured data, you can set these optional output parameters:

Parameter	Description
output-format	Which data format the API should respond with, can be either: JSON (default) XML
output-case	The case style to respond with: kebab (default) camel snake

Binary Responses

Some APIs can return binary and text based file formats, such as: PNG, PDF, HTML, SVG.
For these APIs the HTTP 'Content-Type' header will be set with the appropriate MIME type.