Skip to main content
POST
/
api
/
templates
/
html
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "external_id": "<string>",
  "folder_name": "<string>",
  "source": "<string>",
  "shared": true,
  "download_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "schema": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "submitter_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "required": true,
      "readonly": true,
      "key": "<string>",
      "default_value": "<string>",
      "placeholder": "<string>",
      "pattern": "<string>",
      "options": [
        "<string>"
      ],
      "formula": "<string>",
      "areas": [
        {
          "x": 123,
          "y": 123,
          "w": 123,
          "h": 123,
          "page": 123,
          "attachment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "preferences": {}
    }
  ],
  "submitters": [
    {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "preferences": {},
  "documents": [
    {
      "id": 123,
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filename": "<string>",
      "page_count": 123,
      "page_dimensions": [
        {
          "width": 123,
          "height": 123
        }
      ],
      "url": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.spitshake.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Body

application/json
html
string
required

HTML content with field tags

name
string

Response

200 - application/json

Created template

id
string

Public template ID (e.g. tpl_AbC123...)

name
string
slug
string
external_id
string | null
folder_name
string | null
source
string
shared
boolean
download_url
string

URL to download the full template PDF bundle

created_at
string<date-time>
updated_at
string<date-time>
schema
object[]

Field definitions with positioning

submitters
object[]
preferences
object
documents
object[]