Create a computer file download

Creates a download by asking the computer daemon to push the requested workspace file to object storage, then returns a browser download URL.

POST /api/v0/computers/{computerId}/files/{fileName}/create-download

Create a computer file download

cURL

curl --request POST \
  --url https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "<string>",
  "contentType": "<string>"
}
'

import requests

url = "https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download"

payload = {
    "sessionId": "<string>",
    "contentType": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sessionId: '<string>', contentType: '<string>'})
};

fetch('https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sessionId' => '<string>',
    'contentType' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download"

	payload := strings.NewReader("{\n  \"sessionId\": \"<string>\",\n  \"contentType\": \"<string>\"\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sessionId\": \"<string>\",\n  \"contentType\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.factory.ai/api/v0/computers/{computerId}/files/{fileName}/create-download")

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  \"sessionId\": \"<string>\",\n  \"contentType\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "transferId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expiresAt": 123,
  "downloadUrl": "<string>",
  "byteLength": 1
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

承認

Authorization · string · header · 必須

Factory API key or JWT token for authentication

パスパラメータ

computerId · string · 必須

Computer ID

fileName · string · 必須

Workspace file name

Required string length: 1 - 255

Pattern: ^(?=.*\S)(?!.*[\\/])(?!.*\.\.)(?!.*[\x00-\x1F\x7F]).+$

ボディ

application/json

sessionId · string · 必須

Minimum string length: 1

contentType · string

Required string length: 1 - 255

Pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+(?: *; *[!#$%&'*+.^_`|~0-9A-Za-z-]+=(?:[!#$%&'*+.^_`|~0-9A-Za-z-]+|"[\x20-\x7E]*"))*$

レスポンス

200

application/json

Response for status 200

transferId · string<uuid> · 必須

expiresAt · number · 必須

downloadUrl · string · 必須

Minimum string length: 1

byteLength · integer · 必須

必須範囲: x >= 0