Documentation

Welcome. These docs cover installing the project, configuring it, and building on its API. If you are new, start with the getting started guide. If you already know what you need, use the sections below or the search box.

Getting started

Install the project and make your first request in about five minutes.

Configuration

Environment variables, config files, and the options that matter.

API reference

Every endpoint, parameter, and response shape, with examples.

Troubleshooting

Common errors, what causes them, and how to fix them.

Quick start

Install the command line tool and check that it runs:

$ npm install -g project-cli
$ project --version
1.0.0

Then make a request to the API:

curl https://api.example.com/v1/status \
  -H "Authorization: Bearer YOUR_TOKEN"

Need more help?

Check the troubleshooting guide first. If your problem is not covered there, contact support and include the output of project doctor.