メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.snorbe.deskrex.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
エージェント CRUD

API キーに紐づくワークスペース内で Agent を作成・取得・更新・削除します。
workspaceId や userId はリクエストで渡しません。API キーのスコープが自動的に適用されます。

​
共通ヘッダー

ヘッダー必須説明
AuthorizationはいBearer snorbe_... 形式の API キー
Content-TypePOST / PATCH のみapplication/json

​
GET /api/v1/agent/

Agent の詳細を 1 件取得します。

​
レスポンス

{
  "id": "clxxx123456",
  "name": "Research Agent",
  "identityMarkdown": "# Identity\nB2B SaaS の市場調査が得意です。",
  "userMarkdown": "ユーザーは新規事業責任者。",
  "soulMarkdown": "仮説を明示し、根拠を分けて話す。",
  "memoryMarkdown": "- 競合調査の粒度を高める依頼が多い",
  "isDefault": true,
  "createdAt": "2026-04-19T00:00:00.000Z",
  "updatedAt": "2026-04-19T02:30:00.000Z"
}

​
POST /api/v1/agent

Agent を新規作成します。

​
リクエストボディ

{
  "name": "Patent Analyst",
  "identityMarkdown": "# Identity\n特許調査を担当します",
  "userMarkdown": "",
  "soulMarkdown": "",
  "memoryMarkdown": "",
  "isDefault": false
}

​
フィールド

フィールド型必須説明
namestringはいAgent 名。最大 100 文字
identityMarkdownstringいいえ自己紹介。最大 300 文字
userMarkdownstringいいえユーザー理解。最大 600 文字
soulMarkdownstringいいえPersona / SOUL。最大 800 文字
memoryMarkdownstringいいえ長期記憶。最大 2000 文字
isDefaultbooleanいいえtrue の場合、その Agent を default に設定

​
default の挙動

  • 1 体目の Agent は自動で isDefault: true になります
  • isDefault: true で作成すると、同じワークスペース内の既存 default は解除されます

​
PATCH /api/v1/agent/

Agent を部分更新します。送ったフィールドのみ更新されます。

​
リクエストボディ

{
  "identityMarkdown": "# Identity\n知財・論文の横断調査を担当します",
  "isDefault": true
}

​
注意

  • isDefault: true を送ると、その Agent が default になります
  • 現在の default Agent に isDefault: false を直接送ることはできません。別 Agent を default にしてください

​
DELETE /api/v1/agent/

Agent を削除します。関連する AgentRun は cascade で削除されます。

​
default 削除時の挙動

  • 他の Agent が残っていれば、最新更新の Agent が新しい default に昇格します
  • 残りが 0 件なら default Agent は不在になります

​
レスポンスフィールド

POST / GET / PATCH / DELETE はすべて同じ Agent オブジェクトを返します。
フィールド型説明
idstringAgent ID
namestringAgent 名
identityMarkdownstring自己紹介
userMarkdownstringユーザー理解
soulMarkdownstringPersona / SOUL
memoryMarkdownstring長期記憶
isDefaultbooleandefault Agent かどうか
createdAtstring作成日時（ISO 8601）
updatedAtstring更新日時（ISO 8601）

​
使用例

curl "https://app.snorbe.deskrex.ai/api/v1/agent/clxxx123456" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

curl -X POST "https://app.snorbe.deskrex.ai/api/v1/agent" \
  -H "Authorization: Bearer snorbe_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Patent Analyst",
    "identityMarkdown": "# Identity\n特許調査を担当します"
  }'

curl -X PATCH "https://app.snorbe.deskrex.ai/api/v1/agent/clxxx123456" \
  -H "Authorization: Bearer snorbe_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "isDefault": true
  }'

curl -X DELETE "https://app.snorbe.deskrex.ai/api/v1/agent/clxxx123456" \
  -H "Authorization: Bearer snorbe_your_api_key_here"

​
エラーレスポンス

HTTP ステータスコード説明
400BAD_REQUESTdefault の解除方法が不正、または入力値が不正
401UNAUTHORIZEDAPI キーが無効、期限切れ、または未指定
404NOT_FOUND指定した Agent が API キーのスコープ内に存在しない
429TOO_MANY_REQUESTSレート制限超過