Skip to main content
GET
/
api
/
embed
/
template
/
{id}
Error
A valid request URL is required to generate request examples
{
  "template": {
    "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>"
      }
    ]
  },
  "options": {}
}

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

Authorization
string
header
required

JWT token for Embed API endpoints

Path Parameters

id
integer
required

Response

200 - application/json

Template data for embedded builder

template
object
options
object