> 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 product definition (config-as-code)

GET https://api.runtype.com/v1/products/pull

Return the canonical config-as-code definition and provenance for a product by name — the absorb-drift direction of the ensure protocol. The contentHash is recomputed from the live product state, so it is accurate even immediately after a dashboard edit. Returns the top-level product record only (description, icon, spec); nested capabilities/surfaces and canvas layout are not included.

Reference: https://docs.runtype.com/api-reference/runtype-api/products/pull-product-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

### Query parameters

- `name` (string, required)

## Response

### 200

Canonical definition + provenance

- `contentHash` (string, required)
- `definition` (ProductPullResponseDefinition, required)
- `lastModifiedSource` (string, required, nullable)
- `productId` (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

No product with that name in the account scope

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

### ProductPullResponseDefinition

- `name` (string, required)
- `description` (string, optional, nullable)
- `icon` (string, optional, nullable)
- `spec` (ProductPullResponseDefinitionSpec, 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, …).

### ProductPullResponseDefinitionSpec

- `aiUseCases` (list of string, optional)
- `complianceNeeds` (list of string, optional)
- `dataSourceTypes` (list of string, optional)
- `deploymentTargets` (list of string, optional)
- `existingTools` (list of string, optional)
- `importedFrom` (ProductPullResponseDefinitionSpecImportedFrom, optional)
- `internalDocs` (ProductPullResponseDefinitionSpecInternalDocs, optional, nullable)
- `loggingPolicy` (enum, optional)
  - Allowed values: `default`, `on`, `off`
- `preferredModels` (list of string, optional)
- `productGoal` (string, optional)
- `productStage` (enum, optional)
  - Allowed values: `idea`, `prototype`, `beta`, `production`, `scaling`
- `stack` (ProductStack, optional) — The Overview's stack. The legacy techStack buckets are separate and unchanged.
- `targetAudience` (string, optional)
- `techStack` (ProductPullResponseDefinitionSpecTechStack, optional)

### ProductPullResponseDefinitionSpecImportedFrom

- `importedAt` (string, required)
- `source` (enum, required)
  - Allowed values: `github`, `linear`, `chatprd`, `manual`
- `sourceId` (string, optional)
- `syncEnabled` (boolean, optional)

### ProductPullResponseDefinitionSpecInternalDocs

- `content` (string, optional)
- `resources` (list of ProductPullResponseDefinitionSpecInternalDocsResourcesItems, optional)
- `tags` (list of string, optional)

### ProductStack

The Overview's stack. The legacy techStack buckets are separate and unchanged.

- `declared` (ProductStackDeclared, optional) — The last declaration from each source; a product save keeps it as stored
- `detected` (ProductStackDetected, optional) — What the last detection derived; a product save keeps it as stored
- `hidden` (list of string, optional) — Keys of detected or declared chips people hid; replaces the stored list
- `hiddenAt` (map from string to string, optional) — When each hidden key was hidden; set by the server
- `manual` (list of ProductStackItem, optional) — Chips people added by hand; replaces the stored list

### ProductPullResponseDefinitionSpecTechStack

- `backend` (list of string, optional)
- `database` (list of string, optional)
- `frontend` (list of string, optional)
- `infrastructure` (list of string, optional)
- `languages` (list of string, optional)

### ProductPullResponseDefinitionSpecInternalDocsResourcesItems

- `title` (string, required)
- `type` (string, required)
- `addedAt` (string, optional)
- `addedByUserId` (string, optional)
- `content` (string, optional)
- `source` (string, optional)
- `url` (string, optional)

### ProductStackDeclared

The last declaration from each source; a product save keeps it as stored

- `api` (ProductDeclaredStack, optional)
- `cli` (ProductDeclaredStack, optional)
- `mcp` (ProductDeclaredStack, optional)

### ProductStackDetected

What the last detection derived; a product save keeps it as stored

- `derivedAt` (string, required)
- `items` (list of ProductStackItem, required)

### ProductStackItem

- `key` (string, required) — Stable chip key, e.g. model:claude-sonnet-5 or custom:inngest
- `label` (string, required)
- `category` (string, optional)
- `mark` (string, optional) — Brand or provider mark id the dashboard draws
- `url` (string, optional)
- `version` (string, optional)
- `where` (string, optional) — Where a detected item was found

### ProductDeclaredStack

- `actorLabel` (string, required)
- `declaredAt` (string, required)
- `items` (list of ProductStackItem, required)
- `actorUserId` (string, optional)

## Examples

**Response**

```json
{
  "contentHash": "string",
  "definition": {
    "name": "string",
    "description": "string",
    "icon": "string",
    "spec": {
      "aiUseCases": [
        "string"
      ],
      "complianceNeeds": [
        "string"
      ],
      "dataSourceTypes": [
        "string"
      ],
      "deploymentTargets": [
        "string"
      ],
      "existingTools": [
        "string"
      ],
      "importedFrom": {
        "importedAt": "string",
        "source": "github",
        "sourceId": "string",
        "syncEnabled": true
      },
      "internalDocs": {
        "content": "string",
        "resources": [
          {
            "title": "string",
            "type": "string",
            "addedAt": "string",
            "addedByUserId": "string",
            "content": "string",
            "source": "string",
            "url": "string"
          }
        ],
        "tags": [
          "string"
        ]
      },
      "loggingPolicy": "default",
      "preferredModels": [
        "string"
      ],
      "productGoal": "string",
      "productStage": "idea",
      "stack": {
        "declared": {
          "api": {
            "actorLabel": "string",
            "declaredAt": "string",
            "items": [
              {
                "key": "string",
                "label": "string",
                "category": "string",
                "mark": "string",
                "url": "string",
                "version": "string",
                "where": "string"
              }
            ],
            "actorUserId": "string"
          },
          "cli": {
            "actorLabel": "string",
            "declaredAt": "string",
            "items": [
              {
                "key": "string",
                "label": "string",
                "category": "string",
                "mark": "string",
                "url": "string",
                "version": "string",
                "where": "string"
              }
            ],
            "actorUserId": "string"
          },
          "mcp": {
            "actorLabel": "string",
            "declaredAt": "string",
            "items": [
              {
                "key": "string",
                "label": "string",
                "category": "string",
                "mark": "string",
                "url": "string",
                "version": "string",
                "where": "string"
              }
            ],
            "actorUserId": "string"
          }
        },
        "detected": {
          "derivedAt": "string",
          "items": [
            {
              "key": "string",
              "label": "string",
              "category": "string",
              "mark": "string",
              "url": "string",
              "version": "string",
              "where": "string"
            }
          ]
        },
        "hidden": [
          "string"
        ],
        "hiddenAt": {},
        "manual": [
          {
            "key": "string",
            "label": "string",
            "category": "string",
            "mark": "string",
            "url": "string",
            "version": "string",
            "where": "string"
          }
        ]
      },
      "targetAudience": "string",
      "techStack": {
        "backend": [
          "string"
        ],
        "database": [
          "string"
        ],
        "frontend": [
          "string"
        ],
        "infrastructure": [
          "string"
        ],
        "languages": [
          "string"
        ]
      }
    }
  },
  "lastModifiedSource": "string",
  "productId": "string",
  "updatedAt": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/products/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/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/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/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/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/pull?name=name', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products/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/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()
```