Space/documents

​
任意の Markdown を含む Orchestor ドキュメントを作成

Claude Docs 生成形式としての Markdown と blocks マップ。markdown 内の各 <?claude block key?> トークンは、{"type":"pending","intent":"<what the section will say>"}（執筆中のセクション。後で editSpaceDocument を使用してそのブロック ID を置き換えることで入力します）、{"type":"paragraph"}、またはチャート/ダイアグラムブロック（{"type":"chart","spec","rows","caption"}、{"type":"diagram","spec","caption"}）のいずれか1つのエントリを指定します。エントリのないトークンは拒否されます（bad_request）。例: {"title":"Q4 review","markdown":"# Q4 review\n\n## Summary\n\n<?claude block s1?>","blocks":{"s1":{"type":"pending","intent":"Summary: three lines"}}}。

POST
/v1/space/documents
curl -X POST "https://api.orchestor.io/v1/space/documents" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "blocks": {},  "markdown": "",  "title": ""}'
{  "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 キーを使用します。

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

ボディapplication/json必須

追加プロパティ
許可しない
blocksobjectbody
blocks.*object | object | object | object | object | object | objectbody

以下のいずれかに一致

形式 1: object

blocks.*.intentstringbody必須
文字数
≤ 2000
blocks.*.typestringenum<string>body必須
許可される値
pending

形式 2: object

blocks.*.typestringenum<string>body必須
許可される値
paragraph

形式 3: object

blocks.*.captionstringbody
blocks.*.rowsobject[]body必須

チャートが描画する計測された行です（≤ 2000 行、256 KiB）。

要素数
≤ 2000
blocks.*.rows[]objectbody
blocks.*.rows[].*string | number | boolean | nullbody

以下のいずれかに一致

形式 1: string

blocks.*.rows[].*stringbody

形式 2: number

blocks.*.rows[].*numberbody

形式 3: boolean

blocks.*.rows[].*booleanbody

形式 4: null

blocks.*.rows[].*nullbody
blocks.*.specobjectbody必須
blocks.*.spec.kindstringenum<string>body必須
許可される値
linebarpie
blocks.*.spec.seriesstringbody

VALUES が系列名となる列です（系列および期間ごとに 1 行）。

blocks.*.spec.titlestringbody必須

トピックではなく、数値を含む調査結果です。

文字数
≥ 1
blocks.*.spec.unitstringbody
blocks.*.spec.xstringbody必須

軸（または円グラフのスライス）に沿った列です。

文字数
≥ 1
blocks.*.spec.ystringbody必須

測定対象の列（数値）です。

文字数
≥ 1
blocks.*.typestringenum<string>body必須
許可される値
chart

形式 4: object

blocks.*.captionstringbody
blocks.*.specobjectbody必須
blocks.*.spec.directionstringenum<string>body必須
許可される値
rightdown
blocks.*.spec.edgesobject[]body必須
要素数
≤ 120
blocks.*.spec.edges[]objectbody
blocks.*.spec.edges[].fromstringbody必須
blocks.*.spec.edges[].labelstringbody
blocks.*.spec.edges[].tostringbody必須
blocks.*.spec.nodesobject[]body必須
要素数
≥ 1, ≤ 60
blocks.*.spec.nodes[]objectbody
blocks.*.spec.nodes[].detailstringbody
blocks.*.spec.nodes[].idstringbody必須
パターン
^[\w-]{1,64}$
blocks.*.spec.nodes[].labelstringbody必須
文字数
≥ 1
blocks.*.spec.titlestringbody必須
文字数
≥ 1
blocks.*.typestringenum<string>body必須
許可される値
diagram

形式 5: object

blocks.*.typestringenum<string>body必須
許可される値
mention
blocks.*.userstringbody必須
文字数
≥ 1, ≤ 320

形式 6: object

blocks.*.refstringbody必須
パターン
^project\/doc_[a-f0-9]{24}$
blocks.*.typestringenum<string>body必須
許可される値
mention

形式 7: object

blocks.*.typestringenum<string>body必須
許可される値
date
blocks.*.valuestringbody必須
パターン
^\d{4}-\d{2}-\d{2}$
markdownstringbodyデフォルト:

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

文字数
≤ 1000000
titlestringbodyデフォルト:
文字数
≤ 200

レスポンス

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必須