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

Add item to surface

POST
/v1/products/:id/surfaces/:surfaceId/items
POST
/v1/products/:id/surfaces/:surfaceId/items
$curl -X POST https://api.runtype.com/v1/products/id/surfaces/surfaceId/items \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "capabilityId": "cap-9f8b7c6d5e4a3b2c1d0e"
>}'
1{
2  "id": "item-123e4567-e89b-12d3-a456-426614174000",
3  "surfaceId": "surface-9876543210abcdef",
4  "capabilityId": "cap-9f8b7c6d5e4a3b2c1d0e",
5  "exposedName": "User Authentication",
6  "exposedDescription": "Provides user login and session management capabilities.",
7  "endpointSlug": "user-authentication",
8  "isEntryPoint": true,
9  "enabled": true,
10  "displayOrder": 1,
11  "createdAt": "2024-06-01T12:00:00Z"
12}
Add a capability item to a surface.
Was this page helpful?
Previous

Update surface item

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
surfaceIdstringRequired

Request

This endpoint expects an object.
capabilityIdstringRequired
exposedNamestringOptional<=100 characters
exposedDescriptionstringOptional
endpointSlugstringOptionalformat: "^[a-z0-9-]+$"<=100 characters
isEntryPointbooleanOptional
enabledbooleanOptional
presentationobjectOptional

Response

Surface item added
idstring
surfaceIdstring
capabilityIdstring
exposedNamestring or null
exposedDescriptionstring or null
endpointSlugstring or null
isEntryPointboolean
enabledboolean
displayOrderinteger or null
createdAtstring

Errors

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