Skip to main content

apiome spec

Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.

apiome spec​

Export reconstructed OpenAPI/Arazzo specs.

apiome spec [OPTIONS] COMMAND [ARGS]...

Subcommands: download-original, export.

apiome spec download-original​

Download original import bytes. With --output -, document bytes are written to stdout; --json metadata is written to stderr so stdout stays byte-safe for pipelines.

apiome spec download-original [OPTIONS]

Options

OptionTypeDefaultRequiredDescription
--import-idtextyesProject version UUID that owned the original import artifact.
--output, -otextyesDestination file path, or - for stdout (artifact bytes only).

apiome spec export​

Export reconstructed OpenAPI or Arazzo. With --output -, document bytes are written to stdout; --json metadata is written to stderr so stdout stays byte-safe for pipelines.

apiome spec export [OPTIONS]

Options

OptionTypeDefaultRequiredDescription
--projecttextyesProject UUID or slug.
--versiontextyesVersion UUID, slug, or label.
--formattextopenapiExport format: openapi or arazzo.
--output, -otextyesDestination file path, or - for stdout (document bytes only).
--tenanttextTenant UUID or slug (overrides APIOME_TENANT_ID). Required for browse export.
--yamlflagRequest YAML serialization (default JSON). Alias for --accept yaml.
--accepttextResponse serialization: json or yaml (REST accept query; default json).