Get surface setup readiness | Runtype Documentation

{
  "name": "Mobile App Surface",
  "pendingCount": 2,
  "state": "needs_setup",
  "steps": [
    {
      "fulfillment": {
        "args": {
          "apiKey": "abc123xyz789",
          "environment": "production"
        },
        "pendingArgs": {},
        "rung": "mcp_tool",
        "summary": "API key configured successfully",
        "tool": "api-key-manager"
      },
      "id": "step-001",
      "kind": "secret",
      "required": true,
      "status": "pending",
      "title": "Set up API Key",
      "alternatives": [
        {
          "args": {
            "apiKey": "abc123xyz789",
            "environment": "production"
          },
          "pendingArgs": {
            "apiKey": "required"
          },
          "rung": "mcp_tool",
          "summary": "Configure API key for authentication",
          "tool": "api-key-manager"
        },
        {
          "endpoint": "/v1/products/12345/surfaces/mobile/setup",
          "method": "POST",
          "rung": "rest",
          "summary": "Submit mobile surface configuration"
        }
      ],
      "docsUrl": "https://docs.runtype.com/setup/mobile-surface",
      "helpText": "You need to provide a valid API key to enable this surface.",
      "secretKey": "mobile_api_key",
      "surfaceId": "mobile",
      "surfaceType": "app"
    }
  ],
  "surfaceId": "mobile",
  "surfaceType": "app"
}

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

stepslist of objects

surfaceIdstring

surfaceTypestring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

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