Get started · Glossary
Glossary
Every term these docs use, defined in a sentence. Where the code or the dashboard uses a different word for the same thing, it is listed too — so arriving with the wrong word still gets you to the right page.
Two words worth settling now
Workspace, not organization — an organization is a workspace whose kind is organization. And workflow, not template, except in the field name templateId, where the API says template and always will.
- Artifact
- What a run produced, stored durably with its QA record, cost ledger, and a link back to the run that made it. Files live in object storage; the artifact is the record around them.
- Artifact class
- The broad family of an output:
visual,research,video, orknowledge. Declared by the workflow, not chosen per run. - Artifact schemaalso: artifactSchema
- The output half of a workflow’s contract — the artifact class and type it produces, the file types, and the metadata it promises to fill in.
- Budget
- A spend limit attached to a workspace, project, or workflow, with a period and an enforcement mode. Checked before a run starts, using the estimate.
- Capability flag
- A declared fact about a model in the registry — for example
supports_native_transparency. The engine reads these to choose a mechanism, so you never have to. - Collectionalso: collective artifact, pack
- One named thing made of many artifacts — a clip art pack, a story book — whose members keep their ids through every re-roll. Esy owns it; an order is one batch of work toward it, never the collection itself.
- Cost ledgeralso: provider_cost_ledger
- One immutable row per provider call, carrying the model, the quantity, the unit price, and which of the three cost states it is in.
- Cost state
- Where a ledger row is in its life:
estimated→provider_reported→reconciled. There are three, not four. - Gate
- A judgement between steps. A quality gate is automatic; an approval gate parks the run in
reviewfor a human. A gate never runs work — it declares which step itunlocks. - Generation Orderalso: order
- One template fanned out into N child runs with a variation spec, a dedupe key, and its own budget cap.
- Intake
- The inputs you hand a run. Constrained by the workflow’s
intakeSchema, and validated before anything is spent. - Intake schemaalso: intakeSchema
- The input half of a workflow’s contract: each field’s name, type, whether it is required, its default, and its allowed values.
- Project
- An optional grouping inside a workspace so runs, artifacts, and costs roll up somewhere meaningful. A “brand” is a project with a brand profile attached.
- Provenance
- The record of how an artifact came to exist: the pinned workflow version, the resolved prompt, the models used, the mechanism chosen, and which credential started the run.
- Provider
- Whoever actually performs a step — OpenAI, Anthropic, fal.ai, or an in-house tool like
esy/chroma-key. - Provider bindingalso: providers
- The workflow’s map from a role to a concrete model id. Two roles may share one model. A run can override a binding for itself.
- Review queue
- Everything waiting on a human decision. It is a view over runs whose status is
review, not a separate table. - Role
- What a step needs, named abstractly —
imageGenerator,classifier,textGate. Roles let you change models without editing steps. - Run
- One execution of one workflow, with per-step telemetry, costs, and a terminal status.
- Specalso: specVersionHash, the frozen spec
- The exact workflow definition plus intake a run executed, hashed and pinned at creation. It is what makes a run reproducible after the workflow changes.
- Stepalso: runtime step
- One unit of work inside a workflow. Its
kindisllm,image,tool,subWorkflow,agent, orcode. - Sub-workflow
- A step that runs another workflow as a child run, pinning the child’s version and rolling its cost up into the parent.
- Templatealso: templateId
- The everyday word for a workflow, and the field name you pass when creating a run. The API object is a workflow;
templateIdis its slug. - Typed hold
- A review hold that declares exactly which fields a reviewer must supply to release it. Supplying more or fewer is refused.
- Workflow
- The versioned definition a run executes: intake schema, runtime steps, provider bindings, gates, budget policy, and artifact schema.
- Workflow version
- An immutable snapshot of a workflow definition. Versions are append-only; a movable pointer decides which one is live.
- Workspacealso: organization
- The top-level boundary for billing, membership, and everything inside it. Its
kindisorganizationorpersonal— an “organization” is a workspace, not a separate object.