Skip to main content
GET
Requires version 1.1.9 or later of the Archetype platform.

Overview

This endpoint returns one blueprint, addressed either by its immutable blp_ id or by its key. Unlike the list endpoint, the response carries the full blueprint document, and optionally its YAML rendering.

Request

string
required
Blueprint blp_ id or key (e.g. osm).
boolean
Controls the yaml_document in the response. Omitted: include the stored YAML if one exists. true: always include, generating it from the document when none is stored. false: never include.

Response

string
required
TypeID-encoded blueprint identifier (blp_ prefix).
string
required
Human-readable key for the blueprint, e.g. osm.
string
required
Name of the blueprint.
string
required
Description of the blueprint.
object
required
The blueprint document, in the agent_core shape — the same format accepted on create, now carrying the assigned blueprint_id.
string
The YAML rendering of the blueprint, when included. Present when one was stored (or requested via ?yaml=true); omitted otherwise. See the yaml query parameter.
boolean
required
True for platform-authored (gallery) blueprints shared with every org; false for blueprints owned by a specific org.
boolean
required
True for the current version of a key; false once it has been replaced by a newer blueprint (its key was archived to <key>-<date>). Bundles/agents pinned to an inactive blueprint keep working — the console can badge them.
string
required
Creation timestamp (date-time).

Blueprint document fields

object
required
The blueprint’s edges: {"edges": [{"from": "<node id>", "to": "<node id>"}]}.
string
The assigned blueprint id, echoed inside the document.
object
Id-keyed map of source/sink nodes. Each entry is {"key": "<node key>", "config": {...}}.
object
Id-keyed map of every non-connector node, in the same entry shape as connectors.
string
The blueprint’s own name.
string
The blueprint’s own description.
object
The blueprint’s default values.
object
The blueprint’s models.
object
Map of artifact name to artifact reference (string values).

Important Notes

  • reference accepts either a blp_ id or a blueprint key, so the same URL shape works for both.
  • Ask for ?yaml=true when you want YAML even for a blueprint that was created from JSON — the service renders it from the document.
  • A blueprint with is_active: false has been replaced by a newer version of its key; it remains readable by id.