For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • POSTCreate product
      • PUTUpdate product
      • POSTAdd capability to product
      • PUTUpdate capability
      • POSTCreate surface
      • PUTUpdate surface
      • POSTAdd item to surface
      • PUTUpdate surface item
      • POSTCreate surface API key
      • POSTCreate schedule for surface
      • PUTUpdate schedule
Dashboard
LogoLogo
Runtype APIProducts

Create product

POST
/v1/products
POST
/v1/products
$curl -X POST https://api.runtype.com/v1/products \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "SmartHome AI Assistant"
>}'
1{
2  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
3  "name": "SmartHome AI Assistant",
4  "description": "An AI-powered assistant designed to automate and optimize smart home devices and routines.",
5  "icon": "🏠🤖",
6  "canvas": {},
7  "spec": {},
8  "createdAt": "2024-06-01T10:15:30Z",
9  "updatedAt": "2024-06-01T10:15:30Z",
10  "capabilities": [
11    "voice-control",
12    "energy-monitoring",
13    "device-integration"
14  ],
15  "surfaces": [
16    "mobile-app",
17    "web-dashboard"
18  ],
19  "testApiKey": {
20    "id": "key-1234abcd5678efgh",
21    "name": "SmartHome Test Key",
22    "key": "sk_live_4f3b2a1c9d8e7f6g5h4i",
23    "prefix": "shai",
24    "limits": {
25      "dailyExecutions": 1000,
26      "lifetimeExecutions": 100000
27    },
28    "canRevealLater": false
29  },
30  "dashboardUrl": "https://dashboard.runtype.com/products/a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78"
31}
Create a new product with optional canvas and spec configuration.
Was this page helpful?
Previous

Update product

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
namestringRequired>=1 character
descriptionstringOptional
iconstringOptional<=50 characters
canvasobjectOptional
specobjectOptional

Response

Product created
idstring
namestring
descriptionstring or null
iconstring or null
canvasmap from strings to any
specmap from strings to any
createdAtstring
updatedAtstring
capabilitieslist of any
surfaceslist of any
testApiKeyobject
dashboardUrlstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error