Space/documents

​
社内 Space ドキュメントの名前変更、ピン留め、並び替え、アーカイブ、または編集を行う

PATCH
/v1/space/documents/{document_id}
curl -X PATCH "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "archived": true,  "markdown": "string",  "pinned": true,  "sort_position": 1,  "title": "string",  "updated_at": "string"}'
{  "data": {    "archived": true,    "created_at": "2026-01-01T00:00:00Z",    "deleted_at": "2026-01-01T00:00:00Z",    "folder_id": null,    "id": "<string>",    "markdown": "<string>",    "parent_id": null,    "pinned": true,    "sort_position": 0,    "tab_name": "",    "title": "<string>",    "updated_at": "2026-01-01T00:00:00Z",    "workspace_id": "<string>"  }}

Orchestor API キーを取得

ワークスペースの設定から API キーを作成します。

認証

次のいずれかの条件を満たしてください。

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

ウェブアプリにサインインすることで確立されるブラウザセッションです。サーバーは、ワークスペースのメンバーシップと権限を確認します。ワークスペーススコープの操作には X-Workspace-ID を指定してください。サーバー間リクエストの場合、操作がサポートしていれば API キーを使用します。

パスパラメータ

document_idstringpath必須
パターン
^doc_[a-f0-9]{24}$

ヘッダー

X-Workspace-IDstringheader

アクセスするワークスペースです。ワークスペーススコープの API キーを使用する場合、サーバーはキーからこの値を導出するため、ヘッダーは任意です。指定する場合、認証情報のワークスペースと一致する必要があり、一致しない場合リクエストは 403 workspace_mismatch を返します。インタラクティブなセッションリクエストの場合、メンバーになっているワークスペースを選択するためにこのヘッダーを指定します。プロジェクト ID をワークスペース ID として使用することはできません。

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
archivedbooleanbody
markdownstringbody

Markdown 本文です。CLI: UTF-8 ファイルパス、または標準入力の場合は - です。

文字数
≤ 1000000
pinnedbooleanbody
sort_positionintegerbody
値の範囲
≥ 0, ≤ 2147483647
titlestringbody
文字数
≤ 200
updated_atstringbody必須形式:date-time

レスポンス

application/json

更新されたドキュメント

dataSpaceDocument必須
data.archivedboolean必須
data.created_atstring必須形式:date-time
data.deleted_atstring | null必須形式:date-time
data.folder_idstring | nullデフォルト:null
data.idstring必須
data.markdownstring必須
文字数
≤ 1000000
data.parent_idstring | nullデフォルト:null
data.pinnedboolean必須
data.sort_positioninteger必須
値の範囲
≥ 0, ≤ 2147483647
data.tab_namestringデフォルト:
data.titlestring必須
文字数
≤ 200
data.updated_atstring必須形式:date-time
data.workspace_idstring必須