Get product setup readiness

GET

/v1/products/:id/setup

GET

/v1/products/:id/setup

$ curl https://api.runtype.com/v1/products/id/setup \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "pendingCount": 2,
3   "productId": "prod_12345",
4   "productName": "SmartHome Hub",
5   "state": "needs_setup",
6   "steps": [
7     {
8       "fulfillment": {
9         "args": {
10           "secretName": "API_KEY",
11           "value": "sk_live_abc123xyz"
12         },
13         "pendingArgs": {},
14         "rung": "mcp_tool",
15         "summary": "API key configured successfully.",
16         "tool": "secret_manager"
17       },
18       "id": "step_secret_api_key",
19       "kind": "secret",
20       "required": true,
21       "status": "pending",
22       "title": "Configure API Key",
23       "alternatives": [
24         {
25           "args": {
26             "secretName": "API_KEY",
27             "description": "Your API key for external integrations"
28           },
29           "pendingArgs": {
30             "API_KEY": "missing"
31           },
32           "rung": "mcp_tool",
33           "summary": "Add your API key to enable external integrations.",
34           "tool": "secret_manager"
35         }
36       ],
37       "docsUrl": "https://docs.runtype.com/products/secrets#api-key",
38       "helpText": "You need to provide your API key to connect with third-party services.",
39       "secretKey": "API_KEY",
40       "surfaceId": "surface_webapp",
41       "surfaceType": "webapp"
42     }
43   ],
44   "surfaces": [
45     {
46       "name": "Web Application",
47       "pendingCount": 1,
48       "state": "needs_setup",
49       "steps": [
50         {
51           "fulfillment": {
52             "args": {
53               "installUrl": "https://dashboard.runtype.com/install/webapp"
54             },
55             "pendingArgs": {},
56             "rung": "mcp_tool",
57             "summary": "Runtype SDK installed in web application.",
58             "tool": "sdk_installer"
59           },
60           "id": "step_install_sdk_webapp",
61           "kind": "surface_install",
62           "required": true,
63           "status": "pending",
64           "title": "Install SDK",
65           "alternatives": [
66             {
67               "args": {
68                 "installUrl": "https://dashboard.runtype.com/install/webapp"
69               },
70               "pendingArgs": {
71                 "installUrl": "not_visited"
72               },
73               "rung": "mcp_tool",
74               "summary": "Install the Runtype SDK into your web application.",
75               "tool": "sdk_installer"
76             }
77           ],
78           "docsUrl": "https://docs.runtype.com/sdk/webapp-install",
79           "helpText": "Follow the installation guide to embed the SDK in your app.",
80           "secretKey": "",
81           "surfaceId": "surface_webapp",
82           "surfaceType": "webapp"
83         }
84       ],
85       "surfaceId": "surface_webapp",
86       "surfaceType": "webapp"
87     }
88   ],
89   "handoff": {
90     "reason": "User must complete browser-based OAuth to authorize API access.",
91     "rung": "browser",
92     "summary": "Complete OAuth authorization in your browser to enable product features.",
93     "url": "https://app.runtype.com/oauth/authorize?product=prod_12345"
94   }
95 }

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

stepslist of objects

surfaceslist of objects

handoffobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error