Skip to main content
PUT
/
files
/
edit
/
{path}
Edit file with string replacement
curl --request PUT \
  --url https://api.openfiles.ai/functions/v1/api/files/edit/{path} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "oldString": "<string>",
  "newString": "<string>"
}'
{
  "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"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from the console.

Path Parameters

​
path
string
required

File path (S3-style, no leading slash)

Body

application/json
​
oldString
string
required
Required string length: 1 - 100000
​
newString
string
required
Maximum length: 100000

Response

Success

​
success
boolean
required
Example:

true

​
data
object
required
​
operation
string
required
Example:

"write_file"

​
message
string
required
Example:

"File created successfully, version 1"

⌘I