Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iblueprint.ai/llms.txt

Use this file to discover all available pages before exploring further.

iBlueprint’s API is built on tRPC, a type-safe RPC framework that runs over standard HTTP. Every procedure you call is a typed endpoint — no separate OpenAPI spec to drift out of date. This reference covers the HTTP-level conventions you need to call the API from any language or tool, including curl.

​
Base URL

https://api.iblueprint.ai/api/trpc
All endpoints are relative to this base URL.

​
Procedure types

tRPC has two procedure types that map to different HTTP verbs:
Procedure typeHTTP methodWhen to use
queryGETRead data (list, get, status)
mutationPOSTWrite or trigger actions (create, execute, fire)

​
Calling a query

Pass input as a URL-encoded JSON string in the input query parameter. The value must be a JSON object with a json key: 
GET /api/trpc/{router}.{procedure}?input={"json":{...your input...}}

​
Calling a mutation

Send a POST request with a JSON body containing a json key: 
POST /api/trpc/{router}.{procedure}
Content-Type: application/json

{"json": {...your input...}}

​
Response envelope

Every response — success or error — is wrapped in a standard envelope: 
{
  "result": {
    "data": {
      "json": {
        // your actual response data
      }
    }
  }
}
Extract your payload from result.data.json.

​
Example: list your blueprints

curl -G "https://api.iblueprint.ai/api/trpc/blueprint.list" \
  --data-urlencode 'input={"json":{"page":1,"limit":5}}' \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Rate limiting

The API enforces rate limits per API key. If you exceed the limit, the server returns HTTP 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 statustRPC codeMeaning
400BAD_REQUESTInvalid input — check your parameters
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENValid key but insufficient permissions
404NOT_FOUNDResource does not exist
429—Rate limit exceeded
500INTERNAL_SERVER_ERRORSomething went wrong on our side
An error response looks like: 
{
  "error": {
    "json": {
      "message": "Blueprint not found",
      "code": -32004,
      "data": {
        "code": "NOT_FOUND",
        "httpStatus": 404
      }
    }
  }
}