> ## Documentation Index
> Fetch the complete documentation index at: https://docs.archetypeai.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Start with /introduction/getting-started. Use the Direct Query API (POST /query) with the Newton Fusion model (text, image, and video reasoning) or the Newton Omega encoder (time-series embeddings). ATAI_API_ENDPOINT must include the version path: /v0.5 for most APIs, /v0.6 for the Fine-Tuning Service. Pages whose descriptions are marked (Archived) document the legacy Lens runtime — do not use them for new projects.

# List Blueprints

> Page through the blueprint catalog

<Callout icon="clock" color="#3064E3" iconType="solid">
  Requires [version 1.1.9](/release-notes/1.1.x#v1-1-9) or later of the Archetype platform.
</Callout>

## 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

<ParamField query="limit" type="integer" default="100">
  Page size. Minimum `1`, maximum `1000`.
</ParamField>

<ParamField query="after" type="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`.
</ParamField>

<ParamField query="before" type="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`.
</ParamField>

<ParamField query="key" type="string">
  Filter to a single key.
</ParamField>

## Response

<ResponseField name="data" type="array" required>
  The page, newest first. Each entry is a blueprint summary.
</ResponseField>

<ResponseField name="has_more" type="boolean" required>
  True when more results exist beyond this page in the direction of travel.
</ResponseField>

<ResponseField name="next_cursor" type="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.
</ResponseField>

### Blueprint summary object

<ResponseField name="id" type="string" required>
  TypeID-encoded blueprint identifier (`blp_` prefix).
</ResponseField>

<ResponseField name="blueprint_key" type="string" required>
  Human-readable key for the blueprint, e.g. `osm`.
</ResponseField>

<ResponseField name="name" type="string" required>
  Name of the blueprint.
</ResponseField>

<ResponseField name="description" type="string" required>
  Description of the blueprint.
</ResponseField>

<ResponseField name="is_canonical" type="boolean" required>
  True for platform-authored (gallery) blueprints shared with every org; false for blueprints owned by a specific org.
</ResponseField>

<ResponseField name="is_active" type="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>`).
</ResponseField>

<ResponseField name="created_at" type="string" required>
  Creation timestamp (date-time).
</ResponseField>

<RequestExample>
  ```bash cURL - First Page theme={"system"}
  curl "$ATAI_API_URL/agents/blueprints?limit=20" \
    -H "Authorization: Bearer $ATAI_API_KEY"
  ```

  ```bash cURL - Filter By Key theme={"system"}
  curl "$ATAI_API_URL/agents/blueprints?key=osm" \
    -H "Authorization: Bearer $ATAI_API_KEY"
  ```

  ```python Python theme={"system"}
  import os
  import requests

  base_url = os.environ["ATAI_API_URL"]
  api_key = os.environ["ATAI_API_KEY"]
  headers = {"Authorization": f"Bearer {api_key}"}

  cursor = None
  while True:
      params = {"limit": 100}
      if cursor:
          params["after"] = cursor

      response = requests.get(f"{base_url}/agents/blueprints", headers=headers, params=params)
      page = response.json()

      for blueprint in page["data"]:
          print(f"{blueprint['blueprint_key']}: {blueprint['name']} ({blueprint['id']})")

      if not page["has_more"]:
          break
      cursor = page["next_cursor"]
  ```

  ```javascript JavaScript theme={"system"}
  const response = await fetch(
    `${process.env.ATAI_API_URL}/agents/blueprints?limit=20`,
    {
      headers: {
        'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
      }
    }
  );

  const page = await response.json();

  page.data.forEach(blueprint => {
    console.log(`${blueprint.blueprint_key}: ${blueprint.name} (${blueprint.id})`);
  });

  if (page.has_more) {
    console.log(`Next cursor: ${page.next_cursor}`);
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - Success theme={"system"}
  {
    "data": [
      {
        "id": "blp_01jc9n7k3xf8mbq2v5t0ary6de",
        "blueprint_key": "osm",
        "name": "Open-set monitor",
        "description": "Classifies incoming records against a known class vocabulary.",
        "is_canonical": true,
        "is_active": true,
        "created_at": "2026-08-11T14:32:07Z"
      },
      {
        "id": "blp_01jc8k2m9vr4te7hn5b3qdzx8w",
        "blueprint_key": "osm-2026-07-02",
        "name": "Open-set monitor",
        "description": "Classifies incoming records against a known class vocabulary.",
        "is_canonical": true,
        "is_active": false,
        "created_at": "2026-07-02T09:15:44Z"
      }
    ],
    "has_more": true,
    "next_cursor": "blp_01jc8k2m9vr4te7hn5b3qdzx8w"
  }
  ```

  ```json 200 - Empty page theme={"system"}
  {
    "data": [],
    "has_more": false,
    "next_cursor": null
  }
  ```
</ResponseExample>

## Important Notes

<Note>
  * `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>`.
</Note>