Welcome to the relayr API reference! The relayr API provides complete programmatic access to every entity on the relayr platform. Below are instructions on how the relayr API works and links to documentation for each of the API entities.
relayr API calls can be made over HTTPS (calls made with just HTTP are not accepted). Our API documentation includes sample calls using cURL, but we also recommend using a program such as Postman, which is designed specifically for testing API calls.
In order to use the API, you will need to have registered for the Developer Dashboard. Once you have done so, you will need two pieces of information: your user ID and your authorization token. You can find both of these under the Account section of the Developer Dashboard, as shown below:
Your authorization token, which consists of “Bearer” followed by a
token string, must be supplied as the
Authorization header for every
API request. For example:
Authorization: Bearer K.OwjFjwQdm-67kc2AInfHngnB.tzXwh
The relayr API returns JSON objects for requests to access or modify resources in the cloud. For all entities except device-models and prototypes, supply the following header:
For device-models and prototypes, provide this instead:
We use standard HTTP status codes in our API responses, which include the following:
content-typeheader - check to see if the proper value is
application/json, for example;
The Cloud includes the following core endpoints:
The relayr services include the following endpoints:
relayr Vertex uses the following endpoints: