Skip to main content

Step

A step is a "how it works" card. Display only. Despite the name, it is not part of an execution pipeline, workflow definition, or state machine.

Schema (agent_steps)

ColumnTypeNotes
idUUIDPK
agentIdUUIDFK → agents
titletextShort heading
descriptiontextOne-sentence body
sortOrderintRender order, ascending

Endpoints

VerbPathGuard
GET/agents/:agentId/stepspublic
POST/agents/:agentId/stepsplatform_admin
PATCH/agents/:agentId/steps/:idplatform_admin
DELETE/agents/:agentId/steps/:idplatform_admin

DTO

type StepDto = {
id: string;
title: string;
description: string;
sortOrder: number;
};

Idiomatic copy

The frontend renders these as a 3-or-4-up horizontal strip. Keep titles ≤ 25 characters and descriptions ≤ 100 — anything longer wraps awkwardly on mobile.