Overwrite file content completely
curl --request PUT \
--url https://api.openfiles.ai/functions/v1/api/files/overwrite/{path} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"content": "<string>",
"isBase64": false
}
'import requests
url = "https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}"
payload = {
"content": "<string>",
"isBase64": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({content: '<string>', isBase64: false})
};
fetch('https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}', 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.openfiles.ai/functions/v1/api/files/overwrite/{path}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'isBase64' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://api.openfiles.ai/functions/v1/api/files/overwrite/{path}"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"isBase64\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-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.put("https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"isBase64\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"<string>\",\n \"isBase64\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"version": 2,
"mimeType": "<string>",
"size": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"operation": "write_file",
"message": "File created successfully, version 1"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
},
"operation": "<string>",
"details": {}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
},
"operation": "<string>",
"details": {}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
},
"operation": "<string>",
"details": {}
}Files
Overwrite File Content Completely
Replace all content in an existing file
PUT
/
files
/
overwrite
/
{path}
Overwrite file content completely
curl --request PUT \
--url https://api.openfiles.ai/functions/v1/api/files/overwrite/{path} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"content": "<string>",
"isBase64": false
}
'import requests
url = "https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}"
payload = {
"content": "<string>",
"isBase64": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({content: '<string>', isBase64: false})
};
fetch('https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}', 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.openfiles.ai/functions/v1/api/files/overwrite/{path}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'isBase64' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://api.openfiles.ai/functions/v1/api/files/overwrite/{path}"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"isBase64\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-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.put("https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"isBase64\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openfiles.ai/functions/v1/api/files/overwrite/{path}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"<string>\",\n \"isBase64\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"version": 2,
"mimeType": "<string>",
"size": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"operation": "write_file",
"message": "File created successfully, version 1"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
},
"operation": "<string>",
"details": {}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
},
"operation": "<string>",
"details": {}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
},
"operation": "<string>",
"details": {}
}Overwrite File Content Completely
Replaces the entire content of an existing file with new content. The file must exist first - this operation cannot create new files.Use Cases
- Document revisions - Replace entire documents with new versions
- Configuration updates - Update entire config files
- Template replacement - Replace template files with generated content
- Data refresh - Replace data files with updated datasets
Example Usage
const response = await fetch('https://api.openfiles.ai/functions/v1/api/files/overwrite/config/settings.json', {
method: 'PUT',
headers: {
'x-api-key': API_KEY,
'Content-Type': 'application/json'
},
body: JSON.stringify({
content: JSON.stringify({
"version": "2.0",
"theme": "dark",
"notifications": true
}, null, 2)
})
})
import requests
import json
new_config = {
"version": "2.0",
"theme": "dark",
"notifications": True
}
response = requests.put(
'https://api.openfiles.ai/functions/v1/api/files/overwrite/config/settings.json',
headers={'x-api-key': API_KEY},
json={'content': json.dumps(new_config, indent=2)}
)
curl -X PUT 'https://api.openfiles.ai/functions/v1/api/files/overwrite/config/settings.json' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"content": "{\n \"version\": \"2.0\",\n \"theme\": \"dark\",\n \"notifications\": true\n}"
}'
Authorizations
API key for authentication. Get your API key from the console.
Path Parameters
File path (S3-style, no leading slash)
Body
application/json
⌘I