files

Files are session scratch until published, then durable org artifacts. Six methods. API detail: Files.

upload

client.files.upload(form: FormData): Promise<File>

POST /v1/files, multipart/form-data — the one method in the client that does not send JSON. The file part carries the bytes; other parts are metadata:

const form = new FormData();
form.append("file", new Blob([bytes], { type: "application/pdf" }), "invoice.pdf");
const file = await client.files.upload(form);

list

client.files.list(query?: FileFilter): Promise<Page<File>>

GET /v1/files. FileFilter extends the page query with:

"session" | "published"

Only scratch, or only published artifacts.

string

Only files a given session produced.

get

client.files.get(id: string): Promise<File>

GET /v1/files/{id} — the metadata object.

download

client.files.download(id: string): Promise<string>

GET /v1/files/{id}?download=true — the bytes, as text, through the API. A download is authorized by the same key as every other read; there is no unauthenticated URL unless you publish.

publish

client.files.publish(id: string): Promise<File>

POST /v1/files/{id}/publish. The promotion boundary: session scratch becomes a durable org artifact. Idempotent — publishing twice is fine.

delete

client.files.delete(id: string): Promise<Deleted>

DELETE /v1/files/{id}.

TypeScript

Control plane

Resources

Identity & access

Automation

Account

upload

list

get

download

publish

delete

​upload

​list

​get

​download

​publish

​delete

upload

list

get

download

publish

delete