Base URL
Procedure types
tRPC has two procedure types that map to different HTTP verbs:| Procedure type | HTTP method | When to use |
|---|---|---|
query | GET | Read data (list, get, status) |
mutation | POST | Write or trigger actions (create, execute, fire) |
Calling a query
Pass input as a URL-encoded JSON string in theinput query parameter. The value must be a JSON object with a json key:
Calling a mutation
Send aPOST request with a JSON body containing a json key:
Response envelope
Every response — success or error — is wrapped in a standard envelope:result.data.json.
Example: list your blueprints
Rate limiting
The API enforces rate limits per API key. If you exceed the limit, the server returnsHTTP 429 Too Many Requests. Back off and retry after the period indicated in the Retry-After header.
Error codes
Errors use tRPC’s standard error shape. The HTTP status code reflects the error class:| HTTP status | tRPC code | Meaning |
|---|---|---|
400 | BAD_REQUEST | Invalid input — check your parameters |
401 | UNAUTHORIZED | Missing or invalid API key |
403 | FORBIDDEN | Valid key but insufficient permissions |
404 | NOT_FOUND | Resource does not exist |
429 | — | Rate limit exceeded |
500 | INTERNAL_SERVER_ERROR | Something went wrong on our side |
