Get surface setup readiness | Runtype Documentation

{
  "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"
}

Get the headless-first next steps to make a single surface live. Secret steps are product-scoped and therefore only appear on the product-level setup endpoint.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

surfaceIdstringRequired

Response

Surface setup readiness

namestring

pendingCountinteger>=0

stateenum

Allowed values:

stepslist of objects

surfaceIdstring

surfaceTypestring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error