This page will help you get started with Braid Technologies API.
About our APIs:
Braid APIs are REST-based and return responses in JSON format.
HTTP request methods such as GET, PUT, and POST are utilized as well as standard status codes for successful and unsuccessful requests.
All requests are sent via HTTP to unique URL endpoints.
Authentication:
Requests require the bearer authentication or token authentication scheme.
A bearer token is a single string that authenticates an API request.
Please provide your bearer token in the Authorization header when making requests.
Bearer Auth
| Security Scheme Type | HTTP |
|---|---|
| HTTP Authorization Scheme | Bearer |
Example: Authorization: Bearer 123
Status and Error Codes:
The colored symbols below in green represent the good (OK) status codes and in red for the bad (Error) status codes.
| HTTP Status Code | Reason | Detailed Explanations |
|---|---|---|
| ✅ 200 | OK | This is the standard response for successful HTTP requests. The actual response will depend on the request method used. This will apply to GET, PATCH, DELETE, and PUT requests. |
| ✅ 201 | OK | This is the standard response for successful HTTP requests. The actual response will depend on the request method used. In a POST request, the response will contain an entity describing or containing the result of the action. This code will only apply to POST requests. |
| ✅ 204 | OK | This is if there is no response for a successful request. |
| 🛑 401 | Unauthorized | The request requires user authentication. Invalid credentials were provided, the token has expired, or the user doesn’t have permission to perform the requested operation. |
| 🛑 403 | Forbidden | The server understood the request, but is refusing to fulfill it. Authorization doesn’t help here. |
| 🛑 404 | Not Found | The server has not found anything matching the requested URI (Endpoint). This could be a wrong URL or the resource doesn’t exist. |