> 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 full product object (FPO) POST https://api.runtype.com/v1/public/products/validate Content-Type: application/json Validates a Full Product Object (FPO) against the platform schema and returns errors, warnings, and recommendations. Reference: https://docs.runtype.com/api-reference/runtype-api/product-validation/validate-a-full-product-object-fpo ## 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 V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaErrorsItems, required) - `recommendations` (list of V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaRecommendationsItems, required) - `valid` (boolean, required) - `warnings` (list of V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaWarningsItems, 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. ### 403 Forbidden Error Forbidden - `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 V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaErrorsItems, required) - `recommendations` (list of V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaRecommendationsItems, required) - `valid` (boolean, required) - `warnings` (list of V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaWarningsItems, required) ## Types ### V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaErrorsItems - `code` (string, required) - `message` (string, required) - `path` (string, required) - `severity` (string, required) ### V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaRecommendationsItems - `code` (string, required) - `message` (string, required) - `path` (string, required) - `severity` (string, required) ### V1PublicProductsValidatePostResponsesContentApplicationJsonSchemaWarningsItems - `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 { "_meta": { "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "2.0" }, "capabilities": [ { "agent": { "config": { "model": "claude-sonnet-4-5", "systemPrompt": "You are a helpful assistant." }, "description": "Helpful assistant agent", "name": "Chat Agent" }, "description": "Conversational chat capability", "id": "chat", "name": "Chat" } ], "product": { "description": "An AI-powered product", "name": "My AI Product" }, "surfaces": [ { "config": {}, "id": "chat-widget", "name": "Chat Widget", "routes": [ { "capabilityId": "chat" } ], "type": "chat" } ], "tools": [], "version": "2.0" } ``` **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 full product object (FPO) import requests url = "https://api.runtype.com/v1/public/products/validate" payload = { "_meta": { "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "2.0" }, "capabilities": [ { "agent": { "config": { "model": "claude-sonnet-4-5", "systemPrompt": "You are a helpful assistant." }, "description": "Helpful assistant agent", "name": "Chat Agent" }, "description": "Conversational chat capability", "id": "chat", "name": "Chat" } ], "product": { "description": "An AI-powered product", "name": "My AI Product" }, "surfaces": [ { "config": {}, "id": "chat-widget", "name": "Chat Widget", "routes": [{ "capabilityId": "chat" }], "type": "chat" } ], "tools": [], "version": "2.0" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Validate a full product object (FPO) const url = 'https://api.runtype.com/v1/public/products/validate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"_meta":{"catalogVersion":"2026-06-01","generatedAt":"2026-06-01T00:00:00.000Z","generatorVersion":"1.0.0","planHash":"abc123","schemaVersion":"2.0"},"capabilities":[{"agent":{"config":{"model":"claude-sonnet-4-5","systemPrompt":"You are a helpful assistant."},"description":"Helpful assistant agent","name":"Chat Agent"},"description":"Conversational chat capability","id":"chat","name":"Chat"}],"product":{"description":"An AI-powered product","name":"My AI Product"},"surfaces":[{"config":{},"id":"chat-widget","name":"Chat Widget","routes":[{"capabilityId":"chat"}],"type":"chat"}],"tools":[],"version":"2.0"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Validate a full product object (FPO) package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.runtype.com/v1/public/products/validate" payload := strings.NewReader("{\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\": \"2.0\"\n },\n \"capabilities\": [\n {\n \"agent\": {\n \"config\": {\n \"model\": \"claude-sonnet-4-5\",\n \"systemPrompt\": \"You are a helpful assistant.\"\n },\n \"description\": \"Helpful assistant agent\",\n \"name\": \"Chat Agent\"\n },\n \"description\": \"Conversational chat capability\",\n \"id\": \"chat\",\n \"name\": \"Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"chat-widget\",\n \"name\": \"Chat Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\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 full product object (FPO) require 'uri' require 'net/http' url = URI("https://api.runtype.com/v1/public/products/validate") 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 \"_meta\": {\n \"catalogVersion\": \"2026-06-01\",\n \"generatedAt\": \"2026-06-01T00:00:00.000Z\",\n \"generatorVersion\": \"1.0.0\",\n \"planHash\": \"abc123\",\n \"schemaVersion\": \"2.0\"\n },\n \"capabilities\": [\n {\n \"agent\": {\n \"config\": {\n \"model\": \"claude-sonnet-4-5\",\n \"systemPrompt\": \"You are a helpful assistant.\"\n },\n \"description\": \"Helpful assistant agent\",\n \"name\": \"Chat Agent\"\n },\n \"description\": \"Conversational chat capability\",\n \"id\": \"chat\",\n \"name\": \"Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"chat-widget\",\n \"name\": \"Chat Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\n}" response = http.request(request) puts response.read_body ``` ```java Validate a full product object (FPO) import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.runtype.com/v1/public/products/validate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\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\": \"2.0\"\n },\n \"capabilities\": [\n {\n \"agent\": {\n \"config\": {\n \"model\": \"claude-sonnet-4-5\",\n \"systemPrompt\": \"You are a helpful assistant.\"\n },\n \"description\": \"Helpful assistant agent\",\n \"name\": \"Chat Agent\"\n },\n \"description\": \"Conversational chat capability\",\n \"id\": \"chat\",\n \"name\": \"Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"chat-widget\",\n \"name\": \"Chat Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\n}") .asString(); ``` ```php Validate a full product object (FPO) request('POST', 'https://api.runtype.com/v1/public/products/validate', [ 'body' => '{ "_meta": { "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "2.0" }, "capabilities": [ { "agent": { "config": { "model": "claude-sonnet-4-5", "systemPrompt": "You are a helpful assistant." }, "description": "Helpful assistant agent", "name": "Chat Agent" }, "description": "Conversational chat capability", "id": "chat", "name": "Chat" } ], "product": { "description": "An AI-powered product", "name": "My AI Product" }, "surfaces": [ { "config": {}, "id": "chat-widget", "name": "Chat Widget", "routes": [ { "capabilityId": "chat" } ], "type": "chat" } ], "tools": [], "version": "2.0" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Validate a full product object (FPO) using RestSharp; var client = new RestClient("https://api.runtype.com/v1/public/products/validate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\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\": \"2.0\"\n },\n \"capabilities\": [\n {\n \"agent\": {\n \"config\": {\n \"model\": \"claude-sonnet-4-5\",\n \"systemPrompt\": \"You are a helpful assistant.\"\n },\n \"description\": \"Helpful assistant agent\",\n \"name\": \"Chat Agent\"\n },\n \"description\": \"Conversational chat capability\",\n \"id\": \"chat\",\n \"name\": \"Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"chat-widget\",\n \"name\": \"Chat Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Validate a full product object (FPO) import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "_meta": [ "catalogVersion": "2026-06-01", "generatedAt": "2026-06-01T00:00:00.000Z", "generatorVersion": "1.0.0", "planHash": "abc123", "schemaVersion": "2.0" ], "capabilities": [ [ "agent": [ "config": [ "model": "claude-sonnet-4-5", "systemPrompt": "You are a helpful assistant." ], "description": "Helpful assistant agent", "name": "Chat Agent" ], "description": "Conversational chat capability", "id": "chat", "name": "Chat" ] ], "product": [ "description": "An AI-powered product", "name": "My AI Product" ], "surfaces": [ [ "config": [], "id": "chat-widget", "name": "Chat Widget", "routes": [["capabilityId": "chat"]], "type": "chat" ] ], "tools": [], "version": "2.0" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/public/products/validate")! 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() ```