Space/documents

​
タブの名前を変更するか、別の位置に移動します（ドキュメント自体は先頭のまま残ります）

PATCH
/v1/space/documents/{document_id}/tabs/{tab_id}
curl -X PATCH "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/tabs/%3Ctab_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "name": "string",  "position": 1}'
{  "data": {    "document_id": "<string>",    "id": "<string>",    "name": "<string>",    "position": 0,    "updated_at": "2026-01-01T00:00:00Z"  }}

Orchestor API キーを取得

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

認証

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

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

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

パスパラメータ

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

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
namestringbody
文字数
≥ 1, ≤ 255
positionintegerbody
値の範囲
≥ 0, ≤ 1000

レスポンス

application/json

更新されたタブです。

dataSpaceDocumentTab必須
data.document_idstring必須
data.idstring必須
data.namestring必須
data.positioninteger必須
data.updated_atstring必須形式:date-time