Skip to main content
POST
Move a note to a new path

Authorizations

Authorization
string
header
required

Static bearer, WorkOS JWT, or open local when AUTH_REQUIRED is off and no static tokens are set. The token selects the vault; paths do not include vault_id.

Path Parameters

note
string
required
Minimum string length: 1

Body

application/json
new_path
string
required
Required string length: 1 - 500
Pattern: \.(md|markdown)$
agent_id
string
default:unknown
Required string length: 1 - 100
expect_version_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

pending_id
string
required
slug
string
required
status
enum<string>
required
Available options:
applied,
queued
committed_seq
integer
Required range: -9007199254740991 <= x <= 9007199254740991
content_hash
string
flow_back_error
string
Required range: -9007199254740991 <= x <= 9007199254740991
note
object
note_id
string
renamed
boolean
unchanged
boolean
version_id
string