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

# Create product

POST https://api.runtype.com/v1/products
Content-Type: application/json

Create a new product with optional canvas and spec configuration.

Reference: https://docs.runtype.com/api-reference/runtype-api/products/create-product

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

### Body (application/json)

This endpoint expects an object.

- `name` (string, required)
- `canvas` (V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvas, optional)
- `description` (string, optional)
- `icon` (string, optional)
- `spec` (V1ProductsPostRequestBodyContentApplicationJsonSchemaSpec, optional)

## Response

### 201

Product created

- `canvas` (map from string to any, required)
- `capabilities` (list of any, required)
- `createdAt` (string, required)
- `description` (string, required, nullable)
- `icon` (string, required, nullable)
- `id` (string, required)
- `name` (string, required)
- `spec` (map from string to any, required)
- `surfaces` (list of any, required)
- `updatedAt` (string, required)
- `dashboardUrl` (string, optional)
- `testApiKey` (V1ProductsPostResponsesContentApplicationJsonSchemaTestApiKey, optional)

## Errors

### 400 Bad Request Error

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

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

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

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvas

- `architectureLayout` (map from string to V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasArchitectureLayout, optional)
- `blocks` (list of ProductCanvasBlock, optional) — Product Canvas blocks in page order. Entries merge with the stored ones by id; stored entries the request leaves out are kept after the sent ones. Saving the description or stack stamps the overview block, saving the linked docs stamps the docs block, and a changed config stamps its own block.
- `capabilityOrder` (list of string, optional)
- `capabilityPositions` (map from string to double, optional)
- `groups` (list of V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasGroupsItems, optional)
- `notes` (list of V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasNotesItems, optional)
- `onboardingProgress` (map from string to map from string to any, optional)
- `quickStartImport` (V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasQuickStartImport, optional)
- `surfaceOrder` (list of string, optional)
- `surfacePositions` (map from string to double, optional)
- `templateId` (string, optional)

### V1ProductsPostRequestBodyContentApplicationJsonSchemaSpec

- `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` (V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecImportedFrom, optional)
- `internalDocs` (V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecInternalDocs, optional, nullable)
- `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` (V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecTechStack, optional)

### V1ProductsPostResponsesContentApplicationJsonSchemaTestApiKey

- `canRevealLater` (boolean, required)
- `id` (string, required)
- `key` (string, required)
- `limits` (V1ProductsPostResponsesContentApplicationJsonSchemaTestApiKeyLimits, required)
- `name` (string, required)
- `prefix` (string, required)

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

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasArchitectureLayout

- `x` (double, required)
- `y` (double, required)

### ProductCanvasBlock

- `id` (string, required) — Stable block id; comment anchors read `block:<id>`
- `kind` (string, required) — Block kind, e.g. overview, get-started, docs, architecture, cost, recent-runs, notes
- `addedAt` (string, optional) — When the block was added; set by the server
- `addedByUserId` (string, optional) — Who added the block (blocks people add only); set by the server
- `config` (map from string to any, optional) — Block-owned settings; absent keeps the stored config
- `editedAt` (string, optional) — When that save happened; set by the server
- `editedByUserId` (string, optional) — Who last saved a change to what the block shows; set by the server
- `hidden` (boolean, optional) — True hides the block; absent or false shows it

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasGroupsItems

- `color` (string, required)
- `id` (string, required)
- `memberIds` (list of string, required)
- `name` (string, required)
- `position` (V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasGroupsItemsPosition, optional)
- `size` (V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasGroupsItemsSize, optional)
- `type` (enum, optional)
  - Allowed values: `capabilities`, `surfaces`

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasNotesItems

- `id` (string, required)
- `text` (string, required)
- `x` (double, required)
- `y` (double, required)
- `color` (string, optional)
- `height` (double, optional)
- `width` (double, optional)

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasQuickStartImport

- `documentKind` (enum, required)
  - Allowed values: `a2a-agent`, `fpo`, `fpo-template`, `mcp-server`
- `importedAt` (string, required)
- `sourceKind` (enum, required)
  - Allowed values: `url`, `json`
- `normalizedSourceUrl` (string, optional)
- `savedServerName` (string, optional)
- `serverName` (string, optional)
- `sourceUrl` (string, optional)
- `templateVariableKeys` (list of string, optional)

### V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecImportedFrom

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

### V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecInternalDocs

- `content` (string, optional)
- `resources` (list of V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecInternalDocsResourcesItems, 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

### V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecTechStack

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

### V1ProductsPostResponsesContentApplicationJsonSchemaTestApiKeyLimits

- `dailyExecutions` (integer, required)
- `lifetimeExecutions` (integer, required)

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasGroupsItemsPosition

- `x` (double, required)
- `y` (double, required)

### V1ProductsPostRequestBodyContentApplicationJsonSchemaCanvasGroupsItemsSize

- `height` (double, required)
- `width` (double, required)

### V1ProductsPostRequestBodyContentApplicationJsonSchemaSpecInternalDocsResourcesItems

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

**Request**

```json
{
  "name": "Customer Support Bot",
  "description": "AI-powered customer support",
  "slug": "support-bot",
  "status": "active"
}
```

**Response**

```json
{
  "canvas": {},
  "capabilities": [
    null
  ],
  "createdAt": "string",
  "description": "string",
  "icon": "string",
  "id": "string",
  "name": "string",
  "spec": {},
  "surfaces": [
    null
  ],
  "updatedAt": "string",
  "dashboardUrl": "string",
  "testApiKey": {
    "canRevealLater": true,
    "id": "string",
    "key": "string",
    "limits": {
      "dailyExecutions": 1,
      "lifetimeExecutions": 1
    },
    "name": "string",
    "prefix": "string"
  }
}
```

**SDK Code**

```python Create Product
import requests

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

payload = {
    "name": "Customer Support Bot",
    "description": "AI-powered customer support",
    "slug": "support-bot",
    "status": "active"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Create Product
const url = 'https://api.runtype.com/v1/products';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Customer Support Bot","description":"AI-powered customer support","slug":"support-bot","status":"active"}'
};

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

```go Create Product
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Customer Support Bot\",\n  \"description\": \"AI-powered customer support\",\n  \"slug\": \"support-bot\",\n  \"status\": \"active\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

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

url = URI("https://api.runtype.com/v1/products")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Customer Support Bot\",\n  \"description\": \"AI-powered customer support\",\n  \"slug\": \"support-bot\",\n  \"status\": \"active\"\n}"

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

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

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Customer Support Bot\",\n  \"description\": \"AI-powered customer support\",\n  \"slug\": \"support-bot\",\n  \"status\": \"active\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/products', [
  'body' => '{
  "name": "Customer Support Bot",
  "description": "AI-powered customer support",
  "slug": "support-bot",
  "status": "active"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Create Product
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Customer Support Bot\",\n  \"description\": \"AI-powered customer support\",\n  \"slug\": \"support-bot\",\n  \"status\": \"active\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create Product
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Customer Support Bot",
  "description": "AI-powered customer support",
  "slug": "support-bot",
  "status": "active"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/products")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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