REST API

Interact programmatically with your TofuPilot account using the SDKs or direct HTTP requests. For example, create test runs directly, list and filter units, get user data, and much more.

API basics

The API is exposed as an HTTP/1 and HTTP/2 service over SSL. All endpoints live under the URL https://www.tofupilot.app/api/v2 and follow the REST architecture.

Authentication

TofuPilot API keys are required to authenticate and use the TofuPilot API. Include the key in the Authorization header:

Authorization: Bearer <API_KEY>

Create and manage API keys in your account settings.

Filtering and pagination

List endpoints accept query parameters to narrow results. Filter, sort, and paginate by appending parameters to the URL:

https://www.tofupilot.app/api/v2/units?limit=50&serialNumber=SN-001

Refer to each endpoint's reference for the full list of supported filters.

Error codes

Errors are returned with a standard HTTP status code and a JSON body:

{
  "message": "Human-readable description of the error",
  "code": "NOT_FOUND"
}

Input validation failures return a BAD_REQUEST with the offending fields in issues:

{
  "message": "Input validation failed",
  "code": "BAD_REQUEST",
  "issues": [
    {
      "path": ["serialNumber"],
      "message": "Required"
    }
  ]
}

Refer to each endpoint's reference for the exact set of errors it can return.

Rate limits

The API limits the number of calls you can make over a period of time. Requests beyond the limit return 429 TOO_MANY_REQUESTS. Contact us if you need higher limits for production workloads.

Endpoints

Every endpoint is grouped by resource in the sidebar. The most frequently used ones are listed below.