Version: Current
Historical release snapshot. These docs are frozen. Read current docs.
GET and PUT /api/ide/file
Part of the API reference; this page is generated from the OpenAPI document that the gateway builds from its own route tables.
Provenance
Section titled “Provenance”- Contract version:
1.10.0 - Contract title: acumen gateway API
- Source:
acumen:docs/openapi/acumen-v1.openapi.json
Operations
Section titled “Operations”GET /api/ide/file
Section titled “GET /api/ide/file”Read a workspace file
Reads one UTF-8 text file under the workspace root with its content and a content hash. Operator (admin) scope.
- Operation id:
getApiIdeFile - Scope:
admin - Exposure:
operator - Mutating: no
- Auth:
bearerAuth,operatorSession
Responses
200: file content envelopeapplication/json:IDEEnvelope: IDEEnvelope (object)
404: file_not_foundapplication/problem+json:Problem: Problem (object)
PUT /api/ide/file
Section titled “PUT /api/ide/file”Save a workspace file
Writes one file under the workspace root. Size-capped; the optional base hash turns it into an optimistic-concurrency save. Operator (admin) scope.
- Operation id:
putApiIdeFile - Scope:
admin - Exposure:
operator - Mutating: no
- Auth:
bearerAuth,operatorSession
Request
- Request body (application/json, required):
IDEFileSaveRequest: IDEFileSaveRequest (object)
| Field | Type | Required | Notes |
|---|---|---|---|
baseSha256 |
string | no | |
content |
string | yes | |
path |
string | yes |
Responses
200: savedapplication/json:IDEEnvelope: IDEEnvelope (object)
409: conflict — the file changed since the base hashapplication/problem+json:Problem: Problem (object)
413: file_too_largeapplication/problem+json:Problem: Problem (object)