Skip to content

Entity References

Many CLI options and API parameters accept entity references—a consistent string format for referring to entities (and optionally a sub-resource) across the platform.

Format

[workspace/]entity_name[#fragment]
Part Required Description
workspace No Workspace name. If omitted, the workspace is taken from your current context (CLI --workspace, SDK client, or request).
entity_name Yes The entity's unique name within the workspace.
#fragment No Optional entity-specific path or parameters (e.g. a file path within a fileset).

Examples

  • default/my-fileset — Fileset named my-fileset in workspace default.
  • my-fileset — Same entity when your current context already specifies the workspace.
  • prod/my-fileset#data/training.parquet — A specific path inside that fileset (when the entity type supports fragments).

Can use the full form workspace/entity_name to keep the reference unambiguous regardless of context.