Skip to content

Write a file through the actor's worktree (flushes WIP ref)

PUT
/api/workspaces/{workspaceId}/apps/{id}/file
curl --request PUT \
--url http://localhost:8080/api/workspaces/example/apps/example/file \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "path": "example", "contents": "example" }'
workspaceId
required
string
id
required
string
Media typeapplication/json
object
path
required
string
>= 1 characters
contents
required
string

Example generated

{
"path": "example",
"contents": "example"
}

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}