apiome export

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

apiome export

Export a version to a target format via the emitter registry. Registered targets are also invokable as export <format> <artifact> (async job + poll). export evidence --json returns the machine-readable projection evidence (snapshot hash, status/reason counts, per-construct rows). A lossy/types-only export exits non-zero without --force, and a job whose acknowledged preview snapshot no longer matches fails with STALE_PREVIEW — re-preview and acknowledge the current snapshot.

apiome export [OPTIONS] COMMAND [ARGS]...

Subcommands: asyncapi, avro, evidence, graphql, grpc, openapi, preflight, targets.

apiome export asyncapi

Export a version as AsyncAPI 3 + a fidelity report. With --output -, document bytes are written to stdout; the fidelity summary and --json metadata are written to stderr so stdout stays byte-safe for pipelines.

apiome export asyncapi [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--output, -o	text		yes	Destination file path, or - for stdout (document bytes only).
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).
--yaml	flag			Request YAML serialization (default JSON). Alias for --accept yaml.
--accept	text			Response serialization: json or yaml (default json).
--force	flag			Write and exit 0 even when the export loses fidelity (lossy/types-only).
--min-grade	text			Fail when the lint grade is worse than this (A best, F worst). Exits 4 when the threshold is missed.
--fail-on	text			Fail when the lint report has any finding at or above this severity (error, warning, info). Exits 4 when the threshold is missed.

apiome export avro

Export a version as Avro .avsc + a fidelity report. With --output -, document bytes go to stdout; fidelity summary and --json metadata go to stderr.

apiome export avro [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--output, -o	text		yes	Destination file path, or - for stdout (document bytes only).
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).
--force	flag			Write and exit 0 even when the export loses fidelity (lossy/types-only).
--min-grade	text			Fail when the lint grade is worse than this (A best, F worst). Exits 4 when the threshold is missed.
--fail-on	text			Fail when the lint report has any finding at or above this severity (error, warning, info). Exits 4 when the threshold is missed.

apiome export evidence

Page through source→target projection evidence for one configured export.

apiome export evidence [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--target	text		yes	Target emitter key (e.g. openapi) or format key (e.g. openapi-3.1).
--version	text			Version UUID, slug, or label (default: latest revision).
--option	text (repeatable)			Per-target emit option as key=value (repeatable). Folded into the snapshot hash — different options are a different snapshot.
--cursor	text			Opaque cursor from a previous page (default: first page).
--limit	integer range			Maximum evidence rows per page (server clamps to its hard cap).
--redact-source	flag			Deprecated no-op (EFP-3.2): REST always redacts source-native evidence.
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).

apiome export graphql

Export a version as GraphQL SDL + a fidelity report. With --output -, document bytes go to stdout; fidelity summary and --json metadata go to stderr.

apiome export graphql [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--output, -o	text		yes	Destination file path, or - for stdout (document bytes only).
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).
--force	flag			Write and exit 0 even when the export loses fidelity (lossy/types-only).
--min-grade	text			Fail when the lint grade is worse than this (A best, F worst). Exits 4 when the threshold is missed.
--fail-on	text			Fail when the lint report has any finding at or above this severity (error, warning, info). Exits 4 when the threshold is missed.

apiome export grpc

Export a version as proto3 (.proto) + a fidelity report. With --output -, document bytes go to stdout; fidelity summary and --json metadata go to stderr.

apiome export grpc [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--output, -o	text		yes	Destination file path, or - for stdout (document bytes only).
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).
--force	flag			Write and exit 0 even when the export loses fidelity (lossy/types-only).
--min-grade	text			Fail when the lint grade is worse than this (A best, F worst). Exits 4 when the threshold is missed.
--fail-on	text			Fail when the lint report has any finding at or above this severity (error, warning, info). Exits 4 when the threshold is missed.

apiome export openapi

Export a version as OpenAPI + a fidelity report. With --output -, document bytes are written to stdout; the fidelity summary and --json metadata are written to stderr so stdout stays byte-safe for pipelines.

apiome export openapi [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text		yes	Version UUID, slug, or label.
--output, -o	text		yes	Destination file path, or - for stdout (document bytes only).
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).
--yaml	flag			Request YAML serialization (default JSON). Alias for --accept yaml.
--accept	text			Response serialization: json or yaml (default json).
--force	flag			Write and exit 0 even when the export loses fidelity (lossy/types-only).
--min-grade	text			Fail when the lint grade is worse than this (A best, F worst). Exits 4 when the threshold is missed.
--fail-on	text			Fail when the lint report has any finding at or above this severity (error, warning, info). Exits 4 when the threshold is missed.

apiome export preflight

Rank every export target for one revision — source lint, projected fidelity, capability fit, and the tenant quality-policy verdict. Nothing is emitted and no export job is created. Gate exit codes: 3 = tenant quality policy blocked, 4 = --min-grade/--fail-on threshold missed, 5 = nothing gradable (candidate unimportable / no usable target). These are distinct from transport (1) and usage/auth (2) failures.

apiome export preflight [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project (artifact) UUID or slug to rank targets for.
--version	text			Revision UUID, slug, or version label (default: latest revision).
--to	text (repeatable)			Restrict the ranking to this target key (openapi) or format key (openapi-3.1). Repeatable; omit to rank every registered target.
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).
--min-grade	text			Fail when the lint grade is worse than this (A best, F worst). Exits 4 when the threshold is missed.
--fail-on	text			Fail when the lint report has any finding at or above this severity (error, warning, info). Exits 4 when the threshold is missed.

apiome export targets

List the emitter registry targets + fidelity for a version.

apiome export targets [OPTIONS]

Options

Option	Type	Default	Required	Description
--project	text		yes	Project UUID or slug.
--version	text			Version UUID, slug, or label (default: latest revision).
--tenant	text			Tenant UUID or slug (overrides APIOME_TENANT_ID).