> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.runtype.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server. # Validate a product template POST https://api.runtype.com/v1/public/products/validate-template Content-Type: application/json Validates a product template against the platform schema. Reference: https://docs.runtype.com/api-reference/runtype-api/product-validation/validate-a-product-template ## Authentication - `Authorization` header (bearer token, required) — API key or Clerk session token ## Servers - `https://api.runtype.com` (Production, default) - `https://api.runtype-staging.com` (Staging) ## Response ### 200 Validation result - `errors` (list of V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaErrorsItems, required) - `recommendations` (list of V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaRecommendationsItems, required) - `valid` (boolean, required) - `warnings` (list of V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaWarningsItems, required) ## Errors ### 400 Bad Request Error Invalid JSON body - `error` (string, required) - `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs. - `details` (list of ErrorDetailsItems, optional) - `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs. ### 500 Internal Server Error Validation failed unexpectedly - `errors` (list of V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaErrorsItems, required) - `recommendations` (list of V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaRecommendationsItems, required) - `valid` (boolean, required) - `warnings` (list of V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaWarningsItems, required) ## Types ### V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaErrorsItems - `code` (string, required) - `message` (string, required) - `path` (string, required) - `severity` (string, required) ### V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaRecommendationsItems - `code` (string, required) - `message` (string, required) - `path` (string, required) - `severity` (string, required) ### V1PublicProductsValidateTemplatePostResponsesContentApplicationJsonSchemaWarningsItems - `code` (string, required) - `message` (string, required) - `path` (string, required) - `severity` (string, required) ### ErrorDetailsItems - `message` (string, required) - `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM). - `path` (string, optional) — Dotted JSON path to the offending field. - `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …). ## Examples **Request** ```json { "productObject": { "_meta": { "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "1.1" }, "capabilities": [ { "description": "Summarizes input text", "flow": { "description": "Summarizes the provided input", "name": "Summarizer", "steps": [ { "config": { "model": "gpt-5-mini", "systemPrompt": "Summarize the following text.", "userPrompt": "{{input}}" }, "name": "Summarize", "type": "prompt" } ] }, "id": "summarize", "name": "Summarize" } ], "product": { "description": "A product template with variables", "name": "Template Product" }, "surfaces": [], "tools": [], "version": "1.1" }, "template": { "variables": [ { "inputType": "textarea", "key": "input", "label": "Input Text", "required": true } ] }, "version": "1.1" } ``` **Response** ```json { "errors": [ { "code": "string", "message": "string", "path": "string", "severity": "string" } ], "recommendations": [ { "code": "string", "message": "string", "path": "string", "severity": "string" } ], "valid": true, "warnings": [ { "code": "string", "message": "string", "path": "string", "severity": "string" } ] } ``` **SDK Code** ```python Validate a product template import requests url = "https://api.runtype.com/v1/public/products/validate-template" payload = { "productObject": { "_meta": { "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "1.1" }, "capabilities": [ { "description": "Summarizes input text", "flow": { "description": "Summarizes the provided input", "name": "Summarizer", "steps": [ { "config": { "model": "gpt-5-mini", "systemPrompt": "Summarize the following text.", "userPrompt": "{{input}}" }, "name": "Summarize", "type": "prompt" } ] }, "id": "summarize", "name": "Summarize" } ], "product": { "description": "A product template with variables", "name": "Template Product" }, "surfaces": [], "tools": [], "version": "1.1" }, "template": { "variables": [ { "inputType": "textarea", "key": "input", "label": "Input Text", "required": True } ] }, "version": "1.1" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Validate a product template const url = 'https://api.runtype.com/v1/public/products/validate-template'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"productObject":{"_meta":{"catalogVersion":"2026-06-01","generatedAt":"2026-06-01T00:00:00.000Z","generatorVersion":"1.0.0","planHash":"abc123","schemaVersion":"1.1"},"capabilities":[{"description":"Summarizes input text","flow":{"description":"Summarizes the provided input","name":"Summarizer","steps":[{"config":{"model":"gpt-5-mini","systemPrompt":"Summarize the following text.","userPrompt":"{{input}}"},"name":"Summarize","type":"prompt"}]},"id":"summarize","name":"Summarize"}],"product":{"description":"A product template with variables","name":"Template Product"},"surfaces":[],"tools":[],"version":"1.1"},"template":{"variables":[{"inputType":"textarea","key":"input","label":"Input Text","required":true}]},"version":"1.1"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Validate a product template package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.runtype.com/v1/public/products/validate-template" payload := strings.NewReader("{\n \"productObject\": {\n \"_meta\": {\n \"catalogVersion\": \"2026-06-01\",\n \"generatedAt\": \"2026-06-01T00:00:00.000Z\",\n \"generatorVersion\": \"1.0.0\",\n \"planHash\": \"abc123\",\n \"schemaVersion\": \"1.1\"\n },\n \"capabilities\": [\n {\n \"description\": \"Summarizes input text\",\n \"flow\": {\n \"description\": \"Summarizes the provided input\",\n \"name\": \"Summarizer\",\n \"steps\": [\n {\n \"config\": {\n \"model\": \"gpt-5-mini\",\n \"systemPrompt\": \"Summarize the following text.\",\n \"userPrompt\": \"{{input}}\"\n },\n \"name\": \"Summarize\",\n \"type\": \"prompt\"\n }\n ]\n },\n \"id\": \"summarize\",\n \"name\": \"Summarize\"\n }\n ],\n \"product\": {\n \"description\": \"A product template with variables\",\n \"name\": \"Template Product\"\n },\n \"surfaces\": [],\n \"tools\": [],\n \"version\": \"1.1\"\n },\n \"template\": {\n \"variables\": [\n {\n \"inputType\": \"textarea\",\n \"key\": \"input\",\n \"label\": \"Input Text\",\n \"required\": true\n }\n ]\n },\n \"version\": \"1.1\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Validate a product template require 'uri' require 'net/http' url = URI("https://api.runtype.com/v1/public/products/validate-template") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"productObject\": {\n \"_meta\": {\n \"catalogVersion\": \"2026-06-01\",\n \"generatedAt\": \"2026-06-01T00:00:00.000Z\",\n \"generatorVersion\": \"1.0.0\",\n \"planHash\": \"abc123\",\n \"schemaVersion\": \"1.1\"\n },\n \"capabilities\": [\n {\n \"description\": \"Summarizes input text\",\n \"flow\": {\n \"description\": \"Summarizes the provided input\",\n \"name\": \"Summarizer\",\n \"steps\": [\n {\n \"config\": {\n \"model\": \"gpt-5-mini\",\n \"systemPrompt\": \"Summarize the following text.\",\n \"userPrompt\": \"{{input}}\"\n },\n \"name\": \"Summarize\",\n \"type\": \"prompt\"\n }\n ]\n },\n \"id\": \"summarize\",\n \"name\": \"Summarize\"\n }\n ],\n \"product\": {\n \"description\": \"A product template with variables\",\n \"name\": \"Template Product\"\n },\n \"surfaces\": [],\n \"tools\": [],\n \"version\": \"1.1\"\n },\n \"template\": {\n \"variables\": [\n {\n \"inputType\": \"textarea\",\n \"key\": \"input\",\n \"label\": \"Input Text\",\n \"required\": true\n }\n ]\n },\n \"version\": \"1.1\"\n}" response = http.request(request) puts response.read_body ``` ```java Validate a product template import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.runtype.com/v1/public/products/validate-template") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"productObject\": {\n \"_meta\": {\n \"catalogVersion\": \"2026-06-01\",\n \"generatedAt\": \"2026-06-01T00:00:00.000Z\",\n \"generatorVersion\": \"1.0.0\",\n \"planHash\": \"abc123\",\n \"schemaVersion\": \"1.1\"\n },\n \"capabilities\": [\n {\n \"description\": \"Summarizes input text\",\n \"flow\": {\n \"description\": \"Summarizes the provided input\",\n \"name\": \"Summarizer\",\n \"steps\": [\n {\n \"config\": {\n \"model\": \"gpt-5-mini\",\n \"systemPrompt\": \"Summarize the following text.\",\n \"userPrompt\": \"{{input}}\"\n },\n \"name\": \"Summarize\",\n \"type\": \"prompt\"\n }\n ]\n },\n \"id\": \"summarize\",\n \"name\": \"Summarize\"\n }\n ],\n \"product\": {\n \"description\": \"A product template with variables\",\n \"name\": \"Template Product\"\n },\n \"surfaces\": [],\n \"tools\": [],\n \"version\": \"1.1\"\n },\n \"template\": {\n \"variables\": [\n {\n \"inputType\": \"textarea\",\n \"key\": \"input\",\n \"label\": \"Input Text\",\n \"required\": true\n }\n ]\n },\n \"version\": \"1.1\"\n}") .asString(); ``` ```php Validate a product template request('POST', 'https://api.runtype.com/v1/public/products/validate-template', [ 'body' => '{ "productObject": { "_meta": { "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "1.1" }, "capabilities": [ { "description": "Summarizes input text", "flow": { "description": "Summarizes the provided input", "name": "Summarizer", "steps": [ { "config": { "model": "gpt-5-mini", "systemPrompt": "Summarize the following text.", "userPrompt": "{{input}}" }, "name": "Summarize", "type": "prompt" } ] }, "id": "summarize", "name": "Summarize" } ], "product": { "description": "A product template with variables", "name": "Template Product" }, "surfaces": [], "tools": [], "version": "1.1" }, "template": { "variables": [ { "inputType": "textarea", "key": "input", "label": "Input Text", "required": true } ] }, "version": "1.1" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Validate a product template using RestSharp; var client = new RestClient("https://api.runtype.com/v1/public/products/validate-template"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"productObject\": {\n \"_meta\": {\n \"catalogVersion\": \"2026-06-01\",\n \"generatedAt\": \"2026-06-01T00:00:00.000Z\",\n \"generatorVersion\": \"1.0.0\",\n \"planHash\": \"abc123\",\n \"schemaVersion\": \"1.1\"\n },\n \"capabilities\": [\n {\n \"description\": \"Summarizes input text\",\n \"flow\": {\n \"description\": \"Summarizes the provided input\",\n \"name\": \"Summarizer\",\n \"steps\": [\n {\n \"config\": {\n \"model\": \"gpt-5-mini\",\n \"systemPrompt\": \"Summarize the following text.\",\n \"userPrompt\": \"{{input}}\"\n },\n \"name\": \"Summarize\",\n \"type\": \"prompt\"\n }\n ]\n },\n \"id\": \"summarize\",\n \"name\": \"Summarize\"\n }\n ],\n \"product\": {\n \"description\": \"A product template with variables\",\n \"name\": \"Template Product\"\n },\n \"surfaces\": [],\n \"tools\": [],\n \"version\": \"1.1\"\n },\n \"template\": {\n \"variables\": [\n {\n \"inputType\": \"textarea\",\n \"key\": \"input\",\n \"label\": \"Input Text\",\n \"required\": true\n }\n ]\n },\n \"version\": \"1.1\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Validate a product template import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "productObject": [ "_meta": [ "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "1.1" ], "capabilities": [ [ "description": "Summarizes input text", "flow": [ "description": "Summarizes the provided input", "name": "Summarizer", "steps": [ [ "config": [ "model": "gpt-5-mini", "systemPrompt": "Summarize the following text.", "userPrompt": "{{input}}" ], "name": "Summarize", "type": "prompt" ] ] ], "id": "summarize", "name": "Summarize" ] ], "product": [ "description": "A product template with variables", "name": "Template Product" ], "surfaces": [], "tools": [], "version": "1.1" ], "template": ["variables": [ [ "inputType": "textarea", "key": "input", "label": "Input Text", "required": true ] ]], "version": "1.1" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/public/products/validate-template")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```