Elements runtime reference / Request artifacts

`writeFile`

Write a request-scoped Element artifact file through the parent data-worker-agent process.

Terug naar builtin index Signatuur Payloadformaat Voorbeeld Scope-notities

Signatuur

writeFile(path, content=None, data=None, dataBase64=None, rows=None, format=None, bucket=None, prefix=None, contentType=None, encoding=None, overwrite=False, metadata=None)

Doel

Write a request-scoped Element artifact file through the parent data-worker-agent process.

Aliases and imports

write_file
files.write
files.write_file

Payloadformaat

Use these fields as the Python call arguments or keyword payload for this helper.

{
  "path": "exports/preview.json",
  "data": {
    "title": "Preview",
    "rows": 3
  },
  "format": "json",
  "overwrite": false,
  "metadata": {
    "source": "element"
  }
}

Field	Description
`path`	Relative artifact path for this Element request.
`content/data/dataBase64/rows`	Payload to write. Rows can be serialized using format.
`format`	Optional json, ndjson, csv, parquet, text, or inferred format.
`bucket/prefix`	Optional worker-controlled artifact bucket/prefix override; arbitrary buckets and traversal are rejected.
`contentType/encoding`	Optional content type and text encoding.
`overwrite`	When false, existing objects are not overwritten.
`metadata`	Optional JSON-serializable metadata stored with the artifact.

Return payload

{
  "uri": "gs://dashview-cache/data-worker-agent/files/tenant/request/exports/preview.json",
  "path": "exports/preview.json",
  "contentType": "application/json",
  "size": 31,
  "format": "json",
  "metadata": {
    "source": "element"
  }
}

Voorbeeld

def run():
    ref = files.write("exports/preview.json", data={"title": "Preview"}, format="json")
    return {"artifact": ref["uri"]}

Scope-notities

Use this for request-scoped artifacts. Use uploadGcsFile/gcs.upload for durable tenant file storage beyond the current request.
Paths are constrained under the current tenant/request artifact prefix and cannot escape with ../ traversal.

writeFile