LithoBlocks

Showing 25 of 65 from the live probe.

• Describe a template's input

  What `data` a compile or send of this template takes: every path it reads, with a label, a type from the version's sample data, whether it is a list a loop needs, and nesting for dotted paths, plus the same tree as JSON Schema. Use it before compile_template or send_template_message to build `data` correctly; request_format lists the same paths without types.

• List templates

  List the organization's message templates: id, name, description, visibility, current version id and timestamps. Expansions are opt-in and expensive; fetch one template with get_template when you need its message.

• Get a template

  Fetch one template by id, with its current version's message and sample data when requested.

• Search templates

  Full-text search over templates by name and content. Returns matches ranked by match_score.

• List template versions

  List the versions of a template, newest first, with version_number, status and whether each is current.

• Get a template version

  Fetch one version of a template, including its full block message and sample data.

• List entities

  List an organization's entities (the reusable data shapes templates bind to). Get organization_id from get_my_profile.

• Get an entity

  Fetch one entity with its fields.

• Search entities

  Search entities by name, description and field names. Returns matches with the fields that matched.

• Get credit balance

  The organization's remaining message credits. Sends spend credits; check before a bulk send.

• List usage logs

  Credit usage history: which template was sent, credits used, remaining balance and delivery status, newest first.

• Get organization

  Organization details: name, status, member count and credit balance.

• List organization members

  The organization's members and their roles.

• Get my profile

  The profile behind the credentials in use, including organization_id, which the organization, entity and credit tools need. Call this first.

• Get the block schema

  What the platform accepts in a template: block types, directives and #if operators, placeholder syntax, Slack's text limits. Read this before authoring blocks.

• Validate template blocks

  Check compilation and interactivity against sample_data without saving or spending credits. Returns validation errors, request format, warnings and interactivity diagnostics, with no rendered Slack output. Iterate here until valid, then create_template. Use compile_template to obtain rendered output; it spends a credit.

• Create a template

  Create a template and its first version in one step. The blocks must compile against sample_data or nothing is created. The version is a draft unless activate is true, which makes it what sends use immediately and needs the templates:activate scope.

• Update template metadata

  Rename a template or change its icon, display name or type. Blocks live in versions; use create_template_version for those.

• Create a template version

  Add a new version of a template's blocks. It is a draft until activate_template_version makes it current; sends keep using the current version until then.

• Activate a template version

  Make a version the one sends use. Irreversible in effect: every send after this, from any integration, posts the new version.

• Compile a template

  Render a template's current version with data to Slack Block Kit without posting it. Spends one credit. Returns a text rendering, counts and warnings; set include_blocks for the Block Kit JSON.

• Send a template message to Slack

  Post a template, rendered with data, to one Slack destination. Exactly one of channel_id, recipient_email or recipient_slack_id. Posts a real message and spends one credit; compile_template first if unsure.

• Send a template message to many Slack destinations

  Post one rendered template to 1–100 destinations. Each destination: Exactly one of channel_id, recipient_email or recipient_slack_id. Posts real messages and spends one credit per success.

• Update an entity

  Rename an entity or change its description. Fields are updated with update_entity_field.

• Delete an entity

  Delete an entity and all of its fields. Irreversible.