Stage a file for an execution

Stage a file prior to starting an execution, so that it can be used when the execution is started. See the /agents//execute to understand how to pass the returned file information to the execution endpoint.

POST /temp-files/{organizationId}

Stage a file for an execution

cURL

curl --request POST \
  --url https://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId} \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>' \
  --form 'files=<string>' \
  --form files.items='@example-file'

import requests

url = "https://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId}"

files = { "files.items": ("example-file", open("example-file", "rb")) }
payload = { "files": "<string>" }
headers = {"X-Asteroid-Agents-Api-Key": "<api-key>"}

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

print(response.text)

const form = new FormData();
form.append('files', '<string>');
form.append('files.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {'X-Asteroid-Agents-Api-Key': '<api-key>'}};

options.body = form;

fetch('https://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId}', 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://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-Asteroid-Agents-Api-Key: <api-key>"
  ],
]);

$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://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("X-Asteroid-Agents-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId}")
  .header("X-Asteroid-Agents-Api-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://odyssey.asteroid.ai/agents/v2/temp-files/{organizationId}")

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

request = Net::HTTP::Post.new(url)
request["X-Asteroid-Agents-Api-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

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

200

{
  "tempFiles": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ]
}

"Invalid file upload request."

"User is not a member of the organization."

"Internal server error."

Authorizations

X-Asteroid-Agents-Api-Key · string · header · required

Path Parameters

organizationId · string<uuid> · required

Body

multipart/form-data

files · file[] · required

Response

200

application/json

The request has succeeded.

tempFiles · object[] · required

Show child attributes