workspace

Autosave / rename / move / archive / restore a file

Content writes require an optimistic-lock precondition: send version in the request body (recommended). The If-Match: "<version>" header is also accepted, but callers behind a CDN should prefer version — If-Match is a reserved HTTP conditional header (RFC 9110 §13.1.1) that an intermediary may evaluate at the edge and answer with 412 even when the write succeeds. The origin itself never returns 412. A stale precondition returns 409 with the current server copy. Content writes overwrite the working blob and bump the version; they do not create version-history rows. 0 credits.

patch/api/v1/files/{id}

Request

  • Base URL: https://mdtidy.com
  • URL: https://mdtidy.com/api/v1/files/{id}
  • Auth: HTTP bearer

Headers

If-Matchstring

Legacy optimistic-lock precondition (quoted version, e.g. "3"). Accepted, but prefer the version body field — a CDN may evaluate this reserved conditional header at the edge and return 412.

Request body

contentstring
namestring
folder_idstring uuid nullable
archivedboolean
versioninteger

Optimistic-lock precondition for content writes; recommended over the If-Match header (which a CDN may 412 at the edge).

Response

Updated file.

idstring uuid required
type'file' required
project_idstring uuid required
folder_idstring uuid nullable required
namestring required
archivedboolean required
versioninteger required
etagstring required

Quoted version; mirrors the ETag header.

last_opened_atstring nullable required
created_atstring required
updated_atstring required
credits_remaininginteger
contentstring

Markdown body; returned by GET /v1/files/{id}.

after_md_gcsstring nullable
rendered_html_gcsstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.