Getting Started
Go from API specification to generated client library in minutes. Follow these steps to define, document, and generate code for your first service.
1 Create Your Organization
After logging in, create an organization. This is the container for all of your services and generated code.
2 Create Your First Service
A service represents a full REST API described in a single file. By convention, name it api.json and store it in your
project root.
Quickest path: download the API Builder API spec as a starting point, then edit it for your application.
Click "Add Application" from your organization page to upload your spec. See the api.json reference for full format details.
3 View Your Documentation
API Builder generates interactive documentation automatically. Use the latest version URL to always
link to the most current version of your service.
4 Download a Client Library
Navigate to your service and look for the "Clients" section. Each client is a standalone, single-file download — ready to drop into your project or publish as an artifact. See the full list of available generators.
5 Configure Your Organization
Go to "Org Details" in the left nav to set package names for generated clients and optionally make your organization public for service discovery.
6 Use the CLI
The apibuilder-cli lets you upload new versions and download generated code directly into your source tree — no browser required.
✦ Get Involved
- Follow API Builder on GitHub
- Join the conversation on Slack at #apicollective
- Report bugs or request features
- Contribute api.json specs for common services and share them as public APIs
Need an API token for programmatic access?
API Tokens