Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude
API/schemas
Schema

StepExample

One attached example file on a step. Examples are resolved at cycle launch — the runtime fetches the file's extracted preview (filename, page_count, first chunk) and injects it into the LLM prompt or step input bag depending on role. ``input_hint`` is meant to bias chunking / structure inference; ``reference`` is documentation the step can cite; ``schema_sample`` is a representative input the agent should accept in production.

FieldTypeDescription
file_idrequiredstring (uuid)platform.file_uploads.file_id reference
filenamerequiredstringCached filename for UI
sizeinteger | nullCached file size in bytes
role"input_hint" | "reference" | "schema_sample"Why this example is attached to the step.
input_hintreferenceschema_sample
tagsstring[]Per-attachment tags (e.g. 'coutts', 'valuation-report', 'fy25').
notesstring | nullFree-text notes from the step author.