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

Overview

This endpoint returns all versions of one blueprint key as a cursor-paginated page of blueprint summaries, newest first. Each time a key is re-pointed at a new version with replacement_of, the previous blueprint is archived under <key>-<its creation date> and flagged inactive. This endpoint walks that history: the current active version plus every archived one. reference accepts either the key itself or a blp_ id, which is resolved to its key first — so any version of a key is a valid way to ask for all of them.

Request

string
required
Blueprint key (e.g. osm) or a blp_ id (resolved to its key).
string
The prj_ id of the project to resolve a key in, as well as outside projects. Needed for a key registered in a project; ignored for a blp_ id. v2.0.0+
integer
default:"100"
Page size. Minimum 1, maximum 1000.
string
Forward cursor: return versions older than the one with this id. Pass the next_cursor of the previous page (or the id of its last version) to fetch the next page. Mutually exclusive with before.
string
Backward cursor: return versions newer than the one with this id. Pass the prev_cursor of the current page to walk back. Mutually exclusive with after.

Response

array
required
All versions of the key, newest first. Each entry is a blueprint summary.
boolean
required
True when more results exist beyond this page in the direction of travel.
string
Cursor for the next page in the same direction — pass it as after when paging forward, or as before when you supplied before. null when has_more is false.
string
Cursor to step back the way this page was reached — pass it as before after a forward page, or as after after a backward one. null when the request carried no cursor. v1.1.13+

Blueprint summary object

string
required
TypeID-encoded blueprint identifier (blp_ prefix).
string
required
Human-readable key for this version. The active version holds the bare key; an archived one holds <key>-<date>.
string
required
Display name of the blueprint, from the document.
string
required
Description of the blueprint, from the document. Empty when the document has none.
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.
string
The project the blueprint lives in, or null if the blueprint doesn’t live in any project. v2.0.0+
string
required
Creation timestamp (date-time).

Important Notes

  • A key registered in a project resolves only when project_id names that project. v2.0.0+
  • Passing a blp_ id resolves it to its key first, so asking about any one version returns the whole history of that key.
  • At most one version of a key is active at a time; the rest carry is_active: false and an archived key of the form <key>-<date>.
  • Summaries omit the full blueprint document — fetch a single version by id with GET /agents/blueprints/{reference}.
  • after and before are blueprint ids, and are mutually exclusive — send at most one of them. Passing both, or a malformed one, returns 400.