Validate a standalone surface definition

curl -X POST https://api.runtype.com/v1/public/products/validate/surface \
     -H "Content-Type: application/json" \
     -d '{
  "config": {
    "theme": "default"
  },
  "id": "chat-widget",
  "name": "Chat Widget",
  "routes": [
    {
      "capabilityId": "chat"
    }
  ],
  "type": "chat"
}'

{
  "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"
    }
  ]
}

Validates a surface definition in isolation, without requiring a full product object.

Request

This endpoint expects an object.

Response

Validation result

errorslist of objects

recommendationslist of objects

validboolean

warningslist of objects

Errors

400

Bad Request Error

500

Internal Server Error