Preview Template

GET

/api/canvas/templates/{template_id}/preview

curl --request GET \
  --url https://example.com/api/canvas/templates/example/preview \
  --header 'Authorization: Bearer <token>'

Preview a template’s section structure without applying it.

Authorizations

• HTTPBearer

Parameters

Path Parameters

template_id

required

Template Id

string

Responses

200

Successful Response

Media type application/json

Example ^generated

example

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}