Create modal

curl --request POST \
  --url https://api.lithoblocks.com/v1/modals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "blocks": [
    {
      "type": "<string>",
      "id": "<string>"
    }
  ],
  "description": "<string>",
  "submit_label": "Submit",
  "close_label": "Cancel",
  "sample_data": {},
  "activate": false
}
'

import requests

url = "https://api.lithoblocks.com/v1/modals"

payload = {
    "name": "<string>",
    "title": "<string>",
    "blocks": [
        {
            "type": "<string>",
            "id": "<string>"
        }
    ],
    "description": "<string>",
    "submit_label": "Submit",
    "close_label": "Cancel",
    "sample_data": {},
    "activate": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    title: '<string>',
    blocks: [{type: '<string>', id: '<string>'}],
    description: '<string>',
    submit_label: 'Submit',
    close_label: 'Cancel',
    sample_data: {},
    activate: false
  })
};

fetch('https://api.lithoblocks.com/v1/modals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lithoblocks.com/v1/modals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'title' => '<string>',
    'blocks' => [
        [
                'type' => '<string>',
                'id' => '<string>'
        ]
    ],
    'description' => '<string>',
    'submit_label' => 'Submit',
    'close_label' => 'Cancel',
    'sample_data' => [
        
    ],
    'activate' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lithoblocks.com/v1/modals"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"submit_label\": \"Submit\",\n  \"close_label\": \"Cancel\",\n  \"sample_data\": {},\n  \"activate\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lithoblocks.com/v1/modals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"submit_label\": \"Submit\",\n  \"close_label\": \"Cancel\",\n  \"sample_data\": {},\n  \"activate\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lithoblocks.com/v1/modals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"submit_label\": \"Submit\",\n  \"close_label\": \"Cancel\",\n  \"sample_data\": {},\n  \"activate\": false\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "title": "<string>",
  "submit_label": "<string>",
  "close_label": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_multi_step": true,
  "created_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "steps": null,
  "current_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modal_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "blocks": [
      {}
    ],
    "placeholder_mapping": {},
    "status": "draft",
    "is_current": true,
    "created_by": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "sample_data": null
  },
  "version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modal_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "blocks": [
      {}
    ],
    "placeholder_mapping": {},
    "status": "draft",
    "is_current": true,
    "created_by": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "sample_data": null
  }
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "success": false,
  "error": {
    "issues": [
      {
        "code": "<string>",
        "path": [
          "<string>"
        ],
        "message": "<string>"
      }
    ],
    "name": "<string>"
  },
  "message": "<string>",
  "code": "validation_failed",
  "request_id": "<string>"
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

POST

modals

Create modal

curl --request POST \
  --url https://api.lithoblocks.com/v1/modals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "blocks": [
    {
      "type": "<string>",
      "id": "<string>"
    }
  ],
  "description": "<string>",
  "submit_label": "Submit",
  "close_label": "Cancel",
  "sample_data": {},
  "activate": false
}
'

import requests

url = "https://api.lithoblocks.com/v1/modals"

payload = {
    "name": "<string>",
    "title": "<string>",
    "blocks": [
        {
            "type": "<string>",
            "id": "<string>"
        }
    ],
    "description": "<string>",
    "submit_label": "Submit",
    "close_label": "Cancel",
    "sample_data": {},
    "activate": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    title: '<string>',
    blocks: [{type: '<string>', id: '<string>'}],
    description: '<string>',
    submit_label: 'Submit',
    close_label: 'Cancel',
    sample_data: {},
    activate: false
  })
};

fetch('https://api.lithoblocks.com/v1/modals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lithoblocks.com/v1/modals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'title' => '<string>',
    'blocks' => [
        [
                'type' => '<string>',
                'id' => '<string>'
        ]
    ],
    'description' => '<string>',
    'submit_label' => 'Submit',
    'close_label' => 'Cancel',
    'sample_data' => [
        
    ],
    'activate' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lithoblocks.com/v1/modals"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"submit_label\": \"Submit\",\n  \"close_label\": \"Cancel\",\n  \"sample_data\": {},\n  \"activate\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lithoblocks.com/v1/modals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"submit_label\": \"Submit\",\n  \"close_label\": \"Cancel\",\n  \"sample_data\": {},\n  \"activate\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lithoblocks.com/v1/modals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\",\n  \"submit_label\": \"Submit\",\n  \"close_label\": \"Cancel\",\n  \"sample_data\": {},\n  \"activate\": false\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "title": "<string>",
  "submit_label": "<string>",
  "close_label": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_multi_step": true,
  "created_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "steps": null,
  "current_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modal_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "blocks": [
      {}
    ],
    "placeholder_mapping": {},
    "status": "draft",
    "is_current": true,
    "created_by": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "sample_data": null
  },
  "version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modal_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "blocks": [
      {}
    ],
    "placeholder_mapping": {},
    "status": "draft",
    "is_current": true,
    "created_by": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "sample_data": null
  }
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "success": false,
  "error": {
    "issues": [
      {
        "code": "<string>",
        "path": [
          "<string>"
        ],
        "message": "<string>"
      }
    ],
    "name": "<string>"
  },
  "message": "<string>",
  "code": "validation_failed",
  "request_id": "<string>"
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "code": "unauthenticated",
  "request_id": "<string>",
  "message": "<string>",
  "details": "<string>",
  "error_details": "<string>",
  "success": false,
  "valid": false,
  "required_scopes": [
    "<string>"
  ],
  "user_scopes": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

LithoBlocks API key obtained from your organization dashboard. The LithoBlocks MCP server also presents a Supabase-issued user session token here on the user's behalf; such a token acts as that user with the scopes their organization role allows.

Headers

Idempotency-Key

string

Any unique string (a UUID is fine). Repeating a request with the same key and body within 24 hours replays the original response with Idempotency-Replayed: true instead of running again; the same key with a different body is a 409. Incomplete and 5xx outcomes are retained for reconciliation beyond 24 hours. Applies only on the documented endpoints. Never automatically change keys to bypass an uncertain outcome.

Required string length: 1 - 255

Example:

"3f7d2c1a-9b4e-4f0a-8c6d-2e1b5a7c9d10"

Body

application/json

Operation input

name

string

required

Required string length: 1 - 255

title

string

required

Required string length: 1 - 24

blocks

object[]

required

Required array length: 1 - 100 elements

Show child attributes

description

string | null

Maximum string length: 2000

submit_label

string

default:Submit

Required string length: 1 - 24

close_label

string

default:Cancel

Required string length: 1 - 24

sample_data

object

Show child attributes

activate

boolean

default:false

Response

Operation result

name

string

required

Required string length: 1 - 255

title

string

required

Required string length: 1 - 24

submit_label

string | null

required

close_label

string | null

required

string<uuid>

required

organization_id

string<uuid>

required

current_version_id

string<uuid> | null

required

is_multi_step

boolean | null

required

created_by

string

required

created_at

string | null

required

updated_at

string | null

required

description

string | null

Maximum string length: 2000

steps

unknown

current_version

object | null

Show child attributes

version

object

Show child attributes