Legacy alias: rename a document (use PATCH .../documents/{documentId})

curl --request POST \ --url https://origami.chat/api/v2/workspaces/{workspaceId}/documents/{documentId}/rename \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>" } '

{ "object": "<string>", "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "filename": "<string>", "vfsPath": "<string>", "kind": "<string>", "status": "<string>", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Transport-level replay protection — any v2 POST may send it (1–255 printable ASCII characters; UUIDs recommended). The first response for a key is recorded and replayed verbatim for retries with the same key + method/path/body for 24 hours; replayed responses carry the Idempotency-Replay: true response header. Reusing a key with a different request — or retrying while the original is still in flight — returns 409 IDEMPOTENCY_ERROR. 5xx responses are never recorded (the retry re-executes).

Required string length: 1 - 255

Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

workspaceId

string<uuid>

required

documentId

string<uuid>

required

Body

application/json

name

string

required

Required string length: 1 - 200

Response

The renamed document summary.

object

string

required

Allowed value: "document"

string<uuid>

required

documentId

string<uuid>

required

Legacy alias of id — kept for pre-restructure consumers.

filename

string

required

Last segment of the VFS path — the user-facing filename.

vfsPath

string

required

kind

string

required

status

string

required

createdAt

string<date-time>

required

updatedAt

string<date-time>

required