> 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.

# Upload and stage a runtime file

POST https://api.bctrl.ai/v2/runtimes/{runtimeId}/files/upload
Content-Type: multipart/form-data

Upload a local file into the runtime space and materialize it into the live runtime in one request.

Reference: https://platform.bctrl.ai/v2/api/api-reference/runtimes/v-2-runtimes-files-upload

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v2/runtimes/{runtimeId}/files/upload:
    post:
      operationId: v-2-runtimes-files-upload
      summary: Upload and stage a runtime file
      description: >-
        Upload a local file into the runtime space and materialize it into the
        live runtime in one request.
      tags:
        - subpackage_runtimes
      parameters:
        - name: runtimeId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/runtimes_v2.runtimes.files.upload_Response_200
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    File bytes to upload to the runtime space and materialize in
                    the runtime.
                metadata:
                  type: string
                  description: Optional JSON object string with caller-owned file metadata.
                name:
                  type: string
                  description: Optional display filename and staged runtime filename.
                storagePath:
                  type: string
                  description: >-
                    Optional durable storage destination path before staging
                    into the runtime. When omitted, the server generates a
                    managed path.
              required:
                - file
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFileMetadata:
      type: object
      properties: {}
      title: >-
        V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFileMetadata
    V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFileSource:
      type: string
      enum:
        - upload
        - runtime
        - system
      title: >-
        V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFileSource
    V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFile:
      type: object
      properties:
        contentType:
          type: string
        createdAt:
          type: string
        downloadUrl:
          type: string
        expiresAt:
          type:
            - string
            - 'null'
        id:
          type: string
          format: uuid
        metadata:
          oneOf:
            - $ref: >-
                #/components/schemas/V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFileMetadata
            - type: 'null'
        name:
          type: string
        path:
          type: string
        runId:
          type:
            - string
            - 'null'
          format: uuid
        runtimeId:
          type:
            - string
            - 'null'
          format: uuid
        sizeBytes:
          type: integer
        source:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFileSource
        spaceId:
          type: string
          format: uuid
        type:
          type: string
      required:
        - contentType
        - createdAt
        - id
        - name
        - path
        - sizeBytes
        - source
        - type
      title: >-
        V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFile
    V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaStaged:
      type: object
      properties:
        expiresAt:
          type:
            - string
            - 'null'
        id:
          type: string
        name:
          type: string
        runtimeId:
          type: string
          format: uuid
        runtimePath:
          type: string
        sizeBytes:
          type: integer
      required:
        - expiresAt
        - id
        - name
        - runtimeId
        - runtimePath
        - sizeBytes
      title: >-
        V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaStaged
    runtimes_v2.runtimes.files.upload_Response_200:
      type: object
      properties:
        file:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaFile
        staged:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdFilesUploadPostResponsesContentApplicationJsonSchemaStaged
      required:
        - file
        - staged
      title: runtimes_v2.runtimes.files.upload_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v2/runtimes/runtimeId/files/upload"

files = { "file": "open('SGVsbG8gV29ybGQ=', 'rb')" }
payload = {
    "metadata": ,
    "name": ,
    "storagePath": 
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v2/runtimes/runtimeId/files/upload';
const form = new FormData();
form.append('file', 'SGVsbG8gV29ybGQ=');
form.append('metadata', '');
form.append('name', '');
form.append('storagePath', '');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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/v2/runtimes/runtimeId/files/upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"SGVsbG8gV29ybGQ=\"\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=\"storagePath\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	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/v2/runtimes/runtimeId/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"SGVsbG8gV29ybGQ=\"\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=\"storagePath\"\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<String> response = Unirest.post("https://api.bctrl.ai/v2/runtimes/runtimeId/files/upload")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"SGVsbG8gV29ybGQ=\"\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=\"storagePath\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v2/runtimes/runtimeId/files/upload', [
  'multipart' => [
    [
        'name' => 'file',
        'filename' => 'SGVsbG8gV29ybGQ=',
        'contents' => null
    ]
  ]
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v2/runtimes/runtimeId/files/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"SGVsbG8gV29ybGQ=\"\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=\"storagePath\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]
let parameters = [
  [
    "name": "file",
    "fileName": "SGVsbG8gV29ybGQ="
  ],
  [
    "name": "metadata",
    "value": 
  ],
  [
    "name": "name",
    "value": 
  ],
  [
    "name": "storagePath",
    "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/v2/runtimes/runtimeId/files/upload")! 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()
```