Assemble product from FPO | Runtype Documentation

curl -X POST https://api.runtype.com/v1/products/assemble \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "_meta": {
    "catalogVersion": "1.0.0",
    "generatedAt": "2026-06-01T00:00:00.000Z",
    "generatorVersion": "1.0.0",
    "planHash": "abc123",
    "schemaVersion": "2.0"
  },
  "capabilities": [
    {
      "agent": {
        "config": {
          "model": "claude-sonnet-4-5",
          "systemPrompt": "You are a helpful support agent."
        },
        "description": "A helpful customer support agent",
        "name": "Support Agent"
      },
      "description": "Handles customer support conversations",
      "id": "support-chat",
      "name": "Support Chat"
    }
  ],
  "product": {
    "description": "An AI-powered customer support product",
    "name": "My AI Product"
  },
  "surfaces": [
    {
      "config": {},
      "id": "support-widget",
      "name": "Support Widget",
      "routes": [
        {
          "capabilityId": "support-chat"
        }
      ],
      "type": "chat"
    }
  ],
  "tools": [],
  "version": "2.0"
}'

{
  "cached": true,
  "capabilities": [
    {
      "capabilityId": "string",
      "name": "string",
      "agentId": "string",
      "flowId": "string"
    }
  ],
  "creationMap": {},
  "productId": "string",
  "surfaces": [
    {
      "name": "string",
      "surfaceId": "string",
      "surfaceItemIds": [
        "string"
      ],
      "type": "string",
      "integrationId": "string"
    }
  ],
  "warnings": [
    "string"
  ]
}

Assemble a product from a validated Full Product Object (FPO). API keys must carry PRODUCTS:WRITE (or PRODUCTS:CREATE) and SECRETS:WRITE, plus the write scope for every entity kind the FPO materializes (FLOWS:WRITE, AGENTS:WRITE, PRODUCTS:SURFACES:WRITE, SCHEDULES:WRITE, RECORDS:WRITE, EVALS:WRITE, SKILLS:WRITE), and SECRETS:READ when an inline HTTP step references a managed secret.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects a map from strings to any.

Response

Assembled product result

cachedboolean

capabilitieslist of objects

creationMapmap from strings to strings

productIdstring

surfaceslist of objects

warningslist of stringsOptional

Non-fatal advisories, e.g. a remapped deprecated field or seed data skipped because an existing enforce collection outside the FPO refuses it.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error