> 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. # Assemble product from FPO POST https://api.runtype.com/v1/products/assemble Content-Type: application/json Assemble a product from a validated Full Product Object (FPO). API keys must carry PRODUCTS:WRITE (or PRODUCTS:CREATE) and SECRETS:WRITE, plus the write scope for every entity kind the FPO materializes (FLOWS:WRITE, AGENTS:WRITE, PRODUCTS:SURFACES:WRITE, SCHEDULES:WRITE, RECORDS:WRITE, EVALS:WRITE, SKILLS:WRITE), and SECRETS:READ when an inline HTTP step references a managed secret. Reference: https://docs.runtype.com/api-reference/runtype-api/products/assemble-product-from-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) ## Request ### Body (application/json) This endpoint expects a map from string to any. - `map from string to any` ## Response ### 201 Assembled product result - `cached` (boolean, required) - `capabilities` (list of V1ProductsAssemblePostResponsesContentApplicationJsonSchemaCapabilitiesItems, required) - `creationMap` (map from string to string, required) - `productId` (string, required) - `surfaces` (list of V1ProductsAssemblePostResponsesContentApplicationJsonSchemaSurfacesItems, required) - `warnings` (list of string, optional) — Non-fatal advisories, e.g. a remapped deprecated field or seed data skipped because an existing enforce collection outside the FPO refuses it. ## Errors ### 400 Bad Request Error Validation or invalid input error - `error` (V1ProductsAssemblePostResponsesContentApplicationJsonSchemaError, required) ### 401 Unauthorized Error Unauthorized - `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 Insufficient permissions for the entities this FPO materializes - `error` (V1ProductsAssemblePostResponsesContentApplicationJsonSchemaError, required) ### 500 Internal Server Error Internal server error - `error` (V1ProductsAssemblePostResponsesContentApplicationJsonSchemaError, required) ## Types ### V1ProductsAssemblePostResponsesContentApplicationJsonSchemaCapabilitiesItems - `capabilityId` (string, required) - `name` (string, required) - `agentId` (string, optional) - `flowId` (string, optional) ### V1ProductsAssemblePostResponsesContentApplicationJsonSchemaSurfacesItems - `name` (string, required) - `surfaceId` (string, required) - `surfaceItemIds` (list of string, required) - `type` (string, required) - `integrationId` (string, optional) ### V1ProductsAssemblePostResponsesContentApplicationJsonSchemaError - `code` (string, required) - `message` (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": "1.0.0", "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 support agent." }, "description": "A helpful customer support agent", "name": "Support Agent" }, "description": "Handles customer support conversations", "id": "support-chat", "name": "Support Chat" } ], "product": { "description": "An AI-powered customer support product", "name": "My AI Product" }, "surfaces": [ { "config": {}, "id": "support-widget", "name": "Support Widget", "routes": [ { "capabilityId": "support-chat" } ], "type": "chat" } ], "tools": [], "version": "2.0" } ``` **Response** ```json { "cached": true, "capabilities": [ { "capabilityId": "string", "name": "string", "agentId": "string", "flowId": "string" } ], "creationMap": {}, "productId": "string", "surfaces": [ { "name": "string", "surfaceId": "string", "surfaceItemIds": [ "string" ], "type": "string", "integrationId": "string" } ], "warnings": [ "string" ] } ``` **SDK Code** ```python Assemble product from FPO import requests url = "https://api.runtype.com/v1/products/assemble" payload = { "_meta": { "catalogVersion": "1.0.0", "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 support agent." }, "description": "A helpful customer support agent", "name": "Support Agent" }, "description": "Handles customer support conversations", "id": "support-chat", "name": "Support Chat" } ], "product": { "description": "An AI-powered customer support product", "name": "My AI Product" }, "surfaces": [ { "config": {}, "id": "support-widget", "name": "Support Widget", "routes": [{ "capabilityId": "support-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 Assemble product from FPO const url = 'https://api.runtype.com/v1/products/assemble'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"_meta":{"catalogVersion":"1.0.0","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 support agent."},"description":"A helpful customer support agent","name":"Support Agent"},"description":"Handles customer support conversations","id":"support-chat","name":"Support Chat"}],"product":{"description":"An AI-powered customer support product","name":"My AI Product"},"surfaces":[{"config":{},"id":"support-widget","name":"Support Widget","routes":[{"capabilityId":"support-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 Assemble product from FPO package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.runtype.com/v1/products/assemble" payload := strings.NewReader("{\n \"_meta\": {\n \"catalogVersion\": \"1.0.0\",\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 support agent.\"\n },\n \"description\": \"A helpful customer support agent\",\n \"name\": \"Support Agent\"\n },\n \"description\": \"Handles customer support conversations\",\n \"id\": \"support-chat\",\n \"name\": \"Support Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered customer support product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"support-widget\",\n \"name\": \"Support Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"support-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 Assemble product from FPO require 'uri' require 'net/http' url = URI("https://api.runtype.com/v1/products/assemble") 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\": \"1.0.0\",\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 support agent.\"\n },\n \"description\": \"A helpful customer support agent\",\n \"name\": \"Support Agent\"\n },\n \"description\": \"Handles customer support conversations\",\n \"id\": \"support-chat\",\n \"name\": \"Support Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered customer support product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"support-widget\",\n \"name\": \"Support Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"support-chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\n}" response = http.request(request) puts response.read_body ``` ```java Assemble product from FPO import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.runtype.com/v1/products/assemble") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"_meta\": {\n \"catalogVersion\": \"1.0.0\",\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 support agent.\"\n },\n \"description\": \"A helpful customer support agent\",\n \"name\": \"Support Agent\"\n },\n \"description\": \"Handles customer support conversations\",\n \"id\": \"support-chat\",\n \"name\": \"Support Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered customer support product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"support-widget\",\n \"name\": \"Support Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"support-chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\n}") .asString(); ``` ```php Assemble product from FPO request('POST', 'https://api.runtype.com/v1/products/assemble', [ 'body' => '{ "_meta": { "catalogVersion": "1.0.0", "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 support agent." }, "description": "A helpful customer support agent", "name": "Support Agent" }, "description": "Handles customer support conversations", "id": "support-chat", "name": "Support Chat" } ], "product": { "description": "An AI-powered customer support product", "name": "My AI Product" }, "surfaces": [ { "config": {}, "id": "support-widget", "name": "Support Widget", "routes": [ { "capabilityId": "support-chat" } ], "type": "chat" } ], "tools": [], "version": "2.0" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Assemble product from FPO using RestSharp; var client = new RestClient("https://api.runtype.com/v1/products/assemble"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"_meta\": {\n \"catalogVersion\": \"1.0.0\",\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 support agent.\"\n },\n \"description\": \"A helpful customer support agent\",\n \"name\": \"Support Agent\"\n },\n \"description\": \"Handles customer support conversations\",\n \"id\": \"support-chat\",\n \"name\": \"Support Chat\"\n }\n ],\n \"product\": {\n \"description\": \"An AI-powered customer support product\",\n \"name\": \"My AI Product\"\n },\n \"surfaces\": [\n {\n \"config\": {},\n \"id\": \"support-widget\",\n \"name\": \"Support Widget\",\n \"routes\": [\n {\n \"capabilityId\": \"support-chat\"\n }\n ],\n \"type\": \"chat\"\n }\n ],\n \"tools\": [],\n \"version\": \"2.0\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Assemble product from FPO import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "_meta": [ "catalogVersion": "1.0.0", "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 support agent." ], "description": "A helpful customer support agent", "name": "Support Agent" ], "description": "Handles customer support conversations", "id": "support-chat", "name": "Support Chat" ] ], "product": [ "description": "An AI-powered customer support product", "name": "My AI Product" ], "surfaces": [ [ "config": [], "id": "support-widget", "name": "Support Widget", "routes": [["capabilityId": "support-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/products/assemble")! 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() ```