Authentication Guide

The BUILD API uses Api Key and Api Secret to authenticate requests. You can view and manage your API keys in the BUILD Dashboard.

Your API keys and secrets carry many privileges, so be sure to keep them secure. Don't share them in publicly accessible areas such as GitHub, client-side code, and so forth.

You should use them to get access token by the /v1/auth endpoint. Extract the token from the response payload. You will need to submit your access token via the Authorization header with all subsequent API calls.

Your access token will be valid for a length of time (in seconds) indicated by the expired_in field in the response. When it expires, you'll need to request a new one.

A sample test access token is included in all the examples here, so you can test any example right away. Don't submit any personally identifiable information in requests with this token. To test requests using your account, replace the sample access token with your actual API key or sign in.