FPO templates

1
{
2
  "name": "{{productName}}"
3
}

1
{
2
  "version": "1.0",
3
  "productObject": {
4
    "version": "2.0",
5
    "product": {
6
      "name": "{{productName}}",
7
      "description": "Support automation for {{companyName}}",
8
      "metadata": {
9
        "requireEscalationApproval": "{{requireEscalationApproval}}",
10
        "responseTimeoutMinutes": "{{responseTimeoutMinutes}}"
11
      }
12
    },
13
    "capabilities": [
14
      {
15
        "id": "cap_support",
16
        "name": "Support Agent",
17
        "description": "Handle incoming support requests.",
18
        "agent": {
19
          "name": "{{productName}} Agent",
20
          "description": "Handle support requests for {{companyName}}.",
21
          "config": {
22
            "model": "claude-sonnet-4-5",
23
            "systemPrompt": "Use a {{brandVoice}} tone when responding."
24
          }
25
        }
26
      }
27
    ],
28
    "tools": [
29
      {
30
        "id": "tool_search",
31
        "type": "integration",
32
        "provider": "{{searchProvider}}",
33
        "name": "Knowledge Search",
34
        "config": {
35
          "apiKey": "{{searchApiKey}}",
36
          "baseUrl": "{{knowledgeBaseUrl}}"
37
        },
38
        "auth": {
39
          "type": "user_provided",
40
          "setupRequired": true,
41
          "secrets": [
42
            {
43
              "key": "searchApiKey",
44
              "required": true
45
            }
46
          ],
47
          "setupInstructions": {
48
            "summary": "Add your search provider key",
49
            "steps": ["Create an API key", "Paste it into the deployment form"]
50
          }
51
        }
52
      }
53
    ],
54
    "surfaces": [
55
      {
56
        "id": "surface_chat",
57
        "name": "{{productName}} Chat",
58
        "type": "chat",
59
        "config": {},
60
        "routes": [
61
          {
62
            "capabilityId": "cap_support"
63
          }
64
        ]
65
      }
66
    ],
67
    "_meta": {
68
      "schemaVersion": "2.0",
69
      "catalogVersion": "1.0",
70
      "generatedAt": "2026-03-07T00:00:00.000Z",
71
      "generatorVersion": "1.0.0",
72
      "planHash": "template-example"
73
    }
74
  },
75
  "template": {
76
    "variables": [
77
      {
78
        "key": "productName",
79
        "label": "Product Name",
80
        "inputType": "text",
81
        "required": true,
82
        "defaultValue": "Acme Support Copilot"
83
      },
84
      {
85
        "key": "companyName",
86
        "label": "Company Name",
87
        "inputType": "text",
88
        "required": true
89
      },
90
      {
91
        "key": "knowledgeBaseUrl",
92
        "label": "Knowledge Base URL",
93
        "inputType": "url",
94
        "required": true
95
      },
96
      {
97
        "key": "searchProvider",
98
        "label": "Search Provider",
99
        "inputType": "select",
100
        "required": true,
101
        "defaultValue": "firecrawl",
102
        "options": [
103
          { "label": "Firecrawl", "value": "firecrawl" },
104
          { "label": "Exa", "value": "exa" }
105
        ]
106
      },
107
      {
108
        "key": "requireEscalationApproval",
109
        "label": "Require Escalation Approval",
110
        "inputType": "boolean",
111
        "required": true,
112
        "defaultValue": true
113
      },
114
      {
115
        "key": "responseTimeoutMinutes",
116
        "label": "Response Timeout Minutes",
117
        "inputType": "number",
118
        "required": true,
119
        "defaultValue": 15
120
      },
121
      {
122
        "key": "brandVoice",
123
        "label": "Brand Voice",
124
        "inputType": "textarea",
125
        "required": false,
126
        "defaultValue": "Calm and direct."
127
      },
128
      {
129
        "key": "searchApiKey",
130
        "label": "Search API Key",
131
        "inputType": "secret",
132
        "required": true
133
      }
134
    ]
135
  }
136
}

1
{
2
  "productObject": {
3
    "capabilities": [
4
      {
5
        "id": "cap_support",
6
        "name": "Support Agent",
7
        "description": "Answer user questions.",
8
        "existingAgentId": "agent_support"
9
      },
10
      {
11
        "id": "cap_weekly_digest",
12
        "name": "Weekly Digest",
13
        "description": "Summarize new records each Monday.",
14
        "existingFlowId": "flow_weekly_digest"
15
      }
16
    ],
17
    "surfaces": [
18
      {
19
        "id": "surface_chat",
20
        "name": "Support Chat",
21
        "type": "chat",
22
        "config": {},
23
        "routes": [{ "capabilityId": "cap_support" }]
24
      }
25
    ],
26
    "schedules": [
27
      {
28
        "id": "weekly-digest",
29
        "capabilityId": "cap_weekly_digest",
30
        "triggerType": "cron",
31
        "cron": "0 9 * * MON",
32
        "timezone": "UTC",
33
        "enabled": true
34
      }
35
    ]
36
  }
37
}

1
{
2
  "productObject": {
3
    "capabilities": [
4
      {
5
        "id": "cap_support",
6
        "name": "Support Agent",
7
        "description": "Answer user questions.",
8
        "existingAgentId": "agent_support"
9
      }
10
    ],
11
    "evals": [
12
      {
13
        "id": "eval_support_basics",
14
        "name": "Support basics",
15
        "capabilityId": "cap_support",
16
        "graders": [
17
          {
18
            "kind": "ai",
19
            "criteria": "The response directly addresses what the user asked, without dodging or answering a different question."
20
          }
21
        ],
22
        "cases": [
23
          {
24
            "name": "Refund policy question",
25
            "input": {
26
              "messages": [{ "role": "user", "content": "What is your refund policy?" }]
27
            },
28
            "expected": { "facts": ["Refunds are available within 30 days"] },
29
            "enabled": true
30
          }
31
        ]
32
      }
33
    ]
34
  }
35
}

1
{
2
  "productObject": {
3
    "capabilities": [
4
      {
5
        "id": "cap_support",
6
        "name": "Support Agent",
7
        "description": "Answer user questions.",
8
        "existingAgentId": "agent_support"
9
      }
10
    ],
11
    "skills": [
12
      {
13
        "id": "skill_refund_policy",
14
        "name": "Refund policy",
15
        "slug": "refund-policy",
16
        "description": "Load when the user asks about refunds, returns, or exchanges.",
17
        "content": "# Refund policy\n\nRefunds are available within 30 days of purchase. Always confirm the order number before promising a refund.",
18
        "bindTo": ["cap_support"]
19
      }
20
    ]
21
  }
22
}

1
const template = await fetch('/customer-support-fpo-template.json').then((response) =>
2
  response.json()
3
)
4
5
const validation = await fetch('https://api.runtype.com/v1/public/products/validate-template', {
6
  method: 'POST',
7
  headers: {
8
    Authorization: `Bearer ${process.env.RUNTYPE_API_KEY}`,
9
    'Content-Type': 'application/json',
10
  },
11
  body: JSON.stringify(template),
12
}).then((response) => response.json())
13
14
console.log(validation.valid)
15
console.log(validation.errors)
16
console.log(validation.referencedVariableKeys)
17
console.log(validation.defaultsSufficient)

$
curl https://api.runtype.com/v1/public/products/validate-template \
>
  -H "Authorization: Bearer YOUR_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d @docs/templates/quick-start/customer-support-fpo-template.json