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

Update product

PUT
/v1/products/:id
PUT
/v1/products/:id
$curl -X PUT https://api.runtype.com/v1/products/id \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "id": "a3f1c9d2-4b7e-4f3a-9c2d-8e5f7a1b2c3d",
3 "name": "Runtype AI Platform",
4 "description": "An AI product development platform with powerful automation capabilities.",
5 "icon": "🤖",
6 "canvas": {},
7 "spec": {},
8 "createdAt": "2024-06-01T12:00:00Z",
9 "updatedAt": "2024-06-15T09:30:00Z",
10 "dashboardUrl": "https://dashboard.runtype.com/products/a3f1c9d2-4b7e-4f3a-9c2d-8e5f7a1b2c3d"
11}

Update an existing product. Supports partial updates with deep-merging for canvas and spec.

Was this page helpful?
Previous

Add capability to product

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

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

Response

Product updated
idstring
namestring
descriptionstring or null
iconstring or null
canvasmap from strings to any
specmap from strings to any
createdAtstring
updatedAtstring
dashboardUrlstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error