Export Run files

Create one private archive File from Files associated with a Run. Use this to keep the artifacts from one execution together after the Run finishes.

Export Run files

1
const result = await bctrl.tools.call("run.files.export", {
2
  runId: run.id,
3
  fileIds: ["file_01JQXYZ8ABCD1234EFGH5678JK"],
4
  name: "checkout-artifacts.zip",
5
});
6
7
console.log(result.fileId, result.name, result.size);

fileIds is optional and accepts up to 500 File IDs. When omitted, the Tool exports all eligible Files associated with the Run.

Request parameters

Response

Run asynchronously

1
const call = await bctrl.tools.start("run.files.export", {
2
  runId: run.id,
3
  fileIds: ["file_01JQXYZ8ABCD1234EFGH5678JK"],
4
});
5
6
const result = await bctrl.toolCalls.result(call.id, {
7
  waitSeconds: 60,
8
});

Use bctrl.toolCalls.get(call.id) to inspect progress or bctrl.toolCalls.cancel(call.id) to cancel an active export.

Next

• Runs — inspect the execution and its Files
• Files — manage the resulting archive
• Tools — understand ToolCalls