Set Freeze on Agent Shared File

Set the frozen status of a shared file. Frozen files are preserved across executions and cannot be overwritten by the agent.

PATCH /agents/{agentId}/shared-files/{fileId}/freeze

Set Freeze on Agent Shared File

cURL

curl --request PATCH \
  --url https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/shared-files/{fileId}/freeze \
  --header 'Content-Type: application/json' \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>' \
  --data '
{
  "isFrozen": true
}
'

import requests

url = "https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/shared-files/{fileId}/freeze"

payload = { "isFrozen": True }
headers = {
    "X-Asteroid-Agents-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Asteroid-Agents-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({isFrozen: true})
};

fetch('https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/shared-files/{fileId}/freeze', 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/agents/{agentId}/shared-files/{fileId}/freeze",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'isFrozen' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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/agents/{agentId}/shared-files/{fileId}/freeze"

	payload := strings.NewReader("{\n  \"isFrozen\": true\n}")

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

	req.Header.Add("X-Asteroid-Agents-Api-Key", "<api-key>")
	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.patch("https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/shared-files/{fileId}/freeze")
  .header("X-Asteroid-Agents-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isFrozen\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/shared-files/{fileId}/freeze")

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

request = Net::HTTP::Patch.new(url)
request["X-Asteroid-Agents-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isFrozen\": true\n}"

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

200

{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "downloadUrl": "<string>",
  "fileName": "<string>",
  "filePath": "<string>",
  "fileSize": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isFrozen": true,
  "updatedAt": "2023-11-07T05:31:56Z",
  "version": 123,
  "checksum": "<string>",
  "lastModifiedByExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mimeType": "<string>"
}

"File not found."

Authorizations

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

Path Parameters

agentId · string<uuid> · required

fileId · string<uuid> · required

Body

application/json

Request to set the frozen status of a shared file

isFrozen · boolean · required

Response

200

application/json

The request has succeeded.

A file in the agent's persistent shared storage

agentId · string<uuid> · required

createdAt · string<date-time> · required

downloadUrl · string<uri> · required

fileName · string · required

filePath · string · required

fileSize · integer<int64> · required

id · string<uuid> · required

isFrozen · boolean · required

updatedAt · string<date-time> · required

version · integer · required

checksum · string

Hex-encoded SHA-256 of the file contents. Used for change and rename detection when diffing versions. Absent when the checksum is unknown.

lastModifiedByExecutionId · string<uuid>

mimeType · string