Get product setup readiness | Runtype Documentation

{
  "pendingCount": 1,
  "productId": "string",
  "productName": "string",
  "state": "ready",
  "steps": [
    {
      "fulfillment": {
        "args": {},
        "pendingArgs": {},
        "rung": "mcp_tool",
        "summary": "string",
        "tool": "string"
      },
      "id": "string",
      "kind": "secret",
      "required": true,
      "status": "satisfied",
      "title": "string",
      "alternatives": [
        {
          "args": {},
          "pendingArgs": {},
          "rung": "mcp_tool",
          "summary": "string",
          "tool": "string"
        }
      ],
      "docsUrl": "string",
      "helpText": "string",
      "secretKey": "string",
      "surfaceId": "string",
      "surfaceType": "string"
    }
  ],
  "surfaces": [
    {
      "name": "string",
      "pendingCount": 1,
      "state": "ready",
      "steps": [
        {
          "fulfillment": {
            "args": {},
            "pendingArgs": {},
            "rung": "mcp_tool",
            "summary": "string",
            "tool": "string"
          },
          "id": "string",
          "kind": "secret",
          "required": true,
          "status": "satisfied",
          "title": "string",
          "alternatives": [
            {
              "args": {},
              "pendingArgs": {},
              "rung": "mcp_tool",
              "summary": "string",
              "tool": "string"
            }
          ],
          "docsUrl": "string",
          "helpText": "string",
          "secretKey": "string",
          "surfaceId": "string",
          "surfaceType": "string"
        }
      ],
      "surfaceId": "string",
      "surfaceType": "string"
    }
  ],
  "handoff": {
    "reason": "string",
    "rung": "browser",
    "summary": "string",
    "url": "string"
  }
}

Get structured, headless-first next steps to make a product live: pending secrets plus every surface’s install steps, folded into a product-level readiness result. A sibling of the secrets-only configuration endpoint.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Response

Product setup readiness

pendingCountinteger>=0

productIdstring

productNamestring

stateenum

Allowed values:

stepslist of objects

surfaceslist of objects

handoffobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error