Space/documents

社内 Space ドキュメント内の文字列にコメントするか、スレッド内で返信

スレッドは単語にアンカーを設定します: parent: {object: "node", anchor: {kind: "find", text: "<3–6 words exactly as written>", nth?, parent_id?}}。anchor がない場合はドキュメント全体のノートになります。グラフの1つのマークまたはダイアグラムの1つのボックスの場合: anchor: {kind: "element", block_id: "<block id>", element: "datum:<x>" | "datum:<x>|<series>" | "node:<id>"}(存在しない場合は element_none)。返信ではスレッドを指定します: parent: {object: "utterance", id: "<thread id>"}。to: ["agent"] でエージェントに送信します。制限事項: ドキュメントあたり1,000スレッド(解決済みを含む)、スレッドあたり100コメント、4,096バイトの本文(too_many、row_too_large。何も書き込まれません)。

POST
/v1/space/documents/{document_id}/comments
curl -X POST "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/comments" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "body": "string",  "parent": {    "object": "node"  },  "to": []}'
{  "data": {    "actor": {      "id": "<string>",      "name": "<string>",      "type": "<string>"    },    "answered": true,    "body": "<string>",    "created_at": "2026-01-01T00:00:00Z",    "document_id": "<string>",    "edits": [      0    ],    "id": "<string>",    "kind": "comment",    "parent": {      "anchor": {        "block_id": "<string>",        "detached": true,        "element": null,        "end": "<string>",        "start": "<string>",        "text": "<string>"      },      "id": "<string>",      "object": "node"    },    "resolved": true,    "seq": 0,    "to": [      "agent"    ],    "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必須

追加プロパティ
許可しない
bodystringbody必須
文字数
≥ 1, ≤ 100000
parentobject | objectbodyデフォルト:{"object":"node"}

以下のちょうど1つに一致

形式 1: object

追加プロパティ
許可しない
parent.anchorobject | object | objectbody

以下のちょうど1つに一致

形式 1: object

追加プロパティ
許可しない
parent.anchor.kindstringenum<string>body必須
許可される値
find
parent.anchor.nthintegerbody
値の範囲
≥ 1
parent.anchor.parent_idstringbody
パターン
^\d+\.\d+$
parent.anchor.textstringbody必須
文字数
≥ 1, ≤ 2000

形式 2: object

追加プロパティ
許可しない
parent.anchor.endstringbody必須
文字数
≥ 1, ≤ 512
parent.anchor.kindstringenum<string>body必須
許可される値
range
parent.anchor.startstringbody必須
文字数
≥ 1, ≤ 512
parent.anchor.textstringbody必須
文字数
≥ 1, ≤ 2000

形式 3: object

追加プロパティ
許可しない
parent.anchor.block_idstringbody必須
パターン
^\d+\.\d+$
parent.anchor.elementstringbody必須
文字数
≥ 1, ≤ 512
parent.anchor.kindstringenum<string>body必須
許可される値
element
parent.idstringbody
parent.objectstringenum<string>body必須
許可される値
node

形式 2: object

追加プロパティ
許可しない
parent.idstringbody必須
パターン
^dcm_[a-f0-9]{24}$
parent.objectstringenum<string>body必須
許可される値
utterance
tostring[]bodyデフォルト:[]
要素数
≤ 1
to[]stringenum<string>body
許可される値
agent

レスポンス

application/json

作成されたコメントです

dataSpaceDocumentComment必須
data.actorobject必須
data.actor.idstring | null必須
data.actor.namestring | null必須
data.actor.typestring必須
data.answeredboolean必須
data.bodystring必須
data.created_atstring必須形式:date-time
data.document_idstring必須
data.editsinteger[]必須
data.edits[]integer
data.idstring必須
data.kindstringenum<string>必須
許可される値
commentresolvereopen
data.parentobject | object必須

以下のちょうど1つに一致

形式 1: object

data.parent.anchorobject | null必須
data.parent.anchor.block_idstring | null必須
data.parent.anchor.detachedboolean必須
data.parent.anchor.elementstring | nullデフォルト:null
data.parent.anchor.endstring | null必須
data.parent.anchor.startstring | null必須
data.parent.anchor.textstring必須
data.parent.idstring必須
data.parent.objectstringenum<string>必須
許可される値
node

形式 2: object

data.parent.idstring必須
data.parent.objectstringenum<string>必須
許可される値
utterance
data.resolvedboolean必須
data.seqinteger必須
data.tostring[]必須
data.to[]stringenum<string>
許可される値
agent
data.updated_atstring必須形式:date-time
data.workspace_idstring必須