API referenceV1
Describe what ops can change, one topic at a time
One slice of the catalogue, generated from the builder's own registries: `workflow` (the steps from a brief to a finished form), `ops`, `blocks`, `settings` and `settings:<section>`, `looks`, `pieces`, `zones`, `motion`, `fonts` and `fonts:<category>`, `backgrounds`, `media`. Settings the plan does not include are marked `locked`.
AuthorizationBearer <token>
A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.
In: header
Path Parameters
topic*string
Value in
- "workflow"
- "ops"
- "blocks"
- "settings"
- "settings:design"
- "settings:display"
- "settings:agent_persona"
- "settings:agent_goal"
- "settings:guardrails"
- "settings:access"
- "settings:closing"
- "settings:completion"
- "settings:sharing"
- "settings:embed"
- "settings:form"
- "looks"
- "pieces"
- "zones"
- "motion"
- "fonts"
- "fonts:sans"
- "fonts:serif"
- "fonts:display"
- "fonts:handwriting"
- "fonts:mono"
- "backgrounds"
- "media"
Query Parameters
form_id?string
With a form, settings carry their current value.
Length
length <= 64Response Body
application/json
application/json
curl -X GET "https://example.com/v1/describe/workflow"{ "topic": "string", "property1": null, "property2": null}