> 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. # Upload File POST https://api.bctrl.ai/v1/files Content-Type: multipart/form-data Upload a file into a space and return the canonical file resource. Reference: https://platform.bctrl.ai/api/api-reference/files/upload ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: bctrl API version: 1.0.0 paths: /v1/files: post: operationId: upload summary: Upload a file description: Upload a file into a space and return the canonical file resource. tags: - subpackage_files parameters: - name: spaceId in: query required: false schema: $ref: '#/components/schemas/V1FilesPostParametersSpaceId' - name: Authorization in: header description: Use Bearer . required: true 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: `storage_file.path_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: `space.not_found`. 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: multipart/form-data: schema: type: object properties: file: type: string format: binary description: File bytes to upload. metadata: type: string description: Optional JSON object string with caller-owned file metadata. name: type: string description: Optional display filename. path: type: string description: >- Optional relative destination path. Must not be absolute or contain . or .. path segments. required: - file servers: - url: https://api.bctrl.ai description: Production - url: http://localhost:8787 description: Local development gateway components: schemas: V1FilesPostParametersSpaceId: oneOf: - type: string format: uuid - type: string enum: - default title: V1FilesPostParametersSpaceId 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 { "file": "" } ``` **Response** ```json { "contentType": "image/png", "createdAt": "2024-01-15T09:30:00Z", "downloadUrl": "https://cdn.bctrl.ai/files/123e4567-e89b-12d3-a456-426614174000/download", "id": "123e4567-e89b-12d3-a456-426614174000", "name": "avatar.png", "path": "users/1234/avatars/avatar.png", "sizeBytes": 204800, "source": "upload", "spaceId": "9f8c7d6e-5b4a-3c2d-1e0f-123456789abc", "expiresAt": "2024-02-15T09:30:00Z", "metadata": {}, "runId": "00000000-0000-0000-0000-000000000000", "runtimeId": "00000000-0000-0000-0000-000000000000", "type": "image" } ``` **SDK Code** ```python import requests url = "https://api.bctrl.ai/v1/files" files = { "file": "open('iVBORw0KGgo=', 'rb')" } payload = { "metadata": , "name": , "path": } headers = {"Authorization": "Bearer "} response = requests.post(url, data=payload, files=files, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.bctrl.ai/v1/files'; const form = new FormData(); form.append('file', 'iVBORw0KGgo='); form.append('metadata', ''); form.append('name', ''); form.append('path', ''); const options = {method: 'POST', headers: {Authorization: 'Bearer '}}; options.body = form; 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/files" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"iVBORw0KGgo=\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"path\"\r\n\r\n\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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/files") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"iVBORw0KGgo=\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"path\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" 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/files") .header("Authorization", "Bearer ") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"iVBORw0KGgo=\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"path\"\r\n\r\n\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://api.bctrl.ai/v1/files', [ 'multipart' => [ [ 'name' => 'file', 'filename' => 'iVBORw0KGgo=', 'contents' => null ] ] 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.bctrl.ai/v1/files"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"iVBORw0KGgo=\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"path\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let parameters = [ [ "name": "file", "fileName": "iVBORw0KGgo=" ], [ "name": "metadata", "value": ], [ "name": "name", "value": ], [ "name": "path", "value": ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/files")! 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() ```