Skip to content
Documentation

Documentation

Everything you need to get started with PromptOT. Learn how to manage, version, and deliver structured prompts via API.

Quick Start

Up and running in 4 steps

From sign-up to your first API call in minutes.

01

Create a Prompt

Sign up, create a project, and add your first prompt. Projects organize prompts by team or application.

02

Add Blocks

Structure your prompt with typed blocks: role, context, instructions, guardrails, output_format, and custom. Drag to reorder.

03

Publish a Version

Lock in your prompt version for production use. Versions are immutable snapshots you can roll back to at any time.

04

Fetch via API

Get your compiled prompt with a single API call. Variables are resolved at fetch time with the values you pass.

bash
$ curl "https://api.promptot.com/api/v1/prompts/my-prompt/compiled" \
-H "Authorization: Bearer pk_live_abc123..."
Core Concepts

How PromptOT works

Understand the building blocks of structured prompt management.

Blocks

Typed sections (role, context, instructions, guardrails, output_format, custom) that compose into a prompt. Each block has a title, content, type, and sort order.

Compilation

Blocks are filtered (enabled only), sorted by sort_order, and joined as ## Title sections into a single prompt string ready for your LLM.

Variables

Use {{key}} syntax in block content. Variables are resolved at fetch time with values you pass in the API call.

Versions

Publish immutable versions of your prompt. Production API keys always return the published version; development keys return the latest draft.

API Keys

Generate keys scoped to environments (production/development). Keys are hashed with SHA-256 — we never store the raw key.

Webhooks

Get notified when prompts are published, updated, or deleted. Payloads are signed with HMAC-SHA256 for verification.