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 capability to product

POST
/v1/products/:id/capabilities
POST
/v1/products/:id/capabilities
$curl -X POST https://api.runtype.com/v1/products/id/capabilities \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "capabilityName": "User Authentication Flow"
>}'
1{
2 "id": "cap-9f8b7c6d-1234-4e56-8a9b-0c1d2e3f4a5b",
3 "productId": "prod-4a7d9e2f-5678-4b9c-8d0e-1f2a3b4c5d6e",
4 "flowId": "flow-3c2b1a0d-9876-4f5e-8d7c-0b1a2c3d4e5f",
5 "agentId": "",
6 "capabilityName": "User Authentication Flow",
7 "capabilityDescription": "Handles user login and session management",
8 "enabled": true,
9 "displayOrder": 1,
10 "createdAt": "2024-06-01T10:15:30Z",
11 "parametersSchema": null
12}

Add a capability (flow or agent binding) to a product. Requires either flowId or agentId.

Was this page helpful?
Previous

Update capability

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.
capabilityNamestringRequired1-100 characters
flowIdstringOptional
agentIdstringOptional
capabilityDescriptionstringOptional
parametersSchemaany or nullOptional
enabledbooleanOptional

Response

Capability added
idstring
productIdstring
flowIdstring or null
agentIdstring or null
capabilityNamestring
capabilityDescriptionstring or null
enabledboolean
displayOrderinteger or null
createdAtstring
parametersSchemaany or null

Errors

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