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.

The blueprint.get procedure returns the full detail record for one blueprint. In addition to the core blueprint fields, the response includes computed access flags (is_owner, can_manage), linked categories and organizations, favoriting status, and rating aggregates. You can fetch blueprints you own, blueprints shared with you via a collaborator role, blueprints belonging to your organization, and any blueprint with visibility: public.

​
Request

Procedure type: query (HTTP GET) Endpoint: 
GET https://api.iblueprint.ai/api/trpc/blueprint.get

​
Parameters

​
input
object
required
A URL-encoded JSON object with a json key containing the parameter below.
​
json.id
string
required
UUID of the blueprint to retrieve.

​
Response

​
id
string
UUID of the blueprint.
​
title
string
Display name.
​
description
string
Short description.
​
status
string
draft or published.
​
visibility
string
private or public.
​
version
string
Semantic version string, e.g. 2.1.0.
​
tags
array
Array of tag strings.
​
created_by
string
UUID of the owning user.
​
organization_id
string
UUID of the owning organization.
​
created_at
string
ISO 8601 creation timestamp.
​
updated_at
string
ISO 8601 last-update timestamp.
​
environment_variables
array
Declared environment variables for the blueprint.
​
blueprint_map
object
Node graph definition containing nodes and flow edges.
​
average_rating
number
Average star rating (0–5).
​
rating_count
number
Total number of ratings.
​
user_rating
number
The authenticated user’s own rating, if any.
​
can_manage
boolean
true if the authenticated user can edit or delete this blueprint (owner, collaborator with editor/admin role, or org member).
​
is_owner
boolean
true if the authenticated user created this blueprint.
​
is_favorited
boolean
true if the authenticated user has favorited this blueprint.
​
categories
array
Array of category objects (id, name, slug) linked to this blueprint.
​
organizations
array
Array of organization objects (id, name, slug) this blueprint belongs to.

​
Examples

curl -G "https://api.iblueprint.ai/api/trpc/blueprint.get" \
  --data-urlencode 'input={"json":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}' \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Sample response

{
  "result": {
    "data": {
      "json": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "title": "Sentiment Analysis Pipeline",
        "description": "Reads customer reviews and classifies sentiment.",
        "status": "published",
        "visibility": "private",
        "version": "1.0.0",
        "tags": ["nlp", "sentiment"],
        "created_by": "user-uuid",
        "organization_id": "org-uuid",
        "created_at": "2024-10-01T08:00:00Z",
        "updated_at": "2024-10-20T16:45:00Z",
        "environment_variables": [],
        "blueprint_map": {
          "nodes": [...]
        },
        "average_rating": 4.8,
        "rating_count": 5,
        "user_rating": 5,
        "can_manage": true,
        "is_owner": true,
        "is_favorited": false,
        "categories": [
          { "id": "cat-uuid", "name": "AI & ML", "slug": "ai-ml" }
        ],
        "organizations": [
          { "id": "org-uuid", "name": "Acme Corp", "slug": "acme-corp" }
        ]
      }
    }
  }
}

​
Access rules

The API grants access to a blueprint if any of the following is true:
  • You are the blueprint’s creator (created_by matches your user ID).
  • You are listed as a collaborator with the editor or admin role.
  • Your organization owns the blueprint.
  • The blueprint has visibility: public.
If none of these conditions apply, the API returns HTTP 403 Forbidden.