> 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.

# Pull surface definition (config-as-code)

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

Return the canonical config-as-code definition and provenance for a surface by name within a product — the absorb-drift direction of the ensure protocol. The contentHash is recomputed from the live surface state, so it is accurate even immediately after a dashboard edit. Configured inbound/outbound credentials are returned as the "\<redacted>" placeholder, which ensure accepts to keep the stored value; inbound/outbound are null when the surface has none.

Reference: https://docs.runtype.com/api-reference/runtype-api/products/pull-surface-definition-config-as-code

## 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)

### Query parameters

- `name` (string, required)

## Response

### 200

Canonical definition + provenance

- `contentHash` (string, required)
- `definition` (SurfacePullResponseDefinition, required)
- `lastModifiedSource` (string, required, nullable)
- `surfaceId` (string, required)
- `updatedAt` (string, required, nullable)

## Errors

### 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.

### 403 Forbidden Error

Insufficient permissions

- `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 not found, or no surface with that name in the product

- `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

### SurfacePullResponseDefinition

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `chat`, `mcp`, `mcp_code`, `api`, `webhook`, `schedule`, `a2a`, `email`, `slack`, `sms`, `imessage`, `discord`, `whatsapp`, `telegram`, `hosted-page`, `chrome_extension`
- `behavior` (map from string to any, optional)
- `environment` (enum, optional)
  - Allowed values: `production`, `development`
- `inbound` (map from string to any, optional, nullable) — Inbound channel config. Omit to keep the stored value; null clears it. A credential value of "\<redacted>" (as returned by pull) keeps the stored credential.
- `outbound` (map from string to any, optional, nullable) — Outbound channel config. Omit to keep the stored value; null clears it. A credential value of "\<redacted>" (as returned by pull) keeps the stored credential.
- `status` (enum, optional)
  - Allowed values: `draft`, `active`, `paused`

### 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, …).

## Examples

**Response**

```json
{
  "contentHash": "string",
  "definition": {
    "name": "string",
    "type": "chat",
    "behavior": {},
    "environment": "production",
    "inbound": {},
    "outbound": {},
    "status": "draft"
  },
  "lastModifiedSource": "string",
  "surfaceId": "string",
  "updatedAt": "string"
}
```

**SDK Code**

```python
import requests

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

querystring = {"name":"name"}

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

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

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/products/id/surfaces/pull?name=name';
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/pull?name=name"

	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/pull?name=name")

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/pull?name=name")
  .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/pull?name=name', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products/id/surfaces/pull?name=name");
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/pull?name=name")! 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()
```