> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://platform.bctrl.ai/llms.txt. > For full documentation content, see https://platform.bctrl.ai/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server. # Export Run Files POST https://api.bctrl.ai/v1/runs/{runId}/files/export Content-Type: application/json Export run files as a ZIP file. Reference: https://platform.bctrl.ai/api/api-reference/runs/export-files ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: bctrl API version: 1.0.0 paths: /v1/runs/{runId}/files/export: post: operationId: files-export summary: Export run files description: Export run files as a ZIP file. tags: - subpackage_runs parameters: - name: runId in: path required: true schema: type: string - name: Authorization in: header description: Use Bearer . required: true schema: type: string - name: Idempotency-Key in: header description: >- Optional retry key for this billable operation. Reusing the same key with the same request replays the original successful response; reusing it with a different request returns 409. required: false schema: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/File' '400': description: >- The request was invalid. See `code` and `details`. Example code: `request.invalid`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: 'Authentication required: the API key is missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: 'Forbidden: the API key cannot access this resource.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: 'The requested resource was not found. Example code: `run.not_found`.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The request conflicts with the current resource state. Example code: `storage_file.path_exists`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded. Retry after the delay indicated by Retry-After. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error occurred. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: >- An upstream dependency was unavailable. Retry later. Example code: `storage.unavailable`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RunsFilesExportRequest' servers: - url: https://api.bctrl.ai description: Production - url: http://localhost:8787 description: Local development gateway components: schemas: RunsFilesExportRequest: type: object properties: name: type: string description: >- File name for the exported archive (no path segments; must end with .zip). type: type: array items: type: string description: Restrict the export to these artifact types. title: RunsFilesExportRequest FileMetadata: type: object properties: {} title: FileMetadata FileSource: type: string enum: - upload - runtime title: FileSource File: type: object properties: contentType: type: string createdAt: type: string format: date-time downloadUrl: type: string expiresAt: type: string format: date-time id: type: string format: uuid metadata: oneOf: - $ref: '#/components/schemas/FileMetadata' - type: 'null' name: type: string path: type: string runId: type: string format: uuid runtimeId: type: string format: uuid sizeBytes: type: integer source: $ref: '#/components/schemas/FileSource' spaceId: type: string format: uuid type: type: string required: - contentType - createdAt - downloadUrl - id - name - path - sizeBytes - source - spaceId description: >- A durable BCTRL file, distinguished by `source`, `runId`, and `runtimeId`: a durable File (`source: "upload"`, no `runId`/`runtimeId`); and a produced runtime/run file (`source: "runtime"`, `runId`/`runtimeId` set when known). title: File ErrorResponseReasonClass: type: string enum: - invalid_input - unauthorized - capability_denied - capability_limit_exceeded - rate_limited - not_found - conflict - upstream - server description: Stable public error category for programmatic branching. title: ErrorResponseReasonClass ErrorResponse: type: object properties: code: type: string description: >- Stable, dot-namespaced error code, e.g. "runtime.not_found" or "request.invalid". details: type: object additionalProperties: description: Any type description: >- Resource-specific structured context. Use `code` and `reasonClass` for branching. error: type: string hint: type: string description: Optional next action for recoverable errors, e.g. "retry after 2s". reasonClass: $ref: '#/components/schemas/ErrorResponseReasonClass' description: Stable public error category for programmatic branching. requestId: type: string required: - code - error title: ErrorResponse securitySchemes: bearerAuth: type: http scheme: bearer description: Use Bearer . ``` ## Examples **Request** ```json {} ``` **Response** ```json { "contentType": "application/zip", "createdAt": "2024-01-15T09:30:00Z", "downloadUrl": "https://storage.bctrl.ai/downloads/3f5e8a2b-9c4d-4f7a-8b2e-1a2b3c4d5e6f.zip", "id": "3f5e8a2b-9c4d-4f7a-8b2e-1a2b3c4d5e6f", "name": "run_export_20240115.zip", "path": "/exports/run_export_20240115.zip", "sizeBytes": 5242880, "source": "runtime", "spaceId": "d4e5f678-90ab-cdef-1234-567890abcdef", "expiresAt": "2024-01-22T09:30:00Z", "metadata": {}, "runId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "runtimeId": "b2c3d4e5-f678-90ab-cdef-1234567890ab", "type": "archive" } ``` **SDK Code** ```python import requests url = "https://api.bctrl.ai/v1/runs/runId/files/export" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.bctrl.ai/v1/runs/runId/files/export'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.bctrl.ai/v1/runs/runId/files/export" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.bctrl.ai/v1/runs/runId/files/export") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.bctrl.ai/v1/runs/runId/files/export") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://api.bctrl.ai/v1/runs/runId/files/export', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.bctrl.ai/v1/runs/runId/files/export"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/runs/runId/files/export")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```