> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Get surface setup readiness

GET https://api.runtype.com/v1/products/{id}/surfaces/{surfaceId}/setup

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.

Reference: https://docs.runtype.com/api-reference/runtype-api/products/get-surface-setup-readiness

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)
- `surfaceId` (string, required)

## Response

### 200

Surface setup readiness

- `name` (string, required)
- `pendingCount` (integer, required)
- `state` (enum, required)
  - Allowed values: `ready`, `needs_setup`
- `steps` (list of V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItems, required)
- `surfaceId` (string, required)
- `surfaceType` (string, required)

## Errors

### 400 Bad Request Error

Invalid product ID

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Product or surface not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItems

- `fulfillment` (V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment, required)
- `id` (string, required)
- `kind` (enum, required)
  - Allowed values: `secret`, `surface_install`
- `required` (boolean, required)
- `status` (enum, required)
  - Allowed values: `satisfied`, `pending`
- `title` (string, required)
- `alternatives` (list of V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems, optional)
- `docsUrl` (string, optional)
- `helpText` (string, optional)
- `secretKey` (string, optional)
- `surfaceId` (string, optional)
- `surfaceType` (string, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment

- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment0
- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment1
- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment2
- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment3

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems

- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems0
- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems1
- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems2
- V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems3

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment0

- `args` (map from string to any, required)
- `rung` (enum, required)
  - Allowed values: `mcp_tool`
- `summary` (string, required)
- `tool` (string, required)
- `pendingArgs` (map from string to string, optional)

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment1

- `endpoint` (string, required)
- `method` (enum, required)
  - Allowed values: `PATCH`, `POST`, `PUT`
- `rung` (enum, required)
  - Allowed values: `rest`
- `summary` (string, required)

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment2

- `reason` (string, required)
- `rung` (enum, required)
  - Allowed values: `browser`
- `summary` (string, required)
- `url` (string, required)

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsFulfillment3

- `rung` (enum, required)
  - Allowed values: `satisfied`

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems0

- `args` (map from string to any, required)
- `rung` (enum, required)
  - Allowed values: `mcp_tool`
- `summary` (string, required)
- `tool` (string, required)
- `pendingArgs` (map from string to string, optional)

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems1

- `endpoint` (string, required)
- `method` (enum, required)
  - Allowed values: `PATCH`, `POST`, `PUT`
- `rung` (enum, required)
  - Allowed values: `rest`
- `summary` (string, required)

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems2

- `reason` (string, required)
- `rung` (enum, required)
  - Allowed values: `browser`
- `summary` (string, required)
- `url` (string, required)

### V1ProductsIdSurfacesSurfaceIdSetupGetResponsesContentApplicationJsonSchemaStepsItemsAlternativesItems3

- `rung` (enum, required)
  - Allowed values: `satisfied`

## Examples

**Response**

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

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/products/id/surfaces/surfaceId/setup")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```