Local editor setup

When you edit Cloudomation flows or export YAML files in a local editor (VS Code, Cursor, PyCharm, etc.), you can download developer artifacts from your workspace to get Python IntelliSense for flow_api and JSON Schema validation for export and connector files.

Artifacts are generated for your workspace version. Re-download them after upgrading your workspace.

What you can download

Artifact	REST endpoint	Purpose
flow_api typings	GET /api/latest/flow_api/typings	Python IntelliSense for flow scripts
Export schemas	GET /api/latest/schemas/export	Validate *.flow.yaml, *.connector.yaml, etc.
Connector schemas	GET /api/latest/schemas/connectors	Validate connector input/output values
Index	GET /api/latest/developer-artifacts	Lists all endpoints and recommended layout
Form meta-schema	GET /api/latest/formSchema.json	Cloudomation form-* extensions (also bundled at schemas/formSchema.json in zips)

All authenticated endpoints accept the same credentials as the REST API (session cookie, bearer API key, or x-cloudomation-api-key header).

Append ?format=zip to download a ready-to-extract archive instead of JSON.

Recommended directory layout

Extract downloads into a .cloudomation/ folder in your project root:

.cloudomation/
  flow_api/                    # Python typings
  schemas/
    formSchema.json            # form-* meta-schema (bundled in zips)
    export/
      manifest.json
      resource-types/
        flow.schema.json
        connector.schema.json
        ...
      references/              # FK reference objects (project_id_project, ...)
      subrecords/              # plain_list item schemas
    connectors/
      manifest.json
      REST.input.schema.json
      REST.input.stored.schema.json   # stored connector value (no required fields)
      ...
  editor-config/
    vscode-settings.snippet.json
    pyrightconfig.snippet.json

Download (manual)

Replace <your-workspace> and set your API key:

export CLOUDOMATION_API_KEY="cldm_<prefix>_<secret>"
export BASE="https://<your-workspace>.cloudomation.com/api/latest"
export AUTH="Authorization: Bearer $CLOUDOMATION_API_KEY"

mkdir -p .cloudomation && cd .cloudomation

# Zip downloads (recommended)
curl -sS -H "$AUTH" "$BASE/flow_api/typings?format=zip" -o flow_api.zip && unzip -o flow_api.zip
curl -sS -H "$AUTH" "$BASE/schemas/export?format=zip" -o export-schemas.zip && unzip -o export-schemas.zip
curl -sS -H "$AUTH" "$BASE/schemas/connectors?format=zip" -o connector-schemas.zip && unzip -o connector-schemas.zip

JSON responses are also available without ?format=zip if you prefer to write files selectively.

VS Code / Cursor

Create or merge .vscode/settings.json in your project root:

{
  "python.analysis.extraPaths": [".cloudomation"],
  "yaml.schemas": {
    "./.cloudomation/schemas/export/resource-types/flow.schema.json": "**/*.flow.yaml",
    "./.cloudomation/schemas/export/resource-types/connector.schema.json": "**/*.connector.yaml"
  }
}

Add further yaml.schemas entries from .cloudomation/schemas/export/manifest.json (yaml_schema_mappings — prefix each key with ./.cloudomation/).

For flow scripts (*.flow-script.py), Pylance/Pyright uses the flow_api typings via python.analysis.extraPaths.

Optional: copy .cloudomation/editor-config/pyrightconfig.snippet.json to pyrightconfig.json in the project root.

Install the YAML extension for schema validation on export files.

PyCharm

1. Download and extract artifacts into .cloudomation/ as above.
2. Open Project Structure → Sources and mark .cloudomation as a Sources Root (so import flow_api resolves).
3. For YAML validation, configure file patterns in an external JSON Schema tool or use the manifest mappings with a compatible plugin.

Pyright CLI / mypy

// pyrightconfig.json
{
  "extraPaths": [".cloudomation"]
}

For mypy: MYPYPATH=.cloudomation mypy your-flow-script.py

Agent-driven setup (Cursor, etc.)

If you use an MCP-connected agent (see MCP server), ask it to follow the Local editor setup (agent-driven) section in the cloudomation://usage-guide resource. The agent can download the zips, extract them, and merge editor settings for you.

Limitations

• Artifacts match your workspace major version. Export files may not validate across major releases.
• Cloudomation connector schemas use form-* element types. Standard JSON Schema validators understand the structure but may not match Engine validation exactly; use the bundled schemas/formSchema.json (referenced via $schema on form nodes and on record input_schema / output_schema fields).
• Export schemas model foreign-key references as separate files under schemas/export/references/ and plain-list subrecords under schemas/export/subrecords/. Keep the full zip layout intact so $ref paths resolve.
• Connector export files validate metadata via export schemas. The value field is validated conditionally based on connector_type, using *.input.stored.schema.json (stored connectors do not require all input fields).

Import / export file format

MCP server