Skip to main content
GET
Get a factory blueprint by ID
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/factories/getBlueprint?id= returns one blueprint from the deployment’s catalog as a FactoryBlueprint. A missing, malformed, or unknown ID is 404 resource_missing with the message Blueprint not found. Your role grants must hold factories:read at the deployment root; holding it only below the root is refused with 403 and requiredPermission: "factories:read", before the ID is looked up. Factory configuration, manager prompt text, the creator, a channel’s external link, and repository settings are not returned.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

blueprintId
string
required

Response

Factory blueprint

data
object
required

A factory blueprint from the deployment's catalog: its factory type, version, status, default team, extra channels and budget defaults. Absent optional values are null or an empty list. Factory configuration, manager prompt text, the creator, a channel's external link and repository settings are not returned.

meta
object
required