STATEK
API Reference
Prompts

Prompts

Prompt APIs parse prompt files into structured system prompts with optional metadata and difficulty-targeted sections.

SymbolImport pathPurposeStability
PromptDefstatek.prompt_config or statekPrompt metadata plus system promptCore
SystemPrompt, SystemPromptDatastatek.prompt_configPersistent and volatile prompt structuresCore
PromptStylestatek.prompt_configOutput section style enumCore
parse_system_promptstatek.prompt_configParse raw prompt textCore
make_system_promptstatek.prompt_configConvert raw or parsed prompt to persistent formCore
format_system_promptstatek.prompt_configFormat for a task difficultyCore
parse_prompt_file, load_prompt_filesstatek.prompt_configLoad prompt .md filesCore
update_prompt_configstatek.prompt_config or statekApply prompt defs to agents and job defsCore operational

Data classes

@dataclass
class PromptSectionData:
    title: str
    contents: str
    target_difficulties: set[TaskDifficulty] | None = None
 
@dataclass
class SystemPromptData:
    intro: str
    sections: list[PromptSectionData]
 
@db0.memo
@dataclass
class PromptSection:
    title: str
    contents: str
    target_difficulties: set[TaskDifficulty] | None = None
 
@db0.memo
@dataclass
class SystemPrompt:
    intro: str
    sections: list[PromptSection]

PromptDef contains system prompt data and metadata parsed from prompt files.

PromptStyle

PromptStyle.XML
PromptStyle.DASHED
PromptStyle.ASTERISK
PromptStyle.MARKDOWN

Controls how prompt sections are formatted for a model request.

Parse and format helpers

FunctionSignatureReturnsErrors
parse_system_promptparse_system_prompt(input: str)SystemPromptDataValueError for invalid difficulty labels.
make_system_promptmake_system_prompt(prompt)SystemPromptPropagates parse errors for raw text.
format_system_promptformat_system_prompt(prompt, task_difficulty, style=PromptStyle.DASHED, section_formatter=None, prompt_part_formatter=None)strValueError for invalid XML section titles or unsupported style.
compare_promptscompare_prompts(prompt_1, prompt_2)boolNone documented.
parse_prompt_fileparse_prompt_file(file_path: Path)PromptDefValueError when # System Prompt is missing.
load_prompt_filesload_prompt_files(prompt_files_dir: str)dict[str, PromptDef]Returns {} for missing or empty directory.
update_prompt_configupdate_prompt_config(prompt_defs, agents=None)NonePropagates metadata parsing errors.
# MODEL: openai/gpt-5-mini
 
# System Prompt
You are a concise analyst.
 
## MH: Review checklist
Check the supplied data before answering.
from pathlib import Path
 
from statek.prompt_config import parse_prompt_file
 
prompt_def = parse_prompt_file(Path("prompts/analyst.md"))
agent.update_system_prompt(prompt_def.system)
agent.update_metadata(prompt_def.metadata)

Related APIs: Prompt Definitions, Agents, Settings.