Runtype APIProducts

Create surface

Create a new surface for a product. Checks entitlement limits via Schematic.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.
namestringRequired1-255 characters
typeenumRequired
behavioranyOptional
configanyOptional
environmentenumOptionalDefaults to development
Allowed values:
inboundmap from strings to anyOptional
outboundmap from strings to anyOptional
statusenumOptional
Allowed values:

Response

Surface created
createdAtstring
endpointstring or null

Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, …). Clients should use this instead of constructing the URL themselves.

environmentstring
idstring
itemslist of any
keyslist of any
namestring
productIdstring
statusstring
typestring
updatedAtstring
behaviorany
inboundany
outboundany

Errors

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