Get product details | Runtype Documentation

{
  "capabilities": [
    {
      "name": "AI Code Generation",
      "description": "Generates code snippets based on user prompts",
      "enabled": true
    }
  ],
  "createdAt": "2024-05-20T10:15:30Z",
  "description": "An AI-powered product that automates code generation and testing workflows.",
  "icon": "https://runtype.com/assets/icons/codegen.svg",
  "id": "prod_9f8b7c6d5e4a3b2c1d0e",
  "name": "Runtype CodeGen",
  "surfaces": [
    {
      "type": "web",
      "url": "https://app.runtype.com/codegen"
    }
  ],
  "updatedAt": "2024-06-01T08:45:00Z",
  "configurationUrl": "https://dashboard.runtype.com/products/12345/configure",
  "dashboardUrl": "https://dashboard.runtype.com/products/12345",
  "editorContext": {
    "agentConfigMap": {
      "codeGenerator": {
        "language": "typescript",
        "version": "4.5"
      }
    },
    "flowStepsMap": {
      "initialization": [
        {
          "name": "Setup Environment",
          "type": "setup"
        },
        {
          "name": "Load Templates",
          "type": "load"
        }
      ],
      "generation": [
        {
          "name": "Generate Code",
          "type": "process"
        },
        {
          "name": "Run Tests",
          "type": "test"
        }
      ]
    }
  },
  "pendingConfigurationCount": 2
}

Get a product by ID including its capabilities and surfaces.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Query parameters

includeEditorContextstringOptional

Response

Product details

capabilitieslist of any

createdAtstring

descriptionstring or null

iconstring or null

idstring

namestring

surfaceslist of any

updatedAtstring

canvasany

configurationStatusany

configurationUrlstring or null

dashboardUrlstring

editorContextobject

pendingConfigurationCountinteger

specany

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/products/id \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"