Pull surface definition (config-as-code)

{
  "contentHash": "a3f5c9d8e7b4f1a2c6d3e8b9f0a1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9",
  "definition": {
    "name": "CustomerSupportChat",
    "type": "chat",
    "behavior": {
      "retryPolicy": "exponentialBackoff",
      "maxRetries": 5,
      "timeoutSeconds": 30
    },
    "environment": "production",
    "inbound": {
      "channel": "webchat",
      "language": "en-US"
    },
    "outbound": {
      "notificationsEnabled": true,
      "channels": [
        "email",
        "sms"
      ]
    },
    "status": "draft"
  },
  "lastModifiedSource": "dashboard-ui",
  "surfaceId": "surf_9f8e7d6c5b4a3210",
  "updatedAt": "2024-06-10T15:45:30Z"
}

Return the canonical config-as-code definition and provenance for a surface by name within a product — the absorb-drift direction of the ensure protocol. The contentHash is recomputed from the live surface state, so it is accurate even immediately after a dashboard edit.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Query parameters

namestringRequired>=1 character

Response

Canonical definition + provenance

contentHashstring

definitionobject

lastModifiedSourcestring or null

surfaceIdstring

updatedAtstring or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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