Skip to main content
GET
Get a factory type 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/getType?id= returns one factory type from the deployment’s catalog as a FactoryType, looked up by its typeId: its manager template (role, skill keys, trust level and sandbox), worker role templates, default channels and required integrations. A missing or unknown id is 404 resource_missing with the message Factory type 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. The manager’s system prompt and every tools profile are configuration and are not returned. Absent optional values are null or an empty list.

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

typeId
string
required

The factory type's typeId.

Response

Factory type

data
object
required

A factory type from the deployment's catalog: its manager template, worker role templates, default channels and required integrations. Absent optional values are null or an empty list. The manager's system prompt and every tools profile are configuration and are not returned.

meta
object
required