Skip to main content
POST
Workspace: File Edit
Edit a file in the per-agent workspace by replacing an exact text occurrence. old_text must match the existing file content exactly, including whitespace and indentation.

Path Parameters

string
required
Agent ID (UUID)

Request Body

string
required
Path to the file to edit, relative to the workspace root.
string
required
Exact text to find and replace. Must match existing file content, including whitespace.
string
required
Replacement text. Use an empty string to delete the matched content.

Response

string
Result status (e.g., ok).
string
Path of the file that was edited.

Example Request

Notes

  • The match is exact and case-sensitive. If old_text appears more than once in the file, the request fails — include additional surrounding context in old_text to make the match unique.
  • To apply several edits atomically, use Multi Edit instead.

See Also

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

agent_id
string
required

Body

application/json
path
string
required

Relative path to the file to edit.

Example:

"app.py"

old_text
string
required

The exact text to find and replace. Must match the file content exactly (whitespace-sensitive).

Example:

"DEBUG = True"

new_text
string
required

The replacement text that will substitute old_text.

Example:

"DEBUG = False"

Response

Successful Response

path
string
required

The path of the edited file

replacements_made
integer
default:0

Number of replacements made

Example:

1