Create surface | Runtype Documentation

curl -X POST https://api.runtype.com/v1/products/id/surfaces \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Public API",
  "type": "api",
  "config": {
    "rateLimit": {
      "perDay": 5000,
      "perMinute": 60
    },
    "type": "api"
  },
  "status": "active"
}'

{
  "createdAt": "string",
  "endpoint": "string",
  "id": "string",
  "items": [
    null
  ],
  "keys": [
    null
  ],
  "name": "string",
  "productId": "string",
  "status": "string",
  "type": "string",
  "updatedAt": "string",
  "webhookHealth": {
    "lastDeliveryAt": "string",
    "recentFailures": [
      {
        "at": "string",
        "reason": "string",
        "statusCode": 1.1
      }
    ]
  },
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "path": "string",
      "severity": "warning",
      "suggestedFix": "string"
    }
  ]
}

Create a new surface for a product.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringRequired1-255 characters

typeenumRequired

behavioranyOptional

configanyOptional

inboundmap from strings to anyOptional

outboundmap from strings to anyOptional

statusenumOptional

Allowed values:

Response

Surface created

createdAtstring

endpointstring or null

Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, …). Clients should use this instead of constructing the URL themselves.

idstring

itemslist of any

keyslist of any

namestring

productIdstring

statusstring

typestring

updatedAtstring

webhookHealthobject

behavioranyOptional

inboundanyOptional

outboundanyOptional

warningslist of objectsOptional

Advisory findings about this surface configuration. Present only when non-empty; never blocks the mutation.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error