V1 - Workflows

Public Export Workflow

Export a workflow and all its dependencies.

Returns an export file (v4 plaintext YAML by default, v3 base64 on request) that can be imported later.

post/v1/workflows/{workflow_id}/export

Request

  • Base URL
    https://api.app.noxus.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-Key

Path parameters

workflow_idstring required

Query parameters

version_idstring nullable
version'auto' | 'v3' | 'v4'

Wire format for an export/import payload.

  • auto (default both directions): export emits the default format (currently v3 base64, for back-compat with existing pipelines); import detects the format from the payload content.
  • v4: plaintext multi-doc YAML (.nx) — opt-in, requested on purpose.
  • v3: legacy base64-encoded bundle.

Export wire format. auto (default) emits the legacy base64-encoded bundle for back-compat; pass v4 for plaintext multi-doc YAML (.nx), or v3 for base64 explicitly.

set_active_on_importboolean
include_dependenciesboolean

Bundle referenced sub-flows / KBs / files into the .nx.

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.