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

# Collect File

POST https://api.bctrl.ai/v1/spaces/{id}/runtimes/{runtimeId}/files/collect
Content-Type: application/json

Copy a runtime-local file back into durable space storage. Use this to preserve files produced by runtime work, optionally as an artifact.

Reference: https://platform.bctrl.ai/api/api-reference/runtime-files/collect

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/spaces/{id}/runtimes/{runtimeId}/files/collect:
    post:
      operationId: runtimes-files-collect
      summary: Collect a runtime-local file into storage
      description: >-
        Copy a runtime-local file back into durable space storage. Use this to
        preserve files produced by runtime work, optionally as an artifact.
      tags:
        - subpackage_spaces
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - 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/spaces_runtimesFilesCollect_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                artifact:
                  $ref: >-
                    #/components/schemas/V1SpacesIdRuntimesRuntimeIdFilesCollectPostRequestBodyContentApplicationJsonSchemaArtifact
                name:
                  type: string
                path:
                  type: string
                storagePath:
                  type: string
              required:
                - path
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1SpacesIdRuntimesRuntimeIdFilesCollectPostRequestBodyContentApplicationJsonSchemaArtifact:
      type: object
      properties:
        kind:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        name:
          type: string
      title: >-
        V1SpacesIdRuntimesRuntimeIdFilesCollectPostRequestBodyContentApplicationJsonSchemaArtifact
    V1SpacesIdRuntimesRuntimeIdFilesCollectPostResponsesContentApplicationJsonSchemaArtifact:
      type: object
      properties:
        createdAt:
          type: string
        fileId:
          type: string
          format: uuid
        id:
          type: string
          format: uuid
        kind:
          type: string
        name:
          type: string
        runId:
          type: string
          format: uuid
        runtimeId:
          type: string
          format: uuid
        sizeBytes:
          type: integer
      required:
        - createdAt
        - fileId
        - id
        - kind
        - name
        - runId
        - runtimeId
        - sizeBytes
      title: >-
        V1SpacesIdRuntimesRuntimeIdFilesCollectPostResponsesContentApplicationJsonSchemaArtifact
    V1SpacesIdRuntimesRuntimeIdFilesCollectPostResponsesContentApplicationJsonSchemaFile:
      type: object
      properties:
        contentType:
          type: string
        createdAt:
          type: string
        id:
          type: string
          format: uuid
        name:
          type: string
        path:
          type: string
        sizeBytes:
          type: integer
      required:
        - contentType
        - createdAt
        - id
        - name
        - path
        - sizeBytes
      title: >-
        V1SpacesIdRuntimesRuntimeIdFilesCollectPostResponsesContentApplicationJsonSchemaFile
    spaces_runtimesFilesCollect_Response_200:
      type: object
      properties:
        artifact:
          oneOf:
            - $ref: >-
                #/components/schemas/V1SpacesIdRuntimesRuntimeIdFilesCollectPostResponsesContentApplicationJsonSchemaArtifact
            - type: 'null'
        file:
          $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdFilesCollectPostResponsesContentApplicationJsonSchemaFile
      required:
        - artifact
        - file
      title: spaces_runtimesFilesCollect_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/files/collect"

payload = { "path": "/tmp/runtime/output/results.json" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/files/collect';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"path":"/tmp/runtime/output/results.json"}'
};

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/spaces/id/runtimes/runtimeId/files/collect"

	payload := strings.NewReader("{\n  \"path\": \"/tmp/runtime/output/results.json\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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/spaces/id/runtimes/runtimeId/files/collect")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"/tmp/runtime/output/results.json\"\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/v1/spaces/id/runtimes/runtimeId/files/collect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"/tmp/runtime/output/results.json\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/files/collect', [
  'body' => '{
  "path": "/tmp/runtime/output/results.json"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/files/collect");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"path\": \"/tmp/runtime/output/results.json\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["path": "/tmp/runtime/output/results.json"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/files/collect")! 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()
```