Pull product definition (config-as-code)

GET

/v1/products/pull

GET

/v1/products/pull

$ curl -G https://api.runtype.com/v1/products/pull \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      --data-urlencode "name=SmartHome Controller"

1 {
2   "contentHash": "a3f5d9e7b2c4f1d8e6a9b0c3d7f8e2a1",
3   "definition": {
4     "name": "SmartHome Controller",
5     "description": "A centralized AI-driven platform to manage and automate smart home devices seamlessly.",
6     "icon": "smart-home-icon.svg",
7     "spec": {
8       "aiUseCases": [
9         "voice-assistant-integration",
10         "energy-optimization",
11         "security-monitoring"
12       ],
13       "complianceNeeds": [
14         "gdpr",
15         "ccpa"
16       ],
17       "dataSourceTypes": [
18         "iot-sensors",
19         "user-activity-logs"
20       ],
21       "deploymentTargets": [
22         "aws-lambda",
23         "edge-devices"
24       ],
25       "existingTools": [
26         "home-assistant",
27         "openhab"
28       ],
29       "importedFrom": {
30         "importedAt": "2024-06-10T09:45:00Z",
31         "source": "github",
32         "sourceId": "repo12345",
33         "syncEnabled": true
34       },
35       "internalDocs": {
36         "content": "This product integrates multiple smart home protocols and provides AI-driven automation.",
37         "resources": [
38           {
39             "title": "Getting Started",
40             "type": "guide",
41             "content": "Setup guide for initial configuration.",
42             "url": "https://docs.smarthome.com/getting-started"
43           },
44           {
45             "title": "API Documentation",
46             "type": "documentation",
47             "content": "API reference for device integration.",
48             "url": "https://api.smarthome.com/docs"
49           }
50         ],
51         "tags": [
52           "smart-home",
53           "automation",
54           "ai"
55         ]
56       },
57       "loggingPolicy": "default",
58       "preferredModels": [
59         "gpt-4",
60         "bert-base"
61       ],
62       "productGoal": "To provide an intelligent and unified control system for smart home devices.",
63       "productStage": "production",
64       "targetAudience": "Homeowners and smart device enthusiasts",
65       "techStack": {
66         "backend": [
67           "nodejs",
68           "python"
69         ],
70         "database": [
71           "mongodb",
72           "redis"
73         ],
74         "frontend": [
75           "react",
76           "typescript"
77         ],
78         "infrastructure": [
79           "docker",
80           "kubernetes"
81         ],
82         "languages": [
83           "javascript",
84           "python"
85         ]
86       }
87     }
88   },
89   "lastModifiedSource": "github",
90   "productId": "prod-9f8e7d6c5b4a3210",
91   "updatedAt": "2024-06-12T16:20:00Z"
92 }

Return the canonical config-as-code definition and provenance for a product by name — the absorb-drift direction of the ensure protocol. The contentHash is recomputed from the live product state, so it is accurate even immediately after a dashboard edit. Returns the top-level product record only (description, icon, spec); nested capabilities/surfaces and canvas layout are not included.

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

namestringRequired>=1 character

Response

Canonical definition + provenance

contentHashstring

definitionobject

lastModifiedSourcestring or null

productIdstring

updatedAtstring or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error