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

Overview

This endpoint returns the blueprint catalog as a cursor-paginated page of blueprint summaries, newest first. Summaries omit the full blueprint document — fetch a single blueprint with GET /agents/blueprints/{reference} when you need its document or yaml_document.

Request

integer
default:"100"
Page size. Minimum 1, maximum 1000.
string
Forward cursor: return blueprints older than the one with this id. Pass the next_cursor of the previous page (or the id of its last blueprint) to fetch the next page. Mutually exclusive with before.
string
Backward cursor: return blueprints newer than the one with this id. Pass the id of the first blueprint of the current page to walk back. Mutually exclusive with after.
string
Filter to a single key.

Response

array
required
The page, 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.

Blueprint summary object

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.
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>).
string
required
Creation timestamp (date-time).

Important Notes

  • after and before are mutually exclusive — send at most one of them.
  • Results are ordered newest first in both cursor directions, so render data as returned.
  • An archived (replaced) blueprint stays in the catalog with is_active: false and a key of the form <key>-<date>.