Skip to main content
POST
Create custom surface

Authorizations

Authorization
string
header
required

Bearer token authentication via Auth0. Users authenticate through Auth0 Universal Login. Include the access token in the Authorization header: Authorization: Bearer <token>

Path Parameters

workspaceId
string<uuid>
required

Body

application/json
surface_key
string
required
Pattern: ^[a-z][a-z0-9_]{1,48}[a-z0-9]$
display_name
string
required
constraints
object

Response

Surface created

surface
object
Last modified on March 19, 2026